API Guide

RESTCONF API
RESTCONF is a representational state transfer (REST)-like protocol that uses HTTPS connections. Use the OS10 RESTCONF
API to set up the configuration 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 configure 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 defined 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 configure and enable the RESTCONF API, see the
Configure the RESTCONF API section.
To configure 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, such as:
Table 136. OS10 RESTCONF resources
Resource Description URL
Data Configuration and operational data the
RESTCONF API client accesses
/restconf/data
Operations Container for the protocol-specific data model
operations OS10 advertises
/restconf/operations
To browse OS10 RESTCONF API end-points and operations, see the OpenAPI JSON files available on the OS10 Enterprise
Edition Software page at the Dell EMC Support site. Download the JSON files 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
specification, go to https://swagger.io/docs/specification/about/.
Configure 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 configure HTTPS access, including:
● Hostname required in a Secure Sockets Layer (SSL) self-signed server certificate
● Timeout for the 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) Configure the hostname required in the SSL self-signed server certificate 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) Configure the timeout that a RESTCONF HTTPS session uses in CONFIGURATION mode, from 30 to 65535
seconds; default 30.
rest https session timeout seconds
3. (Optional) Limit the ciphers that the switch uses in a RESTCONF HTTPS session to encrypt and decrypt data in
CONFIGURATION mode. By default, all cipher suites installed on OS10 are supported. Separate multiple entries with a blank
space. Valid cipher-suite values are:
● dhe-rsa-with-aes-128-gcm-SHA256
● dhe-rsa-with-aes-256-gcm-SHA384
27
1386 RESTCONF API