Reference Guide

RESTCONF API
RESTCONF is a REST-like protocol that uses HTTPS connections. Use the OS10 RESTCONF API to set up the conguration parameters
on OS10 switches using JavaScript Object Notation (JSON)-structured messages. Use any programming language to create and send
JSON messages. The examples in this chapter use curl.
The OS10 RESTCONF implementation complies with RFC 8040. You can use the RESTCONF API to congure and monitor an OS10
switch.
The OS10 RESTCONF API uses HTTP with the Transport Layer Security (TLS) protocol over port 443. OS10 supports HTTP/1.1 transport
as dened in RFC 7230. The RESTCONF API uses pluggable authentication modules (PAM)-based authentication.
On supported platforms, the OS10 RESTCONF API is disabled by default. To congure and enable the RESTCONF API, see the Congure
the RESTCONF API section.
To congure and monitor an OS10 switch, use REST API client tools, such as Postman or Swagger, to execute web requests. REST API
requests, such as GET, PUT, POST, DELETE, and PATCH, operate on OS10 RESTCONF resources.
Table 42. OS10 RESTCONF resources
Resource Description URL
Data Conguration and operational data accessed by a
RESTCONF API client
/restconf/data
Operations Container for the protocol-specic data model
operations advertised by OS10
/restconf/operations
To browse OS10 RESTCONF API end-points and operations, see the OpenAPI JavaScript Object Notation (JSON) les available on the
OS10 Enterprise Edition Software page at the Dell EMC Support site. Download the JSON les and import them to REST API client tools
— for example, Swagger or Postman — to generate code, documentation, and test cases. For information about the OpenAPI
specication, go to https://swagger.io/docs/specication/about/.
Congure RESTCONF API
To use the RESTCONF API on an OS10 interface, you must enable the RESTCONF API service using the rest api restconf
command. You can also congure HTTPS access, including:
• Hostname required in an SSL self-signed server certicate
• Timeout for an HTTPS connection
• Cipher suites for encrypting data in an HTTPS connection
After you enable the RESTCONF API, you can send HTTPS requests from a remote device.
1 (Optional) Congure the hostname required in the SSL self-signed server certicate in a RESTCONF HTTPS connection in
CONFIGURATION mode, using a maximum of 30 alphanumeric characters. Enter the IP address or domain name of the OS10 switch.
By default, the domain name of the OS10 switch is used as the hostname.
rest https server-certificate name hostname
2 (Optional) Congure the timeout that a RESTCONF HTTPS session uses in CONFIGURATION mode, from 30 to 65535 seconds;
default 30.
rest https session timeout seconds
14
RESTCONF API 785