The Blue Planet software presents API documentation using Swagger, a specification language that defines and documents RESTful APIs. A Swagger document is in a JSON schema-like format. The Swagger user interface is a browser-based rendering of the Swagger document for reading, exploring, and trying out the REST APIs.

Client-side developers who are integrating additional functionality can use the open REST APIs. Typical end-users do not frequently use the Swagger user interface. For example, developers use the API when performing tasks that cannot be done in the UI or to automate a tedious bulk operation like updating domain credentials across the network.

This section contains:

• Accessing the API documentation

• Creating user SSH keys for git access (optional)

• Running an API command within the Swagger interface

• Authenticating API requests

• Blue Planet diagnostics APIs

For detailed reference information on the Blue Planet APIs, see the Blue Planet API Guide.