Representational State Transfer (REST) Application Programming Interfaces (API) are used to control how your Webex Share interacts with Control Hub over the Cloud or Internet. You use these APIs and access them from a web server which is the preferred way to use them. Because you can enter them directly from a web browser then they are listed here also. To access the APIs from your web browser, turn on the Settings Lock toggle in the device's Control Hub page.

Table 1. REST APIs

API

Method

Request and Response

Description

activation

GET

Response

{"isActivated": "True_or_False"}

Returns if the device is activated or not.

activation

POST

Request

{"activationCode": "activation_code_string" }

Sends an activation code to the device.

static_ip

PUT

Request

{ "static_ip": "static_ip_string", "gateway": "gateway_string", "subnet_mask": "subnet_mask_string", "dns_domain_name": "dns_domain_name_string", "dns_server_1": "dns_server_1_string", "dns_server_2": "dns_server_2_string", "dns_server_3": "dns_server_3_string"

Response

{ "new_ip": "new_ip_string" }

Modifies the static IP address.

language

GET

Response

{ "language": "language_string" }

Returns the configured language.

language

PUT

Request

{ "language": "language_string" }

Modifies the configured language.

upload

POST

Request

{ "file": "file_path_string" }

Uploads a file.

feature_toggle

PUT

Request

{ "feature": "feature_name_string", "enable": "true_or_false_string" }

Enables a feature toggle.

cloud_connectivity

GET

Response

{ "connectivity": "connectivity_string" }

Returns the connectivity string.