OpenStack API¶

The OpenStack API is available for managing or performing actions on the resources in your cloud account.

This is a powerful feature for users that either want to create infrastructure as code projects or want to integrate with third-party applications to manage your infrastructure.

The OpenStack API is broken down into multiple projects based on what service it provides.

They have in common that an API user is needed to access the API using any of the below endpoints.

We keep updated information about the release of the platform along with links to correct APIs available in our OpenStack documentation.

• Function - what services in the platform the API can manage with a link to its section in our documentation.

• Service name - the name of the OpenStack feature. With this you can find the relevant section in the official API docks.

• API endpoint - the information on where to connect to consume the APIs.

Version¶

Some of the OpenStack APIs will support multiple versions for backwards compatibility.

Generally the recommended version is included in the URL (where applicable) below but in certain cases microversions might be required (for example v2.1 vs v2.67 for Nova) for some functionality.

Keystone¶

Keystone is the identity service in the OpenStack ecosystem that you use to authenticate using an API user.

A good place to start is available in the official documentation here.

Authentication is needed for all API calls, when authenticating for your token a catalog with endpoints is provided in the response, for verbosity it’s also included below.

Endpoints¶