Developer Documentation
ADC NITRO APIs
Current Release 13.1 13

sslcertkey_sslvserver_binding

August 17, 2023
Contributed by: 
C

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

Properties

(click to see Operations )

Name Data Type Permissions Description
vserver Read-write Specify this option to bind the certificate to an SSL virtual server. Note: The default option is -vServer.
ca Read-write The certificate-key pair being unbound is a Certificate Authority (CA) certificate. If you choose this option, the certificate-key pair is unbound from the list of CA certificates that were bound to the specified SSL virtual server or SSL service.
vservername Read-write The name of the SSL virtual server name to which the certificate-key pair needs to be bound.

Minimum length = 1
servername Read-write Vserver name to which the certificate key pair is bound.
certkey Read-write Name of the certificate-key pair.

Minimum length = 1
version Read-only Version.
data Read-only Vserver Id.
__count Read-only count parameter

Operations

(click to see Properties )

  • 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

get

URL: http:// <netscaler-ip-address> /nitro/v1/config/sslcertkey_sslvserver_binding/ certkey_value<String>

Query-parameters:

filter

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

Use this query-parameter to get the filtered set of sslcertkey_sslvserver_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/sslcertkey_sslvserver_binding/ certkey_value<String> ? pagesize=#no;pageno=#no

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


{  "sslcertkey_sslvserver_binding": [ {
      "vserver":<Boolean_value>,
      "ca":<Boolean_value>,
      "vservername":<String_value>,
      "servername":<String_value>,
      "certkey":<String_value>,
      "version":<Integer_value>,
      "data":<Double_value>
}]}

<!--NeedCopy-->

get (all)

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

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Query-parameters:

bulkbindings

http:// <netscaler-ip-address> /nitro/v1/config/sslcertkey_sslvserver_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: 


{  "sslcertkey_sslvserver_binding": [ {
      "vserver":<Boolean_value>,
      "ca":<Boolean_value>,
      "vservername":<String_value>,
      "servername":<String_value>,
      "certkey":<String_value>,
      "version":<Integer_value>,
      "data":<Double_value>
}]}

<!--NeedCopy-->

count

URL: http:// <netscaler-ip-address> /nitro/v1/config/sslcertkey_sslvserver_binding/ certkey_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: 


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

<!--NeedCopy-->
sslcertkey_sslvserver_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.