Web Services Api - Cisco D9800 Reference Manual

Web Services API

This section describes the web services API used to control the D9800 Network Transport Receiver, including
HTTP request and response methods, URI arguments, and port information.
•
•
•
•
•
•
•
About Web Services API
Web services API is a standard interface designed for the D9800 Network Transport Receiver. It replaces the
previous interfaces, such as TELNET. The web services API is designed to be flexible and address different
functionality requirements of an interface, such as concurrent access, authentication, authorization, and so
on. All APIs are implemented using HTTP protocol and run on standard web servers using TCP port 80 or
443 for HTTPS.
Accessing Web Services API
This document assumes that the IP address of the unit being accessed is 192.168.0.1. When copying or pasting
into a cURL console, you must replace 192.168.0.1 in the message with the IP address of the target unit. By
default, the D9800 web server redirects all incoming web traffic to HTTPS on port 443 and will respond to
all HTTP URI requests with a redirect response to the equivalent HTTPS URI.
The APIs in this document that has the /ws/v1/ extension indicates a version 1 (Legacy) web services API,
and the /ws/v2/ extension indicates a version 2 web services API. For example,
https://192.168.0.1/ws/v2/show/inventory.
About Web Services API, page 1
Accessing Web Services API, page 1
Access Level (Login and Logout), page 2
HTTP Request Methods, page 3
HTTP Responses, page 4
XML or JSON Response Body, page 6
Base URI, page 7
Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
1
C H A P T E R
1