Using the API interactive documentation
The API includes interactive documentation for both developers and non-developers to explore the API endpoints, view documentation for the API, and experiment with API calls. Built on Swagger UI, this interactive tool makes it easy for you to visualize, interact with, and test the APIs within a browser.
You can make API calls from an interactive user interface, custom applications, or from command line tools such as cURL.
Before you begin
Ensure you have access to the administrative API. Learn more in Accessing the admin console and administrative API.
To access the administrative API documentation:
-
Start a web browser.
-
Go to the URL:
https://self-service-api.<environment>-<customer>.<region>.ping.cloud/docs
The API is also documented in the OpenAPI Specification, previously known as the Swagger Specification. Go to: https://self-service-api.<environment>-<customer>.<region>.ping.cloud/api/v1/openapi.json.
To test an administrative API:
-
Select a section of the administrative API you would like to explore. For example, /hostnames.
-
Expand the method you want to use. For example, GET /hostnames.
-
Enter required parameters, if any. For more information, see Schema Models under the selected API endpoint.
-
Click Try it out.
You will be prompted to sign on using an access token for OAuth authentication. The role assigned to the respective administrative accounts affects the access to the requested API. If the request completes successfully, the administrative API returns the Request URL, the Response Body, the Response Code, and the Response Headers.