OpenAPI (Swagger) for DPX

The OpenAPI (Swagger) specification provides a standardized, machine-readable definition of this product’s RESTful web services, enabling developers and integrators to explore, test, and interact with the API in a consistent and efficient manner. This documentation describes the available endpoints, supported operations, input and output parameters, authentication requirements, and response formats.

Attention!

Executing DPX API commands without understanding their functions can lead to data loss.

Using OpenAPI

To open swagger and list all available commands, go to <DPX_IP>/swagger-ui/. This page lists all available API endpoints for your DPX, allowing to interact with DPX through API calls.