Developer Documentation
ADC NITRO APIs
Current Release 13.1 13

sslcrl

August 17, 2023
Contributed by: 
C

Configuration for Certificate Revocation List resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
crlname <String> Read-write Name for the Certificate Revocation List (CRL). Must begin with an ASCII alphanumeric or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters. Cannot be changed after the CRL is created.



The following requirement applies only to the Citrix ADC CLI:

If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, "my crl" or 'my crl').

Minimum length = 1
crlpath <String> Read-write Path to the CRL file. /var/netscaler/ssl/ is the default path.

Minimum length = 1
inform <String> Read-write Input format of the CRL file. The two formats supported on the appliance are:

PEM - Privacy Enhanced Mail.

DER - Distinguished Encoding Rule.

Default value: PEM

Possible values = DER, PEM
refresh <String> Read-write Set CRL auto refresh.

Possible values = ENABLED, DISABLED
cacert <String> Read-write CA certificate that has issued the CRL. Required if CRL Auto Refresh is selected. Install the CA certificate on the appliance before adding the CRL.

Minimum length = 1
method <String> Read-write Method for CRL refresh. If LDAP is selected, specify the method, CA certificate, base DN, port, and LDAP server name. If HTTP is selected, specify the CA certificate, method, URL, and port. Cannot be changed after a CRL is added.

Possible values = HTTP, LDAP
server <String> Read-write IP address of the LDAP server from which to fetch the CRLs.

Minimum length = 1
url <String> Read-write URL of the CRL distribution point.
port <Integer> Read-write Port for the LDAP server.

Minimum value = 1
basedn <String> Read-write Base distinguished name (DN), which is used in an LDAP search to search for a CRL. Citrix recommends searching for the Base DN instead of the Issuer Name from the CA certificate, because the Issuer Name field might not exactly match the LDAP directory structure's DN.

Minimum length = 1
scope <String> Read-write Extent of the search operation on the LDAP server. Available settings function as follows:

One - One level below Base DN.

Base - Exactly the same level as Base DN.

Default value: One

Possible values = Base, One
interval <String> Read-write CRL refresh interval. Use the NONE setting to unset this parameter.

Possible values = MONTHLY, WEEKLY, DAILY, NOW, NONE
day <Double> Read-write Day on which to refresh the CRL, or, if the Interval parameter is not set, the number of days after which to refresh the CRL. If Interval is set to MONTHLY, specify the date. If Interval is set to WEEKLY, specify the day of the week (for example, Sun=0 and Sat=6). This parameter is not applicable if the Interval is set to DAILY.

Minimum value = 0

Maximum value = 31
time <String> Read-write Time, in hours (1-24) and minutes (1-60), at which to refresh the CRL.
binddn <String> Read-write Bind distinguished name (DN) to be used to access the CRL object in the LDAP repository if access to the LDAP repository is restricted or anonymous access is not allowed.

Minimum length = 1
password <String> Read-write Password to access the CRL in the LDAP repository if access to the LDAP repository is restricted or anonymous access is not allowed.

Minimum length = 1
binary <String> Read-write Set the LDAP-based CRL retrieval mode to binary.

Default value: NO

Possible values = YES, NO
cacertfile <String> Read-write Name of and, optionally, path to the CA certificate file.

/nsconfig/ssl/ is the default path.

Maximum length = 63
cakeyfile <String> Read-write Name of and, optionally, path to the CA key file. /nsconfig/ssl/ is the default path.

Maximum length = 63
indexfile <String> Read-write Name of and, optionally, path to the file containing the serial numbers of all the certificates that are revoked. Revoked certificates are appended to the file. /nsconfig/ssl/ is the default path.

Maximum length = 63
revoke <String> Read-write Name of and, optionally, path to the certificate to be revoked. /nsconfig/ssl/ is the default path.

Maximum length = 63
gencrl <String> Read-write Name of and, optionally, path to the CRL file to be generated. The list of certificates that have been revoked is obtained from the index file. /nsconfig/ssl/ is the default path.

Maximum length = 63
flags <Integer> Read-only CRL status flag.
lastupdatetime <Integer> Read-only Last CRL refresh time.
version <Integer> Read-only CRL version.
signaturealgo <String> Read-only Signature algorithm.
issuer <String> Read-only Issuer name.
lastupdate <String> Read-only Last update time.
nextupdate <String> Read-only Next update time.
daystoexpiration <Integer> Read-only Number of days remaining for the CRL to expire.
__count <Double> Read-only count parameter

Operations

(click to see Properties )

  • ADD
  • CREATE
  • DELETE
  • UPDATE
  • UNSET
  • GET (ALL)
  • GET
  • COUNT

Some options that you can use for each operations:

  • Getting warnings in response: NITRO allows you to get warnings in an operation by specifying the 'warning' query parameter as 'yes'. For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:

    http:// <netscaler-ip-address> /nitro/v1/config/login?warning=yes

    If any, the warnings are displayed in the response payload with the HTTP code '209 X-NITRO-WARNING'.

  • Authenticated access for individual NITRO operations: NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,

    To do this, you must specify the username and password in the request header of the NITRO request as follows:

    X-NITRO-USER: <username>

    X-NITRO-PASS: <password>

    Note: In such cases, make sure that the request header DOES not include the following:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

*Note: *

Mandatory parameters are marked in red and placeholder content is marked in green

add

URL: http:// <netscaler-ip-address> /nitro/v1/config/sslcrl

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 


