CWM API Postman collection

This section contains the following topics:

CWM API Postman collection

The CWM API was developed according to the Representational State Transfer (REST) design principles. The API is accessed using HTTP with JSON data format. The success or failure of the request is indicated by the relevant HTTP response code. Data retrieval methods require a GET request, while methods for adding, changing, or deleting data require POST, PUT, PATCH, or DELETE methods. Errors will be returned if the request is sent with the wrong request type. Built directly into the product is a Swagger interface accessed from the CWM UI, but for ease of use, a Postman collection with example requests is also provided.

Use API Postman collection

Import collection and set environment:

Before you begin

Procedure

Step 1

Open Postman and go to Collections.

Step 2

Click Import, select folders from the Drop anywhere to import screen and point to the folder that you have unpacked from the zip archive.

Step 3

Go to Environments and select the newly imported test environment.

Step 4

Provide current values for the baseUrl and port variables to fit your CWM IP address and port and save the changes.

Now you're set up and ready to use the collection.