Citrix

Produktdokumentation



Ganzes Dokument herunterladen

ssl_cert_keys

Oct. 21, 2015

SSL Certificate-Key pair.

Properties

Name Data Type Read-Only? Description
certificatedetails
<[String,...]>
Yes

Certificate details text providing Version,Serial Number,Signature Algorithm,Issuer etc

modifyaction
<String>
No

Specifies whether to replace an existing key-type, add a new key-type or remove one of them when both are already present

Possible values = [replace_rsa, replace_dsa, remove_rsa, remove_dsa, add_rsa, add_dsa]

certpem
<String>
No

Cert input in pem format. This is write only parameter. To fetch certicate pem text or other details, see certinfo parameter.

keytype
<String>
Yes

Certificate/key type.

name
<String>
No

Certificate Name

keypem
<String>
No

Key in pem format. Has to be decoded before applying, if password encrypted

certinfo
<[Object,...]>
Yes
Certificate pem text and expiry info for each certificate in the input bundle
certinfo.certexpirydate
<String>
Yes

Certificate expiry date.

certinfo.certpem
<String>
No

Certificate Pem.

certinfo.certexpired
<Boolean>
Yes

Certificate expiry status.

Possible values = [true, false]

certcount
<Integer>
Yes

Certificate Count.

Operations

Note:

Mandatory parameters are marked in red and placeholder content is marked in <green>.

ADD

Use this operation to add a SSL Certificate-Key pair

HTTP Method: POST

URL: https://<cb_ip_address>/cb/nitro/v1/config/ssl_cert_keys

Request Headers:

Authorization: Basic <base64 encoded(username:password)>
Content-Type: application/vnd.com.citrix.cloudbridge.ssl_cert_keys+json

Request Payload: JSON

{"ssl_cert_keys":{
"modifyaction": <string_value>,
"certpem": <string_value>,
"name": <string_value>,
"keypem": <string_value>
}}

Response Headers:

Content-Type: application/vnd.com.citrix.cloudbridge.ssl_cert_keys+json

Response Payload: JSON

{"ssl_cert_keys":{
"certificatedetails": <string_value>,
"modifyaction": <string_value>,
"certpem": <string_value>,
"keytype": <string_value>,
"name": <string_value>,
"keypem": <string_value>,
"certinfo": [{
"certexpirydate": <string_value>,
"certpem": <string_value>,
"certexpired": <boolean_value>
}, ...],
"certcount": <integer_value>
}}

DELETE

Use this operation to remove a SSL Certificate-Key pair

HTTP Method: DELETE

URL: https://<cb_ip_address>/cb/nitro/v1/config/ssl_cert_keys/<name>

Request Headers:

Authorization: Basic <base64 encoded(username:password)>

Response Payload: EMPTY

GET (ALL)

Use this operation to get SSL Certificate-Key pair configuration details

HTTP Method: GET

URL: https://<cb_ip_address>/cb/nitro/v1/config/ssl_cert_keys

Request Headers:

Authorization: Basic <base64 encoded(username:password)>
Accept: application/vnd.com.citrix.cloudbridge.ssl_cert_keys_list+json

Response Headers:

Content-Type: application/vnd.com.citrix.cloudbridge.ssl_cert_keys_list+json

Response Payload: JSON

{"ssl_cert_keys": [{
"certificatedetails": <string_value>,
"modifyaction": <string_value>,
"certpem": <string_value>,
"keytype": <string_value>,
"name": <string_value>,
"keypem": <string_value>,
"certinfo": [{
"certexpirydate": <string_value>,
"certpem": <string_value>,
"certexpired": <boolean_value>
}, ...],
"certcount": <integer_value>
}, ...]}

GET

Use this operation to get SSL Certificate-Key pair configuration details

HTTP Method: GET

URL: https://<cb_ip_address>/cb/nitro/v1/config/ssl_cert_keys/<name>

Request Headers:

Authorization: Basic <base64 encoded(username:password)>
Accept: application/vnd.com.citrix.cloudbridge.ssl_cert_keys+json

Response Headers:

Content-Type: application/vnd.com.citrix.cloudbridge.ssl_cert_keys+json

Response Payload: JSON

{"ssl_cert_keys":{
"certificatedetails": <string_value>,
"modifyaction": <string_value>,
"certpem": <string_value>,
"keytype": <string_value>,
"name": <string_value>,
"keypem": <string_value>,
"certinfo": [{
"certexpirydate": <string_value>,
"certpem": <string_value>,
"certexpired": <boolean_value>
}, ...],
"certcount": <integer_value>
}}

MODIFY

Use this operation to modify a SSL Certificate-Key pair

HTTP Method: PUT

URL: https://<cb_ip_address>/cb/nitro/v1/config/ssl_cert_keys/<name>

Request Headers:

Authorization: Basic <base64 encoded(username:password)>
Content-Type: application/vnd.com.citrix.cloudbridge.ssl_cert_keys+json

Request Payload: JSON

{"ssl_cert_keys":{
"modifyaction": <string_value>,
"certpem": <string_value>,
"name": <string_value>,
"keypem": <string_value>
}}

Response Headers:

Content-Type: application/vnd.com.citrix.cloudbridge.ssl_cert_keys+json

Response Payload: JSON

{"ssl_cert_keys":{
"certificatedetails": <string_value>,
"modifyaction": <string_value>,
"certpem": <string_value>,
"keytype": <string_value>,
"name": <string_value>,
"keypem": <string_value>,
"certinfo": [{
"certexpirydate": <string_value>,
"certpem": <string_value>,
"certexpired": <boolean_value>
}, ...],
"certcount": <integer_value>
}}
Back to Top