Dell N3200-ON Networking N-Series Switches RESTful API User Guide version 6.8. - Page 9

2 RESTful OpEN API Overview The Dell Networking RESTful API allows you to configure various operational parameters and attributes, including selected protocols on the target switch. Since the API is based on REST principles, it is very easy to write and test applications. You can use your browser to test URLs, and you can use pretty much any HTTP client in any programming language to interact with the API. Please note, although Internet-based browsers can issue requests, the intended use of this REST API is a programming interface. Most modern programming languages provide support for constructing and parsing JSON, as well as issuing HTTP requests. Examples include Python's 'requests' and 'json' modules, and the Java classes in the org.apache.http and org.json.simple namespaces. The REST of the API examples in this document demonstrate the use of the libcurl library using the cURL command-line tool found at http://curl.haxx.se/. Base URL All URL references in this documentation have the following base: serveraddress:RESTful_port/open/version, where: • The server-address is the IP address or host name of the target switch. • RESTful_port is the configured Layer 4 port number in the range 1025 to 65535 for RESTful connection. The default RESTful port is 8080. Following the server-address: • RESTful_port is the open resource, which is used to redirect the request to the Dell Networking N-Series RESTful APIs for Dell OpEN. • Versioning is mandatory and is part of the URL. The version is denoted by using the letter v followed by a single version number. For example, http://10.10.10.1:8080/open/v1/ RESTful OpEN API Overview 9