{"sslcrl":{
<b>      "crlname":<String_value>,
</b><b>      "crlpath":<String_value>,
</b>      "inform":<String_value>,
      "refresh":<String_value>,
      "cacert":<String_value>,
      "method":<String_value>,
      "server":<String_value>,
      "url":<String_value>,
      "port":<Integer_value>,
      "basedn":<String_value>,
      "scope":<String_value>,
      "interval":<String_value>,
      "day":<Double_value>,
      "time":<String_value>,
      "binddn":<String_value>,
      "password":<String_value>,
      "binary":<String_value>
}}

<!--NeedCopy-->

Response:

HTTP Status Code on Success: 201 Created

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

create

URL: http:// <netscaler-ip-address> /nitro/v1/config/sslcrl? action=create

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 


{"sslcrl":{
<b>      "cacertfile":<String_value>,
</b><b>      "cakeyfile":<String_value>,
</b><b>      "indexfile":<String_value>,
</b>      "revoke":<String_value>,
      "gencrl":<String_value>,
      "password":<String_value>
}}

<!--NeedCopy-->

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

delete

URL: http:// <netscaler-ip-address> /nitro/v1/config/sslcrl/ crlname_value<String>

HTTP Method: DELETE

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

update

URL: http:// <netscaler-ip-address> /nitro/v1/config/sslcrl

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 


{"sslcrl":{
<b>      "crlname":<String_value>,
</b>      "refresh":<String_value>,
      "cacert":<String_value>,
      "server":<String_value>,
      "method":<String_value>,
      "url":<String_value>,
      "port":<Integer_value>,
      "basedn":<String_value>,
      "scope":<String_value>,
      "interval":<String_value>,
      "day":<Double_value>,
      "time":<String_value>,
      "binddn":<String_value>,
      "password":<String_value>,
      "binary":<String_value>
}}

<!--NeedCopy-->

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

unset

URL: http:// <netscaler-ip-address> /nitro/v1/config/sslcrl? action=unset

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 


{"sslcrl":{
<b>      "crlname":<String_value>,
</b>      "refresh":true,
      "cacert":true,
      "server":true,
      "method":true,
      "url":true,
      "port":true,
      "basedn":true,
      "scope":true,
      "interval":true,
      "day":true,
      "time":true,
      "binddn":true,
      "password":true,
      "binary":true
}}

<!--NeedCopy-->

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

get (all)

URL: http:// <netscaler-ip-address> /nitro/v1/config/sslcrl

Query-parameters:

attrs

http:// <netscaler-ip-address> /nitro/v1/config/sslcrl? attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

filter

http:// <netscaler-ip-address> /nitro/v1/config/sslcrl? filter=property-name1:property-val1,property-name2:property-val2

Use this query-parameter to get the filtered set of sslcrl resources configured on NetScaler.Filtering can be done on any of the properties of the resource.

view

http:// <netscaler-ip-address> /nitro/v1/config/sslcrl? view=summary

Use this query-parameter to get the summary output of sslcrl resources configured on NetScaler.

Note: By default, the retrieved results are displayed in detail view (?view=detail).

pagination

http:// <netscaler-ip-address> /nitro/v1/config/sslcrl? pagesize=#no;pageno=#no

Use this query-parameter to get the sslcrl resources in chunks.

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload: 


{ "sslcrl": [ {
      "crlname":<String_value>,
      "crlpath":<String_value>,
      "inform":<String_value>,
      "cacert":<String_value>,
      "refresh":<String_value>,
      "scope":<String_value>,
      "server":<String_value>,
      "port":<Integer_value>,
      "url":<String_value>,
      "method":<String_value>,
      "basedn":<String_value>,
      "interval":<String_value>,
      "day":<Double_value>,
      "time":<String_value>,
      "binddn":<String_value>,
      "password":<String_value>,
      "flags":<Integer_value>,
      "lastupdatetime":<Integer_value>,
      "version":<Integer_value>,
      "signaturealgo":<String_value>,
      "issuer":<String_value>,
      "lastupdate":<String_value>,
      "nextupdate":<String_value>,
      "binary":<String_value>,
      "daystoexpiration":<Integer_value>
}]}

<!--NeedCopy-->

get

URL: http:// <netscaler-ip-address> /nitro/v1/config/sslcrl/ crlname_value<String>

Query-parameters:

attrs

http:// <netscaler-ip-address> /nitro/v1/config/sslcrl/ crlname_value<String> ? attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

view

http:// <netscaler-ip-address> /nitro/v1/config/sslcrl/ crlname_value<String> ? view=summary

Use this query-parameter to get the summary output of sslcrl resources configured on NetScaler.

Note: By default, the retrieved results are displayed in detail view (?view=detail).

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload: 


{  "sslcrl": [ {
      "crlname":<String_value>,
      "crlpath":<String_value>,
      "inform":<String_value>,
      "cacert":<String_value>,
      "refresh":<String_value>,
      "scope":<String_value>,
      "server":<String_value>,
      "port":<Integer_value>,
      "url":<String_value>,
      "method":<String_value>,
      "basedn":<String_value>,
      "interval":<String_value>,
      "day":<Double_value>,
      "time":<String_value>,
      "binddn":<String_value>,
      "password":<String_value>,
      "flags":<Integer_value>,
      "lastupdatetime":<Integer_value>,
      "version":<Integer_value>,
      "signaturealgo":<String_value>,
      "issuer":<String_value>,
      "lastupdate":<String_value>,
      "nextupdate":<String_value>,
      "binary":<String_value>,
      "daystoexpiration":<Integer_value>
}]}

<!--NeedCopy-->

count

URL: http:// <netscaler-ip-address> /nitro/v1/config/sslcrl? count=yes

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload: 


{ "sslcrl": [ { "__count": "#no"} ] }

<!--NeedCopy-->
sslcrl
August 17, 2023
Contributed by: 
C
August 17, 2023
Contributed by: 
C

In this article

Site feedback | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.