Developer Documentation
ADC NITRO APIs
Current Release 13.1 13

sslcacertgroup_sslcertkey_binding

August 17, 2023
Contributed by: 
C

Binding object showing the sslcertkey that can be bound to sslcacertgroup.

Properties

(click to see Operations )

Name Data Type Permissions Description
cacertgroupname Read-write Name given to the CA certificate group. The name will be used to add the CA certificates to the group. 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. 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 file” or ‘my file’).

Minimum length = 1

Maximum length = 31
certkeyname Read-write Name for the certkey added to the Citrix ADC. 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 certificate-key pair 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 cert” or ‘my cert’).

Minimum length = 1

Maximum length = 31
crlcheck Read-write The state of the CRL check parameter. (Mandatory/Optional).

Possible values = Mandatory, Optional
ocspcheck Read-write The state of the OCSP check parameter. (Mandatory/Optional).

Possible values = Mandatory, Optional
__count Read-write count parameter

Operations

(click to see Properties )

  • ADD
  • DELETE
  • GET
  • GET (ALL)
  • 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/sslcacertgroup_sslcertkey_binding

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 


{
"sslcacertgroup_sslcertkey_binding":{
<b>      "cacertgroupname":<String_value>,
</b><b>      "certkeyname":<String_value>,
</b>      "crlcheck":<String_value>,
      "ocspcheck":<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

delete

URL: http:// <netscaler-ip-address> /nitro/v1/config/sslcacertgroup_sslcertkey_binding/ cacertgroupname_value<String>

Query-parameters:

args

http:// <netscaler-ip-address> /nitro/v1/config/sslcacertgroup_sslcertkey_binding/ cacertgroupname_value<String> ? args= certkeyname:<String_value>

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

get

URL: http:// <netscaler-ip-address> /nitro/v1/config/sslcacertgroup_sslcertkey_binding/ cacertgroupname_value<String>

Query-parameters:

filter

http:// <netscaler-ip-address> /nitro/v1/config/sslcacertgroup_sslcertkey_binding/ cacertgroupname_value<String> ? filter=property-name1:property-value1,property-name2:property-value2

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

pagination

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

Use this query-parameter to get the sslcacertgroup_sslcertkey_binding 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: 


{  "sslcacertgroup_sslcertkey_binding": [ {
      "cacertgroupname":<String_value>,
      "certkeyname":<String_value>,
      "crlcheck":<String_value>,
      "ocspcheck":<String_value>
}]}

<!--NeedCopy-->

get (all)

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

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Query-parameters:

bulkbindings

http:// <netscaler-ip-address> /nitro/v1/config/sslcacertgroup_sslcertkey_binding? bulkbindings=yes

NITRO allows you to fetch bindings in bulk.

Note: get (all) method can be used only in conjuction with bulkbindings query parameter.

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: 


{  "sslcacertgroup_sslcertkey_binding": [ {
      "cacertgroupname":<String_value>,
      "certkeyname":<String_value>,
      "crlcheck":<String_value>,
      "ocspcheck":<String_value>
}]}

<!--NeedCopy-->

count

URL: http:// <netscaler-ip-address> /nitro/v1/config/sslcacertgroup_sslcertkey_binding/ cacertgroupname_value<String> ? 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: 


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

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

In this article

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