Product Documentation

http_params

Oct 21, 2015

HTTP Configuration.

Properties

Name Data Type Read-Only? Description
sslprivatekey
<String>
No

SSL Private Key.

Valid char set = ^(-{1,}BEGIN \\w* PRIVATE KEY-{1,}).+(-{1,}END \\w* PRIVATE KEY-{1,}\r{0,1}\n{0,1})$

webaccessprotocol
<String>
No

Web Access Protocol. Possible values HTTP, HTTPS.

Possible values = [https, http]

status
<Boolean>
No

HTTP Enable/Disable status.

Possible values = [true, false]

sslcertificate
<String>
No

SSL Certificate.

Valid char set = ^(-{1,}BEGIN CERTIFICATE-{1,}).+(-{1,}END CERTIFICATE-{1,}\r{0,1}\n{0,1})$

httpport
<Integer>
No

HTTP port.

Minimum value = 1

Maximum value = 65535

httpforwarding
<Boolean>
No

Enable/disable HTTP forwarding.

Possible values = [true, false]

httpsport
<Integer>
No

HTTPS port.

Minimum value = 1

Maximum value = 65535

Operations

Hinweis

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

GET

Use this operation to get HTTP configuration details

HTTP Method: GET

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

Request Headers:

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

Response Headers:

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

Response Payload: JSON

{"http_params":{
"sslprivatekey": <string_value>,
"webaccessprotocol": <string_value>,
"status": <boolean_value>,
"sslcertificate": <string_value>,
"httpport": <integer_value>,
"httpforwarding": <boolean_value>,
"httpsport": <integer_value>
}}

MODIFY

Use this operation to modify HTTP configuration

HTTP Method: PUT

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

Request Headers:

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

Request Payload: JSON

{"http_params":{
"sslprivatekey": <string_value>,
"webaccessprotocol": <string_value>,
"status": <boolean_value>,
"sslcertificate": <string_value>,
"httpport": <integer_value>,
"httpforwarding": <boolean_value>,
"httpsport": <integer_value>
}}

Response Headers:

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

Response Payload: JSON

{"http_params":{
"sslprivatekey": <string_value>,
"webaccessprotocol": <string_value>,
"status": <boolean_value>,
"sslcertificate": <string_value>,
"httpport": <integer_value>,
"httpforwarding": <boolean_value>,
"httpsport": <integer_value>
}}