Product Documentation

callhome

Oct 21, 2015

Call Home

Properties

Name Data Type Read-Only? Description
proxy
<Boolean>
No

Proxy Set for CallHome Server

Possible values = [true, false]

enable
<Boolean>
No

Enable/Disable Call Home Feature

Possible values = [true, false]

proxyport
<Integer>
No

Proxy PORT for CallHome Server

Minimum value = 1

Maximum value = 65535

contact
<String>
No

Contact

proxyip
<String>
No

Operations

Hinweis

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

GET

Get Call Home Config

HTTP Method: GET

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

Request Headers:

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

Response Headers:

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

Response Payload: JSON

{"callhome":{
"proxy": <boolean_value>,
"enable": <boolean_value>,
"proxyport": <integer_value>,
"contact": <string_value>,
"proxyip": <string_value>
}}

MODIFY

Use this operation to modify Call Home Configuration

HTTP Method: PUT

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

Request Headers:

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

Request Payload: JSON

{"callhome":{
"proxy": <boolean_value>,
"enable": <boolean_value>,
"proxyport": <integer_value>,
"contact": <string_value>,
"proxyip": <string_value>
}}

Response Headers:

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

Response Payload: JSON

{"callhome":{
"proxy": <boolean_value>,
"enable": <boolean_value>,
"proxyport": <integer_value>,
"contact": <string_value>,
"proxyip": <string_value>
}}