OpenStack API Documentation

Compute API v2 (SUPPORTED)

Block Storage API v2 (CURRENT)
Block Storage API v1 (DEPRECATED)
Compute API v2.1 (CURRENT)
Compute API v2 (SUPPORTED)
Compute API v2 extensions (SUPPORTED)
Data Processing v1.1 (CURRENT)
Database Service API v1.0 (CURRENT)
Identity API v3 (CURRENT)
Identity API v3 extensions (CURRENT)
Identity API v2.0 (SUPPORTED)
Identity admin API v2.0 (SUPPORTED)
Identity API v2.0 extensions (SUPPORTED)
Image service API v2 (CURRENT)
Image service API v1 (SUPPORTED)
Networking API v2.0 (CURRENT)
Networking API v2.0 extensions (CURRENT)
Object Storage API v1 (SUPPORTED)
Orchestration API v1 (CURRENT)
Shared File Systems API v2 (CURRENT)
Shared File Systems API v1 (SUPPORTED)
Telemetry API v2 (CURRENT)

Search on this page

Compute API v2 (SUPPORTED)

Launches virtual machines from images and images stored on persistent volumes. API v1.1 is identical to API v2.

Effective in the OpenStack Kilo release, XML support in requests and responses was removed for the Compute API v2.

The Compute API returns the 403 forbidden error code if you exceed your allotted quota for the operation.

API versions

Lists information for all API versions.

GET

List API versions

Lists information about all Compute API versions.

Normal response codes

200, 300

Error response codes

computeFault (400, 500, …), serviceUnavailable (503), badRequest (400), unauthorized (401), forbidden (403), badMethod (405), overLimit (413), itemNotFound (404)

Response parameters

Parameter	Style	Type	Description
X-Compute-Request-ID (Optional)	header	xsd:string	Returns a unique identifier to provide tracking for the request. The request ID that is associated with the request appears in the log lines for that request. By default, the middleware configuration ensures that the request ID appears in the log files.

{
    "versions": [
        {
            "id": "v2.0",
            "links": [
                {
                    "href": "openstack.example.com/v2/",
                    "rel": "self"
                }
            ],
            "status": "SUPPORTED",
            "version": "",
            "min_version": "",
            "updated": "2011-01-21T11:33:21Z"
        },
        {
            "id": "v2.1",
            "links": [
                {
                    "href": "openstack.example.com/v2.1/",
                    "rel": "self"
                }
            ],
            "status": "CURRENT",
            "version": "2.3",
            "min_version": "2.1",
            "updated": "2013-07-23T11:33:21Z"
        }
    ]
}

This operation does not accept a request body.

Limits

Gets rate and absolute limits.

An absolute limit value of -1 indicates that the absolute limit for the item is infinite.

GET

/v2/{tenant_id}/limits

List limits

Lists the current absolute and rate limits for a specified project.

An absolute limit value of -1 indicates that the absolute limit for the item is infinite.

Normal response codes

200, 203

Error response codes

computeFault (400, 500, …), serviceUnavailable (503), badRequest (400), unauthorized (401), forbidden (403), badMethod (405), overLimit (413)

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	csapi:UUID	The tenant ID in a multi-tenancy cloud.

Response parameters

Parameter	Style	Type	Description
X-Compute-Request-ID (Optional)	header	xsd:string	Returns a unique identifier to provide tracking for the request. The request ID that is associated with the request appears in the log lines for that request. By default, the middleware configuration ensures that the request ID appears in the log files.
maxImageMeta	plain	xsd:int	The maximum number of key-value pairs per image for the project.
maxPersonality	plain	xsd:int	The maximum number of file path and content pairs that can be supplied on server build and rebuild for the project.
maxPersonalitySize	plain	xsd:int	The maximum size, in bytes, for each personality file that is guaranteed to apply to all images in the project. Providers can set additional per-image personality limits.
maxSecurityGroupRules	plain	xsd:int	The maximum number of security group rules per security group for the project.
maxSecurityGroups	plain	xsd:int	The maximum number of security groups per server for the project.
maxServerMeta	plain	xsd:int	The maximum number of metadata key-value pairs that can be supplied per server for the project.
maxTotalCores	plain	xsd:int	The maximum number of cores for the project.
maxTotalFloatingIps	plain	xsd:int	The maximum number of floating IP addresses for the project. These IPs must be allocated from the central pool before you can use them. To allocate a floating IP to a project, see Associate floating IP addresses.
maxTotalInstances	plain	xsd:int	The maximum number of servers at any one time for the project.
maxTotalKeypairs	plain	xsd:int	The maximum number of key pairs per server for the project.
maxTotalRAMSize	plain	xsd:int	The maximum total amount of RAM, in MB, for all servers at any one time for the project.
maxServerGroups	plain	xsd:int	The maximum number of server groups per server for the project.
maxServerGroupMembers	plain	xsd:int	The maximum number of server group members per server group for the project.
rate	plain	xsd:dict	Current rate limits.

