Note : Interface type can be found using the rest-translate command (as discussed in Example 1: RESTCONF query to create VLAN 20 ). You can see the JSON data response in the lower pane. Once the request has been sent to the switch, the response can be verified as shown. Click Send to send the API request to the switch and confirm the response. In this example, we will modify the body to include the VLAN data required to create VLAN 20 on the switch. You can send various types of body data to suit your API. The Body in Postman allows you to specify the data you need to send with a request. URL Step 4: Send the query to the deviceĮach request consists of a REST API endpoint URL, API method, and parameters. Update the field next to the method.įigure 5. This URL is what you enter into Postman to access the API. Basic Authentication is supported only when SSL/TLS is used for the transport.Įach request you send in Postman requires a URL that represents the API endpoint that you are working with. If you do not provide the credentials, a 401-Authorization Failure error is returned. Under the Authorization header, set the authentication parameters required to connect to the switch. USER_NAME - username of any CLI user account.Global variables for a workspace are a set of variables that are always available within the scope of that workspace. Set the global variables under the Environment quick look (eye). Requests in Postman Step 3: Set global variables and authorization methodĪn environment is a set of variables that can be used in Postman requests. In this example, we will create VLAN 20 using the POST request as shown in the following figure.įigure 2.

You are now able to browse through the different requests available in this collection. Once the selection is complete, you will see the JSON file imported as a Postman collection under the Collections tab. OS10(conf)# rest api restconf Step 2: Import REST endpoints into Postmanĭownload the OpenAPI JSON files from the OS10 Enterprise Edition Software page and import it to Postman by clicking Import. To use the RESTCONF API on an OS10 interface, you must enable the RESTCONF API service using the rest api restconf command. In this example, we will import the ietf-interfaces API to create a VLAN on the switch. Postman is a free-to-download tool for making HTTP requests. The following steps show how to create VLAN 20 in SmartFabric OS10 Full Switch mode and SmartFabric Services mode.

Postman download file example