Service Manual

REST API

Representational state transfer (REST) application programming interface (API) is an integrated part of the Dell Networking operating

system (OS) and is supported on the S4810, S4820T, S3048–ON, S4048–ON, S4048T–ON, S6000, S6000–ON, S6010–ON, S6100–ON,

Z9100–ON, C9010, S5000, and Z9500 platforms.

HTTP and HTTPS

Use REST API to configure and monitor a Dell Networking switch over the hyper text transfer protocol (HTTP) and hyper text transfer

protocol secure (HTTPS).

HTTP and HTTPS are the common protocols that support read, create, update, and delete operations with the actions using methods

such as GET, POST, PUT, PATCH, and DELETE. For more information, see RFC 2616, Hypertext Transfer Protocol - HTTP/1.1.

XML

Extensible markup language (XML) is a standardized, easy-to-read and easy-to-parse method to represent data. Use the XML protocol

data unit (PDU) to exchange data between the Dell Networking switch and the HTTP/HTTPS client.

The system handles up to four simultaneous REST API requests. You can use REST API on switches without having to code individual CLI

commands and open telnet, SSH, or console connections for each command.

In addition to REST API, you can use third-party management tools and other industry-standard management protocols to manage Dell

Networking switches.

Important Points to Remember

• You must have Internet protocol (IP) reachability from the REST client to the Dell Networking switch.

• For enabling and disabling the REST API, see REST API CLI.

• You cannot delete physical interfaces using REST API.

• Port 8008 is a nonsecure port HTTP uses; port 8888 is a secure port HTTPS uses.

REST Authentication

The REST API authenticates and authorizes the user based on the Dell Networking OS AAA configuration.

You can locally configure or validate through the AAA infrastructure. For more information about the AAA Accounting mode, see the Dell

Networking OS Configuration Guide, Security chapter.

The Dell Networking OS CLI user level privilege dictates the level of the REST API access. Users with privilege level 0 or 1 have read-only

access; the allowed REST API method is GET. Users with privilege levels 2 through 15 have read-write access in REST API. The allowed

methods are GET, PATCH, PUT, POST, and DELETE.

For information about the privilege level command, see the Dell Networking OS Command Line Reference Guide, Security chapter.

REST API 137