Developer Documentation
Citrix ADC 12.1 NITRO API Reference
Current Release 13.1 13

sslcertkey_service_binding

August 17, 2023
Contributed by: 
C

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

Properties

(click to see Operations)

Name Data Type Permissions Description
servicegroupname Read-write The name of the SSL service group to which the certificate-key pair needs to be bound. Use the “add servicegroup” command to create this service.
Minimum length = 1
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.
service Read-write Bind the certificate to the named SSL service or service group.
servicename Read-write Service 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 Citrix ADC appliance, the URL is as follows:

    http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC 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 redand placeholder content is marked in <green>.

get

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/sslcertkey_service_binding/certkey_value<String>

Query-parameters:

filter

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/sslcertkey_service_binding/certkey_value<String>?filter=property-name1:property-value1,property-name2:property-value2

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

pagination

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/sslcertkey_service_binding/certkey_value<String>?pagesize=#no;pageno=#no

Use this query-parameter to get the sslcertkey_service_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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload: 


{ "sslcertkey_service_binding": [ {
"servicegroupname":<String_value>,
"ca":<Boolean_value>,
"service":<Boolean_value>,
"servicename":<String_value>,
"certkey":<String_value>,
"version":<Integer_value>,
"data":<Double_value>
}]}

<!--NeedCopy-->

get (all)

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/sslcertkey_service_binding

Query-parameters:

bulkbindings

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/sslcertkey_service_binding?bulkbindings=yes

NITRO allows you to fetch bindings in bulk.

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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload: 


{ "sslcertkey_service_binding": [ {
"servicegroupname":<String_value>,
"ca":<Boolean_value>,
"service":<Boolean_value>,
"servicename":<String_value>,
"certkey":<String_value>,
"version":<Integer_value>,
"data":<Double_value>
}]}

<!--NeedCopy-->

count

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/sslcertkey_service_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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload: 


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

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