{
    "limits": {
        "absolute": {
            "maxImageMeta": 128,
            "maxPersonality": 5,
            "maxPersonalitySize": 10240,
            "maxSecurityGroupRules": 20,
            "maxSecurityGroups": 10,
            "maxServerMeta": 128,
            "maxTotalCores": 20,
            "maxTotalFloatingIps": 10,
            "maxTotalInstances": 10,
            "maxTotalKeypairs": 100,
            "maxTotalRAMSize": 51200,
            "maxServerGroups": 10,
            "maxServerGroupMembers": 10
        },
        "rate": [
            {
                "limit": [
                    {
                        "next-available": "2012-11-27T17:22:18Z",
                        "remaining": 120,
                        "unit": "MINUTE",
                        "value": 120,
                        "verb": "POST"
                    },
                    {
                        "next-available": "2012-11-27T17:22:18Z",
                        "remaining": 120,
                        "unit": "MINUTE",
                        "value": 120,
                        "verb": "PUT"
                    },
                    {
                        "next-available": "2012-11-27T17:22:18Z",
                        "remaining": 120,
                        "unit": "MINUTE",
                        "value": 120,
                        "verb": "DELETE"
                    }
                ],
                "regex": ".*",
                "uri": "*"
            },
            {
                "limit": [
                    {
                        "next-available": "2012-11-27T17:22:18Z",
                        "remaining": 120,
                        "unit": "MINUTE",
                        "value": 120,
                        "verb": "POST"
                    }
                ],
                "regex": "^/servers",
                "uri": "*/servers"
            },
            {
                "limit": [
                    {
                        "next-available": "2012-11-27T17:22:18Z",
                        "remaining": 120,
                        "unit": "MINUTE",
                        "value": 120,
                        "verb": "GET"
                    }
                ],
                "regex": ".*changes-since.*",
                "uri": "*changes-since*"
            },
            {
                "limit": [
                    {
                        "next-available": "2012-11-27T17:22:18Z",
                        "remaining": 12,
                        "unit": "MINUTE",
                        "value": 12,
                        "verb": "GET"
                    }
                ],
                "regex": "^/os-fping",
                "uri": "*/os-fping"
            }
        ]
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<limits xmlns:atom="www.w3.org/2005/Atom" xmlns="docs.openstack.org/common/api/v1.0">
  <rates>
    <rate regex=".*" uri="*">
      <limit next-available="2012-11-27T17:22:18Z" unit="MINUTE" verb="POST" remaining="120" value="120"/>
      <limit next-available="2012-11-27T17:22:18Z" unit="MINUTE" verb="PUT" remaining="120" value="120"/>
      <limit next-available="2012-11-27T17:22:18Z" unit="MINUTE" verb="DELETE" remaining="120" value="120"/>
    </rate>
    <rate regex="^/servers" uri="*/servers">
      <limit next-available="2012-11-27T17:22:18Z" unit="MINUTE" verb="POST" remaining="120" value="120"/>
    </rate>
    <rate regex=".*changes-since.*" uri="*changes-since*">
      <limit next-available="2012-11-27T17:22:18Z" unit="MINUTE" verb="GET" remaining="120" value="120"/>
    </rate>
    <rate regex="^/os-fping" uri="*/os-fping">
      <limit next-available="2012-11-27T17:22:18Z" unit="MINUTE" verb="GET" remaining="12" value="12"/>
    </rate>
  </rates>
  <absolute>
    <limit name="maxServerMeta" value="128"/>
    <limit name="maxPersonality" value="5"/>
    <limit name="maxImageMeta" value="128"/>
    <limit name="maxPersonalitySize" value="10240"/>
    <limit name="maxSecurityGroupRules" value="20"/>
    <limit name="maxTotalKeypairs" value="100"/>
    <limit name="maxSecurityGroups" value="10"/>
    <limit name="maxTotalCores" value="20"/>
    <limit name="maxTotalFloatingIps" value="10"/>
    <limit name="maxTotalInstances" value="10"/>
    <limit name="maxTotalRAMSize" value="51200"/>
    <limit name="maxServerGroups" value="10"/>
    <limit name="maxServerGroupMembers" value="10"/>
  </absolute>
</limits>

This operation does not accept a request body.

Extensions

Lists available Compute API v2 extensions and shows details for a specified extension.

GET

/v2/extensions

List extensions

Lists available extensions.

Normal response codes

200, 203

Error response codes

computeFault (400, 500, …), serviceUnavailable (503), badRequest (400), unauthorized (401), forbidden (403), badMethod (405), overLimit (413)

Response parameters

Parameter	Style	Type	Description
X-Compute-Request-ID (Optional)	header	xsd:string	Returns a unique identifier to provide tracking for the request. The request ID that is associated with the request appears in the log lines for that request. By default, the middleware configuration ensures that the request ID appears in the log files.
next (Optional)	plain	xsd:anyURI	Moves to the next metadata item.
previous (Optional)	plain	xsd:anyURI	Moves to the previous metadata item.

{
    "extensions": [
        {
            "alias": "NMN",
            "description": "Multiple network support.",
            "links": [],
            "name": "Multinic",
            "namespace": "docs.openstack.org/compute/ext/multinic/api/v1.1",
            "updated": "2011-06-09T00:00:00+00:00"
        },
        {
            "alias": "OS-DCF",
            "description": "Disk Management Extension.",
            "links": [],
            "name": "DiskConfig",
            "namespace": "docs.openstack.org/compute/ext/disk_config/api/v1.1",
            "updated": "2011-09-27T00:00:00+00:00"
        },
        {
            "alias": "OS-EXT-AZ",
            "description": "Extended Server Attributes support.",
            "links": [],
            "name": "ExtendedAvailabilityZone",
            "namespace": "docs.openstack.org/compute/ext/extended_availability_zone/api/v2",
            "updated": "2013-01-30T00:00:00+00:00"
        },
        {
            "alias": "OS-EXT-IMG-SIZE",
            "description": "Adds image size to image listings.",
            "links": [],
            "name": "ImageSize",
            "namespace": "docs.openstack.org/compute/ext/image_size/api/v1.1",
            "updated": "2013-02-19T00:00:00+00:00"
        },
        {
            "alias": "OS-EXT-IPS",
            "description": "Adds type parameter to the ip list.",
            "links": [],
            "name": "ExtendedIps",
            "namespace": "docs.openstack.org/compute/ext/extended_ips/api/v1.1",
            "updated": "2013-01-06T00:00:00+00:00"
        },
        {
            "alias": "OS-EXT-IPS-MAC",
            "description": "Adds mac address parameter to the ip list.",
            "links": [],
            "name": "ExtendedIpsMac",
            "namespace": "docs.openstack.org/compute/ext/extended_ips_mac/api/v1.1",
            "updated": "2013-03-07T00:00:00+00:00"
        },
        {
            "alias": "OS-EXT-SRV-ATTR",
            "description": "Extended Server Attributes support.",
            "links": [],
            "name": "ExtendedServerAttributes",
            "namespace": "docs.openstack.org/compute/ext/extended_status/api/v1.1",
            "updated": "2011-11-03T00:00:00+00:00"
        },
        {
            "alias": "OS-EXT-STS",
            "description": "Extended Status support.",
            "links": [],
            "name": "ExtendedStatus",
            "namespace": "docs.openstack.org/compute/ext/extended_status/api/v1.1",
            "updated": "2011-11-03T00:00:00+00:00"
        },
        {
            "alias": "OS-EXT-VIF-NET",
            "description": "Adds network id parameter to the virtual interface list.",
            "links": [],
            "name": "ExtendedVIFNet",
            "namespace": "docs.openstack.org/compute/ext/extended-virtual-interfaces-net/api/v1.1",
            "updated": "2013-03-07T00:00:00+00:00"
        },
        {
            "alias": "OS-FLV-DISABLED",
            "description": "Support to show the disabled status of a flavor.",
            "links": [],
            "name": "FlavorDisabled",
            "namespace": "docs.openstack.org/compute/ext/flavor_disabled/api/v1.1",
            "updated": "2012-08-29T00:00:00+00:00"
        },
        {
            "alias": "OS-FLV-EXT-DATA",
            "description": "Provide additional data for flavors.",
            "links": [],
            "name": "FlavorExtraData",
            "namespace": "docs.openstack.org/compute/ext/flavor_extra_data/api/v1.1",
            "updated": "2011-09-14T00:00:00+00:00"
        },
        {
            "alias": "OS-SCH-HNT",
            "description": "Pass arbitrary key/value pairs to the scheduler.",
            "links": [],
            "name": "SchedulerHints",
            "namespace": "docs.openstack.org/compute/ext/scheduler-hints/api/v2",
            "updated": "2011-07-19T00:00:00+00:00"
        },
        {
            "alias": "OS-SRV-USG",
            "description": "Adds launched_at and terminated_at on Servers.",
            "links": [],
            "name": "ServerUsage",
            "namespace": "docs.openstack.org/compute/ext/server_usage/api/v1.1",
            "updated": "2013-04-29T00:00:00+00:00"
        },
        {
            "alias": "os-admin-actions",
            "description": "Enable admin-only server actions\n\n    Actions include: pause, unpause, suspend, resume, migrate,\n    resetNetwork, injectNetworkInfo, lock, unlock, createBackup\n    ",
            "links": [],
            "name": "AdminActions",
            "namespace": "docs.openstack.org/compute/ext/admin-actions/api/v1.1",
            "updated": "2011-09-20T00:00:00+00:00"
        },
        {
            "alias": "os-agents",
            "description": "Agents support.",
            "links": [],
            "name": "Agents",
            "namespace": "docs.openstack.org/compute/ext/