Sending Http(S) Requests - Cisco Webex DX70 Administrator's Manual

Cisco Webex DX70 and DX80

Introduction
Customization

Sending HTTP(S) requests

API
xCommand HttpClient Post/Put/Patch/Get/Delete
Video conferencing device - HTTP(S) client
The HTTP(S) request feature makes it possible to send
arbitrary HTTP(S) requests from a video conferencing
device to an HTTP(S) server. Furthermore, the device
receives the response that the server sends back. The
device supports the Post, Put, Patch, Get, and Delete
methods.
By using macros, you can send data to an HTTP(S) server
whenever you want. You can choose what data to send,
and structure them as you like. By doing it this way, you
can adapt the data to an already established service.
Security measures:
• The HTTP(S) request feature is disabled by default. A
system administrator must explicitly enable the feature
by setting HttpClient > Mode to On.
• The system administrator can prevent the use of HTTP
by setting HttpClient > AllowHTTP to False.
• The system administrator can specify a list of HTTP(S)
servers that the device is allowed to send data to.
• The number of concurrent HTTP(S) requests is limited.
D15362.17 DX70 and DX80 Administrator Guide CE9.14, OCTOBER 2020.
Configuration Peripherals
Network
List of Allowed HTTP(S) servers
The system administrator can use these commands to set
up and maintain a list of up to ten allowed HTTP(S) servers
(hosts):
xCommand HttpClient Allow Hostname Add
•
Expression: <Regular expression that matches
the host name or IP address of the HTTP(S)
server>
xCommand HttpClient Allow Hostname Clear
•
xCommand HttpClient Allow Hostname List
•
xCommand HttpClient Allow Hostname Remove Id:
•
<id of an entry in the list>
If the list is not empty, you can send HTTP(S) requests only
to the servers in the list. If the list is empty, you can send
the requests to any HTTP(S) server.
The check against the list of allowed servers is performed
both when using insecure (HTTP) and secure (HTTPS)
transfer of data.
Maintenance
Third-party service
HTTP(S) server
www.cisco.com — Copyright © 2020 Cisco Systems, Inc. All rights reserved.
178
Administrator Guide
Device settings Appendices Appendices
HTTPS without certificate validation
When sending requests over HTTPS, the video
conferencing device checks the certificate of the HTTPS
server by default. If the HTTPS server certificate is not
found to be valid, you get an error message. The device
doesn't send any data to that server.
We recommend using HTTPS with certificate validation.
If certificate validation is not possible, the system
administrator can set HttpClient > AllowInsecureHTTPS
On. This allows the use of HTTPS without validating the
certificate of the server.
Sending HTTP(S) requests
Once the HTTP(S) request feature is enabled, you can
use the following commands to send requests to an
HTTP(S) server:
xCommand HttpClient <Method>
[AllowInsecureHTTPS: <True/False>]
[Header: <Header text>]
[ResponseSizeLimit: <Maximum response size>]
[ResultBody: <None/PlainText/Base64>]
[Timeout: <Timeout period>]
Url: <URL to send the request to>
Method> Post Put Patch
where < is either , ,
Delete
.
Post Put Patch
The , , and commands are multiline
commands. Read the API guide to find out how to
use multiline commands, and also to find a detailed
description of the command parameters
Further information
Find more information about HTTP(S) Post requests in the
Customization guide. Go to:
► https://www.cisco.com/go/in-room-control-docs
to
Get
, , or