2019-07-16 16:22:44 +02:00
|
|
|
===========================
|
|
|
|
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.
|
|
|
|
|
|
|
|
.. note::
|
|
|
|
The links below are grouped according to the API status that 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 <https://wiki.openstack.org/wiki/VersionDiscovery>`__.
|
|
|
|
|
|
|
|
The notation '(microversions)' next to the link to an API reference
|
|
|
|
indicates that the API follows a `pattern established by the Compute
|
|
|
|
service
|
2019-07-22 20:34:44 +02:00
|
|
|
<https://docs.openstack.org/api-guide/compute/microversions.html>`__
|
2019-07-16 16:22:44 +02:00
|
|
|
to enable small, documented changes to the API on a resource-by-resource
|
|
|
|
basis.
|
|
|
|
|
|
|
|
.. _current_api_versions:
|
|
|
|
|
|
|
|
Current API versions
|
|
|
|
--------------------
|
|
|
|
|
2022-09-08 10:50:17 +08:00
|
|
|
`Acceleration API v2 <https://docs.openstack.org/api-ref/accelerator/>`__
|
2019-07-16 16:22:44 +02:00
|
|
|
|
2019-08-28 16:17:00 +02:00
|
|
|
`Admin Logic API
|
|
|
|
<https://docs.openstack.org/api-ref/admin-logic/>`__
|
|
|
|
|
2019-07-22 20:34:44 +02:00
|
|
|
`Application Catalog API v1 <https://docs.openstack.org/api-ref/application-catalog/v1/>`__
|
2019-07-16 16:22:44 +02:00
|
|
|
|
2019-07-22 20:34:44 +02:00
|
|
|
`Application Container Service API <https://docs.openstack.org/api-ref/application-container/>`__ (microversions)
|
2019-07-16 16:22:44 +02:00
|
|
|
|
2019-07-22 20:34:44 +02:00
|
|
|
`Backup API v1 <https://docs.openstack.org/api-ref/backup/v1/>`__
|
2019-07-16 16:22:44 +02:00
|
|
|
|
2019-07-22 20:34:44 +02:00
|
|
|
`Bare Metal API v1 <https://docs.openstack.org/api-ref/baremetal/>`__ (microversions)
|
2019-07-16 16:22:44 +02:00
|
|
|
|
2019-07-22 20:34:44 +02:00
|
|
|
`Block Storage API v3 <https://docs.openstack.org/api-ref/block-storage/v3/>`__ (microversions)
|
2019-07-16 16:22:44 +02:00
|
|
|
|
|
|
|
.. 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.
|
|
|
|
|
2019-07-22 20:34:44 +02:00
|
|
|
`Clustering API v1 <https://docs.openstack.org/api-ref/clustering/>`__
|
2019-07-16 16:22:44 +02:00
|
|
|
|
2019-07-22 20:34:44 +02:00
|
|
|
`Compute API <https://docs.openstack.org/api-ref/compute/>`__ (microversions)
|
2019-07-16 16:22:44 +02:00
|
|
|
|
2019-07-22 20:34:44 +02:00
|
|
|
`Container Infrastructure Management API <https://docs.openstack.org/api-ref/container-infrastructure-management/>`__ (microversions)
|
2019-07-16 16:22:44 +02:00
|
|
|
|
2019-07-22 20:34:44 +02:00
|
|
|
`Data Processing v1.1 <https://docs.openstack.org/api-ref/data-processing/>`__
|
2019-07-16 16:22:44 +02:00
|
|
|
|
2019-07-22 20:34:44 +02:00
|
|
|
`Data Protection Orchestration v1 <https://docs.openstack.org/api-ref/data-protection-orchestration/>`__
|
2019-07-16 16:22:44 +02:00
|
|
|
|
2019-07-22 20:34:44 +02:00
|
|
|
`Database Service API v1.0 <https://docs.openstack.org/api-ref/database/>`__
|
2019-07-16 16:22:44 +02:00
|
|
|
|
2019-07-22 20:34:44 +02:00
|
|
|
`Domain Name Server (DNS) API v2 <https://docs.openstack.org/api-ref/dns/>`__
|
2019-07-16 16:22:44 +02:00
|
|
|
|
2019-07-22 20:34:44 +02:00
|
|
|
`EC2 API Service <https://docs.openstack.org/api-ref/ec2-api/>`__
|
2019-07-16 16:22:44 +02:00
|
|
|
|
2019-07-22 20:34:44 +02:00
|
|
|
`Function Engine <https://docs.openstack.org/api-ref/function-engine/>`__
|
2019-07-16 16:22:44 +02:00
|
|
|
|
2019-07-22 20:34:44 +02:00
|
|
|
`Identity API v3 <https://docs.openstack.org/api-ref/identity/v3>`__
|
2019-07-16 16:22:44 +02:00
|
|
|
|
2019-07-22 20:34:44 +02:00
|
|
|
`Identity API v3 extensions <https://docs.openstack.org/api-ref/identity/v3-ext>`__
|
2019-07-16 16:22:44 +02:00
|
|
|
|
2019-07-22 20:34:44 +02:00
|
|
|
`Image service API v2 <https://docs.openstack.org/api-ref/image/v2>`__
|
2019-07-16 16:22:44 +02:00
|
|
|
|
|
|
|
`Key Manager API v1 <https://docs.openstack.org/barbican/latest/api/>`__
|
|
|
|
|
2019-07-22 20:34:44 +02:00
|
|
|
`Load Balancer API v2 <https://docs.openstack.org/api-ref/load-balancer/v2>`__
|
2019-07-16 16:22:44 +02:00
|
|
|
|
2019-07-22 20:34:44 +02:00
|
|
|
`Messaging API v2 <https://docs.openstack.org/api-ref/message>`__
|
2019-07-16 16:22:44 +02:00
|
|
|
|
2019-07-22 20:34:44 +02:00
|
|
|
`Networking API v2.0 <https://docs.openstack.org/api-ref/network/v2>`__
|
2019-07-16 16:22:44 +02:00
|
|
|
|
2019-07-22 20:34:44 +02:00
|
|
|
`NFV Orchestration API v1.0 <https://docs.openstack.org/api-ref/nfv-orchestration/v1/>`__
|
2019-07-16 16:22:44 +02:00
|
|
|
|
2019-07-22 20:34:44 +02:00
|
|
|
`Object Storage API v1 <https://docs.openstack.org/api-ref/object-store>`__
|
2019-07-16 16:22:44 +02:00
|
|
|
|
2019-07-22 20:34:44 +02:00
|
|
|
`Orchestration API v1 <https://docs.openstack.org/api-ref/orchestration/v1/>`__
|
2019-07-16 16:22:44 +02:00
|
|
|
|
2019-07-22 20:34:44 +02:00
|
|
|
`Placement API <https://docs.openstack.org/api-ref/placement/>`__ (microversions)
|
2019-07-16 16:22:44 +02:00
|
|
|
|
2019-07-22 20:34:44 +02:00
|
|
|
`Resource Optimization API v1 <https://docs.openstack.org/api-ref/resource-optimization>`__
|
2019-07-16 16:22:44 +02:00
|
|
|
|
2019-07-22 20:34:44 +02:00
|
|
|
`Search API v1 <https://docs.openstack.org/api-ref/search>`__
|
2019-07-16 16:22:44 +02:00
|
|
|
|
2019-07-22 20:34:44 +02:00
|
|
|
`Shared File Systems API v2 <https://docs.openstack.org/api-ref/shared-file-system>`__ (microversions)
|
2019-07-16 16:22:44 +02:00
|
|
|
|
|
|
|
.. 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
|
|
|
|
----------------------
|
|
|
|
|
|
|
|
|
|
|
|
Deprecated API versions
|
|
|
|
-----------------------
|
|
|
|
|
2019-07-22 20:34:44 +02:00
|
|
|
`Block Storage API v2 <https://docs.openstack.org/api-ref/block-storage/v2/>`__
|
2019-07-16 16:22:44 +02:00
|
|
|
|
|
|
|
.. 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.
|
|
|
|
|
2019-07-22 20:34:44 +02:00
|
|
|
`Identity API v2.0 extensions <https://docs.openstack.org/api-ref/identity/v2-ext>`__
|
2019-07-16 16:22:44 +02:00
|
|
|
|
|
|
|
.. todo: telemetry link
|
|
|
|
|
|
|
|
API quick-start examples
|
|
|
|
------------------------
|
|
|
|
|
|
|
|
With the `TryStack <https://www.openstack.org/software/start>`__ 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 :ref:`openstack_API_quick_guide`.
|
|
|
|
|
|
|
|
- **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 :ref:`client-intro`.
|
|
|
|
|
|
|
|
- **REST clients**
|
|
|
|
|
|
|
|
Both Mozilla and Google provide browser-based graphical interfaces
|
|
|
|
for REST. For Firefox, see
|
|
|
|
`RESTClient <https://addons.mozilla.org/en-US/firefox/addon/restclient/>`__.
|
|
|
|
For Chrome, see
|
|
|
|
`rest-client <https://code.google.com/archive/p/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 <https://docs.openstack.org/user-guide/sdk.html>`__ in the
|
|
|
|
*OpenStack End User Guide*.
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
:maxdepth: 2
|
|
|
|
|
|
|
|
api-quick-start
|