Using Swagger

Swagger is an interactive shell for exploring the work of API. With Swagger, you can generate a request for an API function of the platform and check how that function works.

To open the Swagger web interface, in the right menu click → Swagger.

The Swagger interface is available at the URL https://domain.com/swagger/.

Swagger sections

Swagger contains a description of the following DCImanager 6 API services:

• DCI back — platform main service;
• Auth v4 — latest version of the authorization service;
• IPmanager — IPmanager 6 — service for operations with IP-addresses, pools and networks;
• Report service;
• BMC proxy service — BMC proxy module service;
• Equipment service;
• Backup service;
• Global search service;
• rDNS proxy service — service for operations with reverse PTR records. To use the service, install the Integration with DNSmanager 6 module. Without the module installed, API requests will return a 404 error;
• Updater service;
• ISO upload service.

To switch between services, select the desired section in the Select a definition field.

Selecting a section

Execute API requests

To execute a request:

1. Select the required function and press Try it out.
   
2. Enter the required parameters and the request body and press Execute.
   

After the request has been executed, the Responses section displays the request format for the curl utility and the server response.

Section interface

Some services may return a 503 error and an Unavailable message in the response body. If this is the case, re-execute the request.

Example error

Usage examples

Changing the session lifetime

1. In the Select a definition field select Auth v4.
2. Select a POST request /setting/{name}.
3. Click the Try it out button.
4. In the Name field enter: token_ttl.

5. Enter the Request body:

   {
     "value": "<time>"
   }

   <time> — required session lifetime, min

6. Click the Execute button.