OpenStack API Documentation

OpenStack API Documentation

Use the OpenStack APIs to launch server instances, create images, assign metadata to instances and images, create storage containers and objects, and complete other actions in your OpenStack cloud.

Current API versions

Bare Metal API v1 (microversions)

Block Storage API v3 (microversions)

Note

The Block Storage API v3 is functionally identical to the Block Storage API v2. Subsequent API v3 microversions, such as v3.1, differ from API v2.

Clustering API v1

Compute API (microversions)

Data Processing v1.1

Database Service API v1.0

Domain Name Server (DNS) API v2

Identity API v3

Identity API v3 extensions

Image service API v2

Networking API v2.0

Object Storage API v1

Orchestration API v1

Search API v1

Shared File Systems API v2 (microversions)

Note

The Shared File Systems API v1 is functionally identical to the Shared File Systems API v2. Subsequent API v2 microversions, such as v2.1, differ from API v1.

Supported API versions

Block Storage API v2

Deprecated API versions

Block Storage API v1

Identity API v2.0

Identity admin API v2.0

Identity API v2.0 extensions

Image service API v1

The API status reflects the state of the endpoint on the service.

  • Current indicates a stable version that is up-to-date, recent, and might receive future versions. This endpoint should be prioritized over all others.
  • Supported is a stable version that is available on the server. However, it is not likely the most recent available and might not be updated or might be deprecated at some time in the future.
  • Deprecated is a stable version that is still available but is being deprecated and might be removed in the future.
  • Experimental is not a stable version. This version is under development or contains features that are otherwise subject to change. For more information about API status values and version information, see Version Discovery.
  • Microversions indicates that the API follows a pattern established by the Compute service to enable small, documented changes to the API on a resource-by-resource basis.

API quick-start examples

With the TryStack OpenStack installation, these services work together in the background of the installation, and many of these examples work on TryStack.

After you authenticate through Identity, you can use the other OpenStack APIs to create and manage resources in your OpenStack cloud. You can launch instances from images and assign metadata to instances through the Compute API or the openstack command-line client.

To begin sending API requests, use one of the following methods:

  • cURL

    A command-line tool that lets you send HTTP requests and receive responses. See the section called OpenStack APIs.

  • OpenStack command-line client

    The OpenStack project provides a command-line client that enables you to access APIs through easy-to-use commands. See the section called OpenStack command-line clients.

  • REST clients

    Both Mozilla and Google provide browser-based graphical interfaces for REST. For Firefox, see RESTClient. For Chrome, see rest-client.

  • OpenStack Python Software Development Kit (SDK)

    Use this SDK to write Python automation scripts that create and manage resources in your OpenStack cloud. The SDK implements Python bindings to the OpenStack API, which enables you to perform automation tasks in Python by making calls on Python objects rather than making REST calls directly. All OpenStack command-line tools are implemented by using the Python SDK. See OpenStack Python SDK in the OpenStack End User Guide.

Creative Commons Attribution 3.0 License

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.