APIs

Edit online

Data management products provide their functionality through REST APIs. Swagger documentation for these APIs is available in HTML format in the Swagger editor.

Swagger documentation

When the Unified Management Server is running, you can open API Swagger documentation by opening the following URL in a browser: 
https://<host>:<port>/ws/swagger-ui.html
where <host>:<port> are the host name or IP address, and the port number, of the Unified Management Server host computer. The port number is specified by the components.izp.server.port parameter, and its default value is 12023.

By default, the documentation displays the latest version. To find an older version, select it from the drop-down list. Only the endpoints of data management experiences that have been purchased and activated are available. Deprecated endpoints are gray, and the text is struck through.

Specifying versions in REST calls

To specify the version of an end point to use in a REST API call, you can use the X-API-VERSION header with any of the following values:
  • No value (or not using the header): Calls the newest available version of the endpoint.
  • LATEST: Calls the newest available version of the endpoint.
  • EARLIEST: Calls the earliest available version of the endpoint.
  • <version>: Calls the specified version, for example "1.1.0.0". You can specify any version that is available in the Swagger documentation.
Tip: It is recommended to use X-API-Version for pipelines or programs that leverage UMS APIs.

If you have coded the pipeline or programmed the plug-in for Unified Management Server 1.1 (UI78605), pass the X-API-VERSION header. For example, pass X-API-Version: 1.1.0.8 for Unified Management Server 1.1 (UI78605). This ensures your pipeline or program will work even if features are changed or scheduled to be removed. You can upgrade the X-API-VERSION header after testing future PTFs in your environment.

For information on deprecated and removed functions in Unified Management Server 1.2, see Deprecated and removed functions in Unified Management Server.