OpenStack API Documentation

Compute API v2 extensions (SUPPORTED)

Extensions add features, MIME types, actions, states, headers, parameters, and resources to the core Compute API without requiring a version change.

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.

Servers with block device mapping format (servers)

Creates a server with a block device mapping.

GET

/v2/{tenant_id}/servers

List servers

Lists IDs, names, and links for all servers.

Normal response codes

200, 203

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The tenant ID in a multi-tenancy cloud.
changes-since (Optional)	query	xsd:dateTime	A time/date stamp for when the server last changed status.
image (Optional)	query	csapi:UUID	The UUID for the image.
flavor (Optional)	query	csapi:UUID	The UUID for the specific flavor, which is a combination of memory, disk size, and CPUs.
name (Optional)	query	regexp	Name of the server as a string. Can be queried with regular expressions. The regular expression `?name=bob` returns both bob and bobb. If you must match on only bob, you can use a regular expression that matches the syntax of the underlying database server that is implemented for Compute, such as MySQL or PostgreSQL.
status (Optional)	query	csapi:ServerStatus	Value of the status of the server so that you can filter on "ACTIVE" for example.
host (Optional)	query	xsd:string	Name of the host as a string.
limit (Optional)	query	xsd:int	Requests a specified page size of returned items from the query. Returns a number of items up to the specified limit value. Use the `limit` parameter to make an initial limited request and use the ID of the last-seen item from the response as the `marker` parameter value in a subsequent limited request.
marker (Optional)	query	xsd:string	Specifies the ID of the last-seen item. Use the `limit` parameter to make an initial limited request and use the ID of the last-seen item from the response as the `marker` parameter value in a subsequent limited request.

Response parameters

Parameter	Style	Type	Description
servers	plain	csapi:ServersWithOnlyIDsNamesLinks	List of servers.
next (Optional)	plain	xsd:anyURI	Moves to the next item in the list.
previous (Optional)	plain	xsd:anyURI	Moves to the previous item in the list.

{
    "servers": [
        {
            "id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
            "links": [
                {
                    "href": "http://openstack.example.com/v2/openstack/servers/616fb98f-46ca-475e-917e-2563e5a8cd19",
                    "rel": "self"
                },
                {
                    "href": "http://openstack.example.com/openstack/servers/616fb98f-46ca-475e-917e-2563e5a8cd19",
                    "rel": "bookmark"
                }
            ],
            "name": "new-server-test"
        }
    ]
}

<?xml version='1.0' encoding='UTF-8'?>
<servers xmlns:atom="http://www.w3.org/2005/Atom" xmlns="http://docs.openstack.org/compute/api/v1.1">
  <server name="new-server-test" id="b626796d-d585-4874-b178-78c65289bba4">
    <atom:link href="http://openstack.example.com/v2/openstack/servers/b626796d-d585-4874-b178-78c65289bba4" rel="self"/>
    <atom:link href="http://openstack.example.com/openstack/servers/b626796d-d585-4874-b178-78c65289bba4" rel="bookmark"/>
  </server>
</servers>

POST

/v2/{tenant_id}/servers

Create server

Creates a server with a block device mapping.

Normal response codes

202

Error response codes

computeFault (400, 500, …), computeFault (400, 500, …), computeFault (400, 500, …), serviceUnavailable (503), badRequest (400), unauthorized (401), forbidden (403), badMethod (405), overLimit (413), itemNotFound (404), UnprocessableEntity (422), serviceUnavailable (503), badRequest (400), unauthorized (401), forbidden (403), badMethod (405), overLimit (413), itemNotFound (404), serviceUnavailable (503), badRequest (400), unauthorized (401), forbidden (403), badMethod (405), overLimit (413), itemNotFound (404), badMediaType (415), NetworkNotFound (400), serverCapacityUnavailable (503)

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The tenant ID in a multi-tenancy cloud.
security_groups (Optional)	plain	xsd:string	One or more security groups. Specify the name of the security group in the `name` attribute. If you omit this attribute, the server is created in the `default` security group.
user_data (Optional)	plain	xsd:string	Configuration information or scripts to use upon launch. Must be Base64 encoded.
availability_zone (Optional)	plain	xsd:string	The availability zone in which to launch the server.
server	plain	csapi:ServerForCreate	server.
imageRef	plain	csapi:string	The image reference for the desired image for your server instance. Specify as an ID or full URL.
flavorRef	plain	csapi:string	The flavor reference for the desired flavor for your server instance. Specify as an ID or full URL.
networks (Optional)	plain	xsd:string	A `networks` object. By default, the server instance is provisioned with all isolated networks for the tenant. Optionally, you can create one or more NICs on the server. To provision the server instance with a NIC for a network, specify the UUID of the network in the `uuid` attribute in a `networks` object. To provision the server instance with a NIC for an already existing port, specify the port-id in the `port` attribute in a `networks` object. You can specify multiple NICs on the server.
uuid (Optional)	plain	xsd:string	To provision the server instance with a NIC for a network, specify the UUID of the network in the `uuid` attribute in a `networks` object. Required if you omit the `port` attribute.
port (Optional)	plain	xsd:string	To provision the server instance with a NIC for an already existing port, specify the port-id in the `port` attribute in a `networks` object. The port status must be `DOWN`. Required if you omit the `uuid` attribute.
fixed_ip (Optional)	plain	xsd:string	A fixed IPv4 address for the NIC. Valid with a `neutron` or `nova-networks` network.
name	plain	csapi:string	The server name.
metadata (Optional)	plain	csapi:string	Metadata key and value pairs. The maximum size of the metadata key and value is 255 bytes each.
personality (Optional)	plain	csapi:string	File path and contents (text only) to inject into the server at launch. The maximum size of the file path data is 255 bytes. The maximum limit refers to the number of bytes in the decoded data and not the number of characters in the encoded data.
block_device_mapping_v2 (Optional)	plain	csapi:string	Enables booting the server from a volume when additional parameters are given. If specified, the volume status must be `available`, and the volume `attach_status` in the OpenStack Block Storage database must be `detached`.
device_name	plain	csapi:string	Describes a path to the device for the volume you want to use to boot the server.
source_type	plain	csapi:string	The source type for the volume. A valid value is `blank`, `snapshot`, `volume`, or `image`.
destination_type (Optional)	plain	csapi:string	Defines where the volume comes from. A valid value is `local` or `volume`.
delete_on_termination	plain	csapi:string	To delete the boot volume when the server stops, specify `true`. Otherwise, specify `false`.
guest_format	plain	csapi:string	Specifies the guest server disk file system format, such as `ephemeral` or `swap`.
boot_index	plain	csapi:string	The boot order of the device. Use `-1` for the boot volume. Use `0` for an attached volume.
config_drive (Optional)	plain	xsd:boolean	Enables metadata injection in a server through a configuration drive. Specify `true` to enable a configuration drive. Otherwise, specify `false`.
key_name (Optional)	plain	xsd:string	Key pair name.

Response parameters

Parameter	Style	Type	Description
security_groups (Optional)	plain	xsd:string	One or more security groups. Specify the name of the security group in the `name` attribute. If you omit this attribute, the server is created in the `default` security group.
user_data (Optional)	plain	xsd:string	Configuration information or scripts to use upon launch. Must be Base64 encoded.
availability_zone (Optional)	plain	xsd:string	The availability zone in which to launch the server.
server	plain	csapi:ServerForCreate	server.
imageRef	plain	csapi:string	The image reference for the desired image for your server instance. Specify as an ID or full URL.
flavorRef	plain	csapi:string	The flavor reference for the desired flavor for your server instance. Specify as an ID or full URL.
networks (Optional)	plain	xsd:string	A `networks` object. By default, the server instance is provisioned with all isolated networks for the tenant. Optionally, you can create one or more NICs on the server. To provision the server instance with a NIC for a network, specify the UUID of the network in the `uuid` attribute in a `networks` object. To provision the server instance with a NIC for an already existing port, specify the port-id in the `port` attribute in a `networks` object. You can specify multiple NICs on the server.
uuid (Optional)	plain	xsd:string	To provision the server instance with a NIC for a network, specify the UUID of the network in the `uuid` attribute in a `networks` object. Required if you omit the `port` attribute.
port (Optional)	plain	xsd:string	To provision the server instance with a NIC for an already existing port, specify the port-id in the `port` attribute in a `networks` object. The port status must be `DOWN`. Required if you omit the `uuid` attribute.
fixed_ip (Optional)	plain	xsd:string	A fixed IPv4 address for the NIC. Valid with a `neutron` or `nova-networks` network.
name	plain	csapi:string	The server name.
metadata (Optional)	plain	csapi:string	Metadata key and value pairs. The maximum size of the metadata key and value is 255 bytes each.
personality (Optional)	plain	csapi:string	File path and contents (text only) to inject into the server at launch. The maximum size of the file path data is 255 bytes. The maximum limit refers to the number of bytes in the decoded data and not the number of characters in the encoded data.
block_device_mapping_v2 (Optional)	plain	csapi:string	Enables booting the server from a volume when additional parameters are given. If specified, the volume status must be `available`, and the volume `attach_status` in the OpenStack Block Storage database must be `detached`.
device_name	plain	csapi:string	Describes a path to the device for the volume you want to use to boot the server.
source_type	plain	csapi:string	The source type for the volume. A valid value is `blank`, `snapshot`, `volume`, or `image`.
destination_type (Optional)	plain	csapi:string	Defines where the volume comes from. A valid value is `local` or `volume`.
delete_on_termination	plain	csapi:string	To delete the boot volume when the server stops, specify `true`. Otherwise, specify `false`.
guest_format	plain	csapi:string	Specifies the guest server disk file system format, such as `ephemeral` or `swap`.
boot_index	plain	csapi:string	The boot order of the device. Use `-1` for the boot volume. Use `0` for an attached volume.
config_drive (Optional)	plain	xsd:boolean	Enables metadata injection in a server through a configuration drive. Specify `true` to enable a configuration drive. Otherwise, specify `false`.
key_name (Optional)	plain	xsd:string	Key pair name.

{
    "server": {
        "name": "new-server-test",
        "imageRef": "http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b",
        "flavorRef": "http://openstack.example.com/openstack/flavors/1",
        "metadata": {
            "My Server Name": "Apache1"
        },
        "personality": [
            {
                "path": "/etc/banner.txt",
                "contents": "ICAgICAgDQoiQSBjbG91ZCBkb2VzIG5vdCBrbm93IHdoeSBpdCBtb3ZlcyBpbiBqdXN0IHN1Y2ggYSBkaXJlY3Rpb24gYW5kIGF0IHN1Y2ggYSBzcGVlZC4uLkl0IGZlZWxzIGFuIGltcHVsc2lvbi4uLnRoaXMgaXMgdGhlIHBsYWNlIHRvIGdvIG5vdy4gQnV0IHRoZSBza3kga25vd3MgdGhlIHJlYXNvbnMgYW5kIHRoZSBwYXR0ZXJucyBiZWhpbmQgYWxsIGNsb3VkcywgYW5kIHlvdSB3aWxsIGtub3csIHRvbywgd2hlbiB5b3UgbGlmdCB5b3Vyc2VsZiBoaWdoIGVub3VnaCB0byBzZWUgYmV5b25kIGhvcml6b25zLiINCg0KLVJpY2hhcmQgQmFjaA=="
            }
        ],
        "block_device_mapping_v2": [
            {
                "device_name": "/dev/sdb1",
                "source_type": "blank",
                "destination_type": "local",
                "delete_on_termination": "True",
                "guest_format": "swap",
                "boot_index": "-1"
            },
            {
                "device_name": "/dev/sda1",
                "source_type": "volume",
                "destination_type": "volume",
                "uuid": "fake-volume-id-1",
                "boot_index": "0"
            }
        ]
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<server xmlns="http://docs.openstack.org/compute/api/v1.1" imageRef="http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b" flavorRef="http://openstack.example.com/openstack/flavors/1" name="new-server-test">
  <metadata>
    <meta key="My Server Name">Apache1</meta>
  </metadata>
  <personality>
    <file path="/etc/banner.txt">
        ICAgICAgDQoiQSBjbG91ZCBkb2VzIG5vdCBrbm93IHdoeSBp
        dCBtb3ZlcyBpbiBqdXN0IHN1Y2ggYSBkaXJlY3Rpb24gYW5k
        IGF0IHN1Y2ggYSBzcGVlZC4uLkl0IGZlZWxzIGFuIGltcHVs
        c2lvbi4uLnRoaXMgaXMgdGhlIHBsYWNlIHRvIGdvIG5vdy4g
        QnV0IHRoZSBza3kga25vd3MgdGhlIHJlYXNvbnMgYW5kIHRo
        ZSBwYXR0ZXJucyBiZWhpbmQgYWxsIGNsb3VkcywgYW5kIHlv
        dSB3aWxsIGtub3csIHRvbywgd2hlbiB5b3UgbGlmdCB5b3Vy
        c2VsZiBoaWdoIGVub3VnaCB0byBzZWUgYmV5b25kIGhvcml6
        b25zLiINCg0KLVJpY2hhcmQgQmFjaA==
    </file>
  </personality>
  <block_device_mapping_v2>
    <mapping device_name="/dev/sdb1" source_type="blank" destination_type="local" delete_on_termination="True" guest_format="swap" boot_index="-1"></mapping>
    <mapping device_name="/dev/sda1" source_type="volume" destination_type="volume" uuid="fake-volume-id-1" boot_index="0"></mapping>
  </block_device_mapping_v2>
</server>

{
    "server": {
        "adminPass": "N4x7wFX6iN8D",
        "id": "babd1af0-4fc6-4529-b32f-aad69811ccf5",
        "links": [
            {
                "href": "http://openstack.example.com/v2/openstack/servers/babd1af0-4fc6-4529-b32f-aad69811ccf5",
                "rel": "self"
            },
            {
                "href": "http://openstack.example.com/openstack/servers/babd1af0-4fc6-4529-b32f-aad69811ccf5",
                "rel": "bookmark"
            }
        ]
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<server xmlns:atom="http://www.w3.org/2005/Atom" xmlns="http://docs.openstack.org/compute/api/v1.1" id="fdbce07b-097e-4ab1-8141-b1c847861aa1" adminPass="zA62GVkFvN74">
  <metadata/>
  <atom:link href="http://openstack.example.com/v2/openstack/servers/fdbce07b-097e-4ab1-8141-b1c847861aa1" rel="self"/>
  <atom:link href="http://openstack.example.com/openstack/servers/fdbce07b-097e-4ab1-8141-b1c847861aa1" rel="bookmark"/>
</server>

Servers with configuration drive (servers)

Extends servers and images with a configuration drive.

POST

/v2/{tenant_id}/servers

Create server with configuration drive

Creates a server with the configuration drive extended attribute.

Normal response codes

202

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
security_groups (Optional)	plain	xsd:string	One or more security groups. Specify the name of the security group in the `name` attribute. If you omit this attribute, the server is created in the `default` security group.
user_data (Optional)	plain	xsd:string	Configuration information or scripts to use upon launch. Must be Base64 encoded.
availability_zone (Optional)	plain	xsd:string	The availability zone in which to launch the server.
server	plain	csapi:ServerForCreate	server.
imageRef	plain	csapi:string	The image reference for the desired image for your server instance. Specify as an ID or full URL.
flavorRef	plain	csapi:string	The flavor reference for the desired flavor for your server instance. Specify as an ID or full URL.
networks (Optional)	plain	xsd:string	A `networks` object. By default, the server instance is provisioned with all isolated networks for the tenant. Optionally, you can create one or more NICs on the server. To provision the server instance with a NIC for a network, specify the UUID of the network in the `uuid` attribute in a `networks` object. To provision the server instance with a NIC for an already existing port, specify the port-id in the `port` attribute in a `networks` object. You can specify multiple NICs on the server.
uuid (Optional)	plain	xsd:string	To provision the server instance with a NIC for a network, specify the UUID of the network in the `uuid` attribute in a `networks` object. Required if you omit the `port` attribute.
port (Optional)	plain	xsd:string	To provision the server instance with a NIC for an already existing port, specify the port-id in the `port` attribute in a `networks` object. The port status must be `DOWN`. Required if you omit the `uuid` attribute.
fixed_ip (Optional)	plain	xsd:string	A fixed IPv4 address for the NIC. Valid with a `neutron` or `nova-networks` network.
name	plain	csapi:string	The server name.
metadata (Optional)	plain	csapi:string	Metadata key and value pairs. The maximum size of the metadata key and value is 255 bytes each.
personality (Optional)	plain	csapi:string	File path and contents (text only) to inject into the server at launch. The maximum size of the file path data is 255 bytes. The maximum limit refers to the number of bytes in the decoded data and not the number of characters in the encoded data.
block_device_mapping_v2 (Optional)	plain	csapi:string	Enables booting the server from a volume when additional parameters are given. If specified, the volume status must be `available`, and the volume `attach_status` in the OpenStack Block Storage database must be `detached`.
device_name	plain	csapi:string	Describes a path to the device for the volume you want to use to boot the server.
source_type	plain	csapi:string	The source type for the volume. A valid value is `blank`, `snapshot`, `volume`, or `image`.
destination_type (Optional)	plain	csapi:string	Defines where the volume comes from. A valid value is `local` or `volume`.
delete_on_termination	plain	csapi:string	To delete the boot volume when the server stops, specify `true`. Otherwise, specify `false`.
guest_format	plain	csapi:string	Specifies the guest server disk file system format, such as `ephemeral` or `swap`.
boot_index	plain	csapi:string	The boot order of the device. Use `-1` for the boot volume. Use `0` for an attached volume.
config_drive (Optional)	plain	xsd:boolean	Enables metadata injection in a server through a configuration drive. Specify `true` to enable a configuration drive. Otherwise, specify `false`.
key_name (Optional)	plain	xsd:string	Key pair name.

Response parameters

Parameter	Style	Type	Description
security_groups (Optional)	plain	xsd:string	One or more security groups. Specify the name of the security group in the `name` attribute. If you omit this attribute, the server is created in the `default` security group.
user_data (Optional)	plain	xsd:string	Configuration information or scripts to use upon launch. Must be Base64 encoded.
availability_zone (Optional)	plain	xsd:string	The availability zone in which to launch the server.
server	plain	csapi:ServerForCreate	server.
imageRef	plain	csapi:string	The image reference for the desired image for your server instance. Specify as an ID or full URL.
flavorRef	plain	csapi:string	The flavor reference for the desired flavor for your server instance. Specify as an ID or full URL.
networks (Optional)	plain	xsd:string	A `networks` object. By default, the server instance is provisioned with all isolated networks for the tenant. Optionally, you can create one or more NICs on the server. To provision the server instance with a NIC for a network, specify the UUID of the network in the `uuid` attribute in a `networks` object. To provision the server instance with a NIC for an already existing port, specify the port-id in the `port` attribute in a `networks` object. You can specify multiple NICs on the server.
uuid (Optional)	plain	xsd:string	To provision the server instance with a NIC for a network, specify the UUID of the network in the `uuid` attribute in a `networks` object. Required if you omit the `port` attribute.
port (Optional)	plain	xsd:string	To provision the server instance with a NIC for an already existing port, specify the port-id in the `port` attribute in a `networks` object. The port status must be `DOWN`. Required if you omit the `uuid` attribute.
fixed_ip (Optional)	plain	xsd:string	A fixed IPv4 address for the NIC. Valid with a `neutron` or `nova-networks` network.
name	plain	csapi:string	The server name.
metadata (Optional)	plain	csapi:string	Metadata key and value pairs. The maximum size of the metadata key and value is 255 bytes each.
personality (Optional)	plain	csapi:string	File path and contents (text only) to inject into the server at launch. The maximum size of the file path data is 255 bytes. The maximum limit refers to the number of bytes in the decoded data and not the number of characters in the encoded data.
block_device_mapping_v2 (Optional)	plain	csapi:string	Enables booting the server from a volume when additional parameters are given. If specified, the volume status must be `available`, and the volume `attach_status` in the OpenStack Block Storage database must be `detached`.
device_name	plain	csapi:string	Describes a path to the device for the volume you want to use to boot the server.
source_type	plain	csapi:string	The source type for the volume. A valid value is `blank`, `snapshot`, `volume`, or `image`.
destination_type (Optional)	plain	csapi:string	Defines where the volume comes from. A valid value is `local` or `volume`.
delete_on_termination	plain	csapi:string	To delete the boot volume when the server stops, specify `true`. Otherwise, specify `false`.
guest_format	plain	csapi:string	Specifies the guest server disk file system format, such as `ephemeral` or `swap`.
boot_index	plain	csapi:string	The boot order of the device. Use `-1` for the boot volume. Use `0` for an attached volume.
config_drive (Optional)	plain	xsd:boolean	Enables metadata injection in a server through a configuration drive. Specify `true` to enable a configuration drive. Otherwise, specify `false`.
key_name (Optional)	plain	xsd:string	Key pair name.

{
    "server": {
        "name": "new-server-test",
        "imageRef": "http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b",
        "flavorRef": "http://openstack.example.com/openstack/flavors/1",
        "metadata": {
            "My Server Name": "Apache1"
        },
        "personality": [
            {
                "path": "/etc/banner.txt",
                "contents": "ICAgICAgDQoiQSBjbG91ZCBkb2VzIG5vdCBrbm93IHdoeSBpdCBtb3ZlcyBpbiBqdXN0IHN1Y2ggYSBkaXJlY3Rpb24gYW5kIGF0IHN1Y2ggYSBzcGVlZC4uLkl0IGZlZWxzIGFuIGltcHVsc2lvbi4uLnRoaXMgaXMgdGhlIHBsYWNlIHRvIGdvIG5vdy4gQnV0IHRoZSBza3kga25vd3MgdGhlIHJlYXNvbnMgYW5kIHRoZSBwYXR0ZXJucyBiZWhpbmQgYWxsIGNsb3VkcywgYW5kIHlvdSB3aWxsIGtub3csIHRvbywgd2hlbiB5b3UgbGlmdCB5b3Vyc2VsZiBoaWdoIGVub3VnaCB0byBzZWUgYmV5b25kIGhvcml6b25zLiINCg0KLVJpY2hhcmQgQmFjaA=="
            }
        ]
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<server xmlns="http://docs.openstack.org/compute/api/v1.1" imageRef="http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b" flavorRef="http://openstack.example.com/openstack/flavors/1" name="new-server-test">
  <metadata>
    <meta key="My Server Name">Apache1</meta>
  </metadata>
  <personality>
    <file path="/etc/banner.txt">
        ICAgICAgDQoiQSBjbG91ZCBkb2VzIG5vdCBrbm93IHdoeSBp
        dCBtb3ZlcyBpbiBqdXN0IHN1Y2ggYSBkaXJlY3Rpb24gYW5k
        IGF0IHN1Y2ggYSBzcGVlZC4uLkl0IGZlZWxzIGFuIGltcHVs
        c2lvbi4uLnRoaXMgaXMgdGhlIHBsYWNlIHRvIGdvIG5vdy4g
        QnV0IHRoZSBza3kga25vd3MgdGhlIHJlYXNvbnMgYW5kIHRo
        ZSBwYXR0ZXJucyBiZWhpbmQgYWxsIGNsb3VkcywgYW5kIHlv
        dSB3aWxsIGtub3csIHRvbywgd2hlbiB5b3UgbGlmdCB5b3Vy
        c2VsZiBoaWdoIGVub3VnaCB0byBzZWUgYmV5b25kIGhvcml6
        b25zLiINCg0KLVJpY2hhcmQgQmFjaA==
    </file>
  </personality>
</server>

{
    "server": {
        "adminPass": "am5LKVsBVQ4s",
        "id": "58da039c-dc81-4d8f-8688-a2f819e2f750",
        "links": [
            {
                "href": "http://openstack.example.com/v2/openstack/servers/58da039c-dc81-4d8f-8688-a2f819e2f750",
                "rel": "self"
            },
            {
                "href": "http://openstack.example.com/openstack/servers/58da039c-dc81-4d8f-8688-a2f819e2f750",
                "rel": "bookmark"
            }
        ]
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<server xmlns:atom="http://www.w3.org/2005/Atom" xmlns="http://docs.openstack.org/compute/api/v1.1" id="00bba779-f8ae-403e-901d-1af18bcb9187" adminPass="XJqvFkH62TZh">
  <metadata/>
  <atom:link href="http://openstack.example.com/v2/openstack/servers/00bba779-f8ae-403e-901d-1af18bcb9187" rel="self"/>
  <atom:link href="http://openstack.example.com/openstack/servers/00bba779-f8ae-403e-901d-1af18bcb9187" rel="bookmark"/>
</server>

GET

/v2/{tenant_id}/servers/{server_id}

Get server information with configuration drive

Shows information for a specified server including the configuration drive extended attribute.

Normal response codes

202

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
server_id	URI	csapi:uuid	The UUID for the server of interest to you.

Response parameters

Parameter	Style	Type	Description
security_groups (Optional)	plain	xsd:string	One or more security groups. Specify the name of the security group in the `name` attribute. If you omit this attribute, the server is created in the `default` security group.
user_data (Optional)	plain	xsd:string	Configuration information or scripts to use upon launch. Must be Base64 encoded.
availability_zone (Optional)	plain	xsd:string	The availability zone in which to launch the server.
server	plain	csapi:ServerForCreate	server.
imageRef	plain	csapi:string	The image reference for the desired image for your server instance. Specify as an ID or full URL.
flavorRef	plain	csapi:string	The flavor reference for the desired flavor for your server instance. Specify as an ID or full URL.
networks (Optional)	plain	xsd:string	A `networks` object. By default, the server instance is provisioned with all isolated networks for the tenant. Optionally, you can create one or more NICs on the server. To provision the server instance with a NIC for a network, specify the UUID of the network in the `uuid` attribute in a `networks` object. To provision the server instance with a NIC for an already existing port, specify the port-id in the `port` attribute in a `networks` object. You can specify multiple NICs on the server.
uuid (Optional)	plain	xsd:string	To provision the server instance with a NIC for a network, specify the UUID of the network in the `uuid` attribute in a `networks` object. Required if you omit the `port` attribute.
port (Optional)	plain	xsd:string	To provision the server instance with a NIC for an already existing port, specify the port-id in the `port` attribute in a `networks` object. The port status must be `DOWN`. Required if you omit the `uuid` attribute.
fixed_ip (Optional)	plain	xsd:string	A fixed IPv4 address for the NIC. Valid with a `neutron` or `nova-networks` network.
name	plain	csapi:string	The server name.
metadata (Optional)	plain	csapi:string	Metadata key and value pairs. The maximum size of the metadata key and value is 255 bytes each.
personality (Optional)	plain	csapi:string	File path and contents (text only) to inject into the server at launch. The maximum size of the file path data is 255 bytes. The maximum limit refers to the number of bytes in the decoded data and not the number of characters in the encoded data.
block_device_mapping_v2 (Optional)	plain	csapi:string	Enables booting the server from a volume when additional parameters are given. If specified, the volume status must be `available`, and the volume `attach_status` in the OpenStack Block Storage database must be `detached`.
device_name	plain	csapi:string	Describes a path to the device for the volume you want to use to boot the server.
source_type	plain	csapi:string	The source type for the volume. A valid value is `blank`, `snapshot`, `volume`, or `image`.
destination_type (Optional)	plain	csapi:string	Defines where the volume comes from. A valid value is `local` or `volume`.
delete_on_termination	plain	csapi:string	To delete the boot volume when the server stops, specify `true`. Otherwise, specify `false`.
guest_format	plain	csapi:string	Specifies the guest server disk file system format, such as `ephemeral` or `swap`.
boot_index	plain	csapi:string	The boot order of the device. Use `-1` for the boot volume. Use `0` for an attached volume.
config_drive (Optional)	plain	xsd:boolean	Enables metadata injection in a server through a configuration drive. Specify `true` to enable a configuration drive. Otherwise, specify `false`.
key_name (Optional)	plain	xsd:string	Key pair name.

{
    "server": {
        "accessIPv4": "",
        "accessIPv6": "",
        "addresses": {
            "private": [
                {
                    "addr": "192.168.0.3",
                    "version": 4
                }
            ]
        },
        "config_drive": "",
        "created": "2013-02-04T13:17:50Z",
        "flavor": {
            "id": "1",
            "links": [
                {
                    "href": "http://openstack.example.com/openstack/flavors/1",
                    "rel": "bookmark"
                }
            ]
        },
        "hostId": "8725fb615b191d8249a40f3e90d1efde88d914412e4edb2719176afd",
        "id": "dd3b0715-a3fc-43d8-bbd2-2720beb226fb",
        "image": {
            "id": "70a599e0-31e7-49b7-b260-868f441e862b",
            "links": [
                {
                    "href": "http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b",
                    "rel": "bookmark"
                }
            ]
        },
        "links": [
            {
                "href": "http://openstack.example.com/v2/openstack/servers/dd3b0715-a3fc-43d8-bbd2-2720beb226fb",
                "rel": "self"
            },
            {
                "href": "http://openstack.example.com/openstack/servers/dd3b0715-a3fc-43d8-bbd2-2720beb226fb",
                "rel": "bookmark"
            }
        ],
        "metadata": {
            "My Server Name": "Apache1"
        },
        "name": "new-server-test",
        "progress": 0,
        "status": "ACTIVE",
        "tenant_id": "openstack",
        "updated": "2013-02-04T13:17:51Z",
        "user_id": "fake"
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<server xmlns:atom="http://www.w3.org/2005/Atom" xmlns="http://docs.openstack.org/compute/api/v1.1" status="ACTIVE" updated="2013-02-04T13:26:10Z" hostId="7a8c3fc15db5d6227d26d5ef559b77c880bbe99da5ce5f5871fc113e" name="new-server-test" created="2013-02-04T13:26:09Z" userId="fake" tenantId="openstack" accessIPv4="" accessIPv6="" progress="0" id="3b9e0572-3d7b-4e6f-9c21-35ad0f7dbf95" config_drive="">
  <image id="70a599e0-31e7-49b7-b260-868f441e862b">
    <atom:link href="http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b" rel="bookmark"/>
  </image>
  <flavor id="1">
    <atom:link href="http://openstack.example.com/openstack/flavors/1" rel="bookmark"/>
  </flavor>
  <metadata>
    <meta key="My Server Name">Apache1</meta>
  </metadata>
  <addresses>
    <network id="private">
      <ip version="4" addr="192.168.0.3"/>
    </network>
  </addresses>
  <atom:link href="http://openstack.example.com/v2/openstack/servers/3b9e0572-3d7b-4e6f-9c21-35ad0f7dbf95" rel="self"/>
  <atom:link href="http://openstack.example.com/openstack/servers/3b9e0572-3d7b-4e6f-9c21-35ad0f7dbf95" rel="bookmark"/>
</server>

This operation does not accept a request body.

GET

/v2/{tenant_id}/servers/{server_id}/detail

Get server details with configuration drive

Lists details for all servers including the configuration drive extended attribute.

Normal response codes

202

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
server_id	URI	csapi:uuid	The UUID for the server of interest to you.

Response parameters

Parameter	Style	Type	Description
security_groups (Optional)	plain	xsd:string	One or more security groups. Specify the name of the security group in the `name` attribute. If you omit this attribute, the server is created in the `default` security group.
user_data (Optional)	plain	xsd:string	Configuration information or scripts to use upon launch. Must be Base64 encoded.
availability_zone (Optional)	plain	xsd:string	The availability zone in which to launch the server.
server	plain	csapi:ServerForCreate	server.
imageRef	plain	csapi:string	The image reference for the desired image for your server instance. Specify as an ID or full URL.
flavorRef	plain	csapi:string	The flavor reference for the desired flavor for your server instance. Specify as an ID or full URL.
networks (Optional)	plain	xsd:string	A `networks` object. By default, the server instance is provisioned with all isolated networks for the tenant. Optionally, you can create one or more NICs on the server. To provision the server instance with a NIC for a network, specify the UUID of the network in the `uuid` attribute in a `networks` object. To provision the server instance with a NIC for an already existing port, specify the port-id in the `port` attribute in a `networks` object. You can specify multiple NICs on the server.
uuid (Optional)	plain	xsd:string	To provision the server instance with a NIC for a network, specify the UUID of the network in the `uuid` attribute in a `networks` object. Required if you omit the `port` attribute.
port (Optional)	plain	xsd:string	To provision the server instance with a NIC for an already existing port, specify the port-id in the `port` attribute in a `networks` object. The port status must be `DOWN`. Required if you omit the `uuid` attribute.
fixed_ip (Optional)	plain	xsd:string	A fixed IPv4 address for the NIC. Valid with a `neutron` or `nova-networks` network.
name	plain	csapi:string	The server name.
metadata (Optional)	plain	csapi:string	Metadata key and value pairs. The maximum size of the metadata key and value is 255 bytes each.
personality (Optional)	plain	csapi:string	File path and contents (text only) to inject into the server at launch. The maximum size of the file path data is 255 bytes. The maximum limit refers to the number of bytes in the decoded data and not the number of characters in the encoded data.
block_device_mapping_v2 (Optional)	plain	csapi:string	Enables booting the server from a volume when additional parameters are given. If specified, the volume status must be `available`, and the volume `attach_status` in the OpenStack Block Storage database must be `detached`.
device_name	plain	csapi:string	Describes a path to the device for the volume you want to use to boot the server.
source_type	plain	csapi:string	The source type for the volume. A valid value is `blank`, `snapshot`, `volume`, or `image`.
destination_type (Optional)	plain	csapi:string	Defines where the volume comes from. A valid value is `local` or `volume`.
delete_on_termination	plain	csapi:string	To delete the boot volume when the server stops, specify `true`. Otherwise, specify `false`.
guest_format	plain	csapi:string	Specifies the guest server disk file system format, such as `ephemeral` or `swap`.
boot_index	plain	csapi:string	The boot order of the device. Use `-1` for the boot volume. Use `0` for an attached volume.
config_drive (Optional)	plain	xsd:boolean	Enables metadata injection in a server through a configuration drive. Specify `true` to enable a configuration drive. Otherwise, specify `false`.
key_name (Optional)	plain	xsd:string	Key pair name.

{
    "servers": [
        {
            "accessIPv4": "",
            "accessIPv6": "",
            "addresses": {
                "private": [
                    {
                        "addr": "192.168.0.3",
                        "version": 4
                    }
                ]
            },
            "config_drive": "",
            "created": "2013-02-04T13:21:44Z",
            "flavor": {
                "id": "1",
                "links": [
                    {
                        "href": "http://openstack.example.com/openstack/flavors/1",
                        "rel": "bookmark"
                    }
                ]
            },
            "hostId": "76e154b0015e25fad65a7ab0c35a86dd79acfa8312075a6534ef6176",
            "id": "720e688f-5ec8-4d4f-b585-dbd1a89ceeb0",
            "image": {
                "id": "70a599e0-31e7-49b7-b260-868f441e862b",
                "links": [
                    {
                        "href": "http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b",
                        "rel": "bookmark"
                    }
                ]
            },
            "links": [
                {
                    "href": "http://openstack.example.com/v2/openstack/servers/720e688f-5ec8-4d4f-b585-dbd1a89ceeb0",
                    "rel": "self"
                },
                {
                    "href": "http://openstack.example.com/openstack/servers/720e688f-5ec8-4d4f-b585-dbd1a89ceeb0",
                    "rel": "bookmark"
                }
            ],
            "metadata": {
                "My Server Name": "Apache1"
            },
            "name": "new-server-test",
            "progress": 0,
            "status": "ACTIVE",
            "tenant_id": "openstack",
            "updated": "2013-02-04T13:21:44Z",
            "user_id": "fake"
        }
    ]
}

<?xml version='1.0' encoding='UTF-8'?>
<servers xmlns:atom="http://www.w3.org/2005/Atom" xmlns="http://docs.openstack.org/compute/api/v1.1">
  <server status="ACTIVE" updated="2013-02-04T13:26:27Z" hostId="2a00edcff768661880eb9c96c951f56c2c5dcd873bb652361008efc7" name="new-server-test" created="2013-02-04T13:26:27Z" userId="fake" tenantId="openstack" accessIPv4="" accessIPv6="" progress="0" id="515d94d3-aee4-4bd5-bb4e-9601c657372f" config_drive="">
    <image id="70a599e0-31e7-49b7-b260-868f441e862b">
      <atom:link href="http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b" rel="bookmark"/>
    </image>
    <flavor id="1">
      <atom:link href="http://openstack.example.com/openstack/flavors/1" rel="bookmark"/>
    </flavor>
    <metadata>
      <meta key="My Server Name">Apache1</meta>
    </metadata>
    <addresses>
      <network id="private">
        <ip version="4" addr="192.168.0.3"/>
      </network>
    </addresses>
    <atom:link href="http://openstack.example.com/v2/openstack/servers/515d94d3-aee4-4bd5-bb4e-9601c657372f" rel="self"/>
    <atom:link href="http://openstack.example.com/openstack/servers/515d94d3-aee4-4bd5-bb4e-9601c657372f" rel="bookmark"/>
  </server>
</servers>

This operation does not accept a request body.

Servers console (servers)

Gets a console for a server instance.

POST

/v2/{tenant_id}/servers/{server_id}/action

Get console

Gets a console for a server instance.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
server_id	URI	csapi:UUID	The UUID for the server of interest to you.
getConsole	plain	xsd:string	Specify the `getConsole` action in the request body.
type	plain	csapi:string	Valid values are `novnc` and `xvpvnc`.

{
    "os-getVNCConsole": {
        "type": "novnc"
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<os-getVNCConsole type="novnc" />

{
    "console": {
        "type": "novnc",
        "url": "http://example.com:6080/vnc_auto.html?token=f9906a48-b71e-4f18-baca-c987da3ebdb3&title=dafa(75ecef58-3b8e-4659-ab3b-5501454188e9)"
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<console>
  <type>novnc</type>
  <url>http://example.com:6080/vnc_auto.html?token=f9906a48-b71e-4f18-baca-c987da3ebdb3</url>
</console>

Servers console output (servers)

Gets console output for a server instance.

POST

/v2/{tenant_id}/servers/{server_id}/action

Get console output for an instance

Gets console output for a server instance.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
os-getConsoleOutput	plain	xsd:string	Specify the `os-getConsoleOutput` action in the request body.
length (Optional)	plain	String	Number of lines to fetch from the end of console log.

{
    "os-getConsoleOutput": {
        "length": 50
    }
}

{
    "output": "FAKE CONSOLE OUTPUT\nANOTHER\nLAST LINE"
}

Servers extended attributes (servers)

Shows metadata for servers.

GET

/v2/{tenant_id}/servers

List servers with extended server attributes

Lists detailed extended server attribute information for all servers.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.

{
    "servers": [
        {
            "OS-EXT-SRV-ATTR:host": "dd99797793774612b081a8be19bf721a",
            "OS-EXT-SRV-ATTR:hypervisor_hostname": "fake-mini",
            "OS-EXT-SRV-ATTR:instance_name": "instance-00000001",
            "accessIPv4": "",
            "accessIPv6": "",
            "addresses": {
                "private": [
                    {
                        "addr": "192.168.0.3",
                        "version": 4
                    }
                ]
            },
            "created": "2012-11-15T19:27:05Z",
            "flavor": {
                "id": "1",
                "links": [
                    {
                        "href": "http://openstack.example.com/openstack/flavors/1",
                        "rel": "bookmark"
                    }
                ]
            },
            "hostId": "146245c049213a54b8c2352751518fcb4c2befd1b942b45a5a705d35",
            "id": "e0c3563a-84ef-4d0b-bb80-23392cd23882",
            "image": {
                "id": "70a599e0-31e7-49b7-b260-868f441e862b",
                "links": [
                    {
                        "href": "http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b",
                        "rel": "bookmark"
                    }
                ]
            },
            "links": [
                {
                    "href": "http://openstack.example.com/v2/openstack/servers/e0c3563a-84ef-4d0b-bb80-23392cd23882",
                    "rel": "self"
                },
                {
                    "href": "http://openstack.example.com/openstack/servers/e0c3563a-84ef-4d0b-bb80-23392cd23882",
                    "rel": "bookmark"
                }
            ],
            "metadata": {
                "My Server Name": "Apache1"
            },
            "name": "new-server-test",
            "progress": 0,
            "status": "ACTIVE",
            "tenant_id": "openstack",
            "updated": "2012-11-15T19:27:05Z",
            "user_id": "fake"
        }
    ]
}

<?xml version='1.0' encoding='UTF-8'?>
<servers xmlns:OS-EXT-SRV-ATTR="http://docs.openstack.org/compute/ext/extended_status/api/v1.1" xmlns:atom="http://www.w3.org/2005/Atom" xmlns="http://docs.openstack.org/compute/api/v1.1">
  <server status="ACTIVE" updated="2012-11-15T19:27:06Z" hostId="b348a7376e2e61781829c9b45e63675aa0207632c25ce36c55a4fb2a" name="new-server-test" created="2012-11-15T19:27:06Z" userId="fake" tenantId="openstack" accessIPv4="" accessIPv6="" progress="0" id="3cadb9e9-f430-4f62-8b9b-3efb671ff1fa" OS-EXT-SRV-ATTR:instance_name="instance-00000001" OS-EXT-SRV-ATTR:host="2c4d049170fe409abc14942757d63a4e" OS-EXT-SRV-ATTR:hypervisor_hostname="fake-mini">
    <image id="70a599e0-31e7-49b7-b260-868f441e862b">
      <atom:link href="http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b" rel="bookmark"/>
    </image>
    <flavor id="1">
      <atom:link href="http://openstack.example.com/openstack/flavors/1" rel="bookmark"/>
    </flavor>
    <metadata>
      <meta key="My Server Name">Apache1</meta>
    </metadata>
    <addresses>
      <network id="private">
        <ip version="4" addr="192.168.0.3"/>
      </network>
    </addresses>
    <atom:link href="http://openstack.example.com/v2/openstack/servers/3cadb9e9-f430-4f62-8b9b-3efb671ff1fa" rel="self"/>
    <atom:link href="http://openstack.example.com/openstack/servers/3cadb9e9-f430-4f62-8b9b-3efb671ff1fa" rel="bookmark"/>
  </server>
</servers>

This operation does not accept a request body.

GET

/v2/{tenant_id}/servers/{server_id}

Show extended server attributes

Shows extended server attributes for a specified server.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
server_id	URI	csapi:UUID	The UUID for the server of interest to you.

{
    "server": {
        "OS-EXT-SRV-ATTR:host": "1169a68456af48238da47b1d5957a714",
        "OS-EXT-SRV-ATTR:hypervisor_hostname": "fake-mini",
        "OS-EXT-SRV-ATTR:instance_name": "instance-00000001",
        "accessIPv4": "",
        "accessIPv6": "",
        "addresses": {
            "private": [
                {
                    "addr": "192.168.0.3",
                    "version": 4
                }
            ]
        },
        "created": "2012-11-15T19:27:04Z",
        "flavor": {
            "id": "1",
            "links": [
                {
                    "href": "http://openstack.example.com/openstack/flavors/1",
                    "rel": "bookmark"
                }
            ]
        },
        "hostId": "2dfce43c41dd288cfac3a5b4251742b3bd2b37c12eb5927e757d9b4c",
        "id": "1fc2392e-5727-46af-bc21-317a4a3eb04c",
        "image": {
            "id": "70a599e0-31e7-49b7-b260-868f441e862b",
            "links": [
                {
                    "href": "http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b",
                    "rel": "bookmark"
                }
            ]
        },
        "links": [
            {
                "href": "http://openstack.example.com/v2/openstack/servers/1fc2392e-5727-46af-bc21-317a4a3eb04c",
                "rel": "self"
            },
            {
                "href": "http://openstack.example.com/openstack/servers/1fc2392e-5727-46af-bc21-317a4a3eb04c",
                "rel": "bookmark"
            }
        ],
        "metadata": {
            "My Server Name": "Apache1"
        },
        "name": "new-server-test",
        "progress": 0,
        "status": "ACTIVE",
        "tenant_id": "openstack",
        "updated": "2012-11-15T19:27:04Z",
        "user_id": "fake"
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<server xmlns:OS-EXT-SRV-ATTR="http://docs.openstack.org/compute/ext/extended_status/api/v1.1" xmlns:atom="http://www.w3.org/2005/Atom" xmlns="http://docs.openstack.org/compute/api/v1.1" status="ACTIVE" updated="2012-11-15T19:27:06Z" hostId="6b8205d183f40afad106dbeac44d3872151ef6f36790077ea2ea85fc" name="new-server-test" created="2012-11-15T19:27:05Z" userId="fake" tenantId="openstack" accessIPv4="" accessIPv6="" progress="0" id="ece641c1-51f5-4190-9342-d9751f28eead" OS-EXT-SRV-ATTR:instance_name="instance-00000001" OS-EXT-SRV-ATTR:host="80edfa5af48b4894b20eb1d9d2d4424e" OS-EXT-SRV-ATTR:hypervisor_hostname="fake-mini">
  <image id="70a599e0-31e7-49b7-b260-868f441e862b">
    <atom:link href="http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b" rel="bookmark"/>
  </image>
  <flavor id="1">
    <atom:link href="http://openstack.example.com/openstack/flavors/1" rel="bookmark"/>
  </flavor>
  <metadata>
    <meta key="My Server Name">Apache1</meta>
  </metadata>
  <addresses>
    <network id="private">
      <ip version="4" addr="192.168.0.3"/>
    </network>
  </addresses>
  <atom:link href="http://openstack.example.com/v2/openstack/servers/ece641c1-51f5-4190-9342-d9751f28eead" rel="self"/>
  <atom:link href="http://openstack.example.com/openstack/servers/ece641c1-51f5-4190-9342-d9751f28eead" rel="bookmark"/>
</server>

This operation does not accept a request body.

Servers with extended availability zones (servers)

Shows the instance availability zone for compute nodes (nova- compute). Internal services appear in their own internal availability zone.

GET

/v2/{tenant_id}/servers/{server_id}

Show server

Shows information for a specified server, including its availability zone.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
server_id	URI	csapi:UUID	The UUID for the server of interest to you.

{
    "server": {
        "OS-EXT-AZ:availability_zone": "nova",
        "accessIPv4": "",
        "accessIPv6": "",
        "addresses": {
            "private": [
                {
                    "addr": "192.168.0.3",
                    "version": 4
                }
            ]
        },
        "created": "2013-01-30T13:38:47Z",
        "flavor": {
            "id": "1",
            "links": [
                {
                    "href": "http://openstack.example.com/openstack/flavors/1",
                    "rel": "bookmark"
                }
            ]
        },
        "hostId": "d38ea49a033b0efaf80c165de63f4805c886dfb94dc0fe731227eccb",
        "id": "fb7babfd-e1a1-4add-90e6-3558180983c7",
        "image": {
            "id": "70a599e0-31e7-49b7-b260-868f441e862b",
            "links": [
                {
                    "href": "http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b",
                    "rel": "bookmark"
                }
            ]
        },
        "links": [
            {
                "href": "http://openstack.example.com/v2/openstack/servers/fb7babfd-e1a1-4add-90e6-3558180983c7",
                "rel": "self"
            },
            {
                "href": "http://openstack.example.com/openstack/servers/fb7babfd-e1a1-4add-90e6-3558180983c7",
                "rel": "bookmark"
            }
        ],
        "metadata": {
            "My Server Name": "Apache1"
        },
        "name": "new-server-test",
        "progress": 0,
        "status": "ACTIVE",
        "tenant_id": "openstack",
        "updated": "2013-01-30T13:38:49Z",
        "user_id": "fake"
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<server xmlns:OS-EXT-AZ="http://docs.openstack.org/compute/ext/extended_availability_zone/api/v2" xmlns:atom="http://www.w3.org/2005/Atom" xmlns="http://docs.openstack.org/compute/api/v1.1" status="ACTIVE" updated="2013-01-30T14:29:20Z" hostId="471e52951e3182954c5a93489dafc3fc38a9ef3e0b62d26dc740460c" name="new-server-test" created="2013-01-30T14:29:19Z" userId="fake" tenantId="openstack" accessIPv4="" accessIPv6="" progress="0" id="26ea8424-758d-483a-addc-9a5905afc9e6" OS-EXT-AZ:availability_zone="nova">
  <image id="70a599e0-31e7-49b7-b260-868f441e862b">
    <atom:link href="http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b" rel="bookmark"/>
  </image>
  <flavor id="1">
    <atom:link href="http://openstack.example.com/openstack/flavors/1" rel="bookmark"/>
  </flavor>
  <metadata>
    <meta key="My Server Name">Apache1</meta>
  </metadata>
  <addresses>
    <network id="private">
      <ip version="4" addr="192.168.0.3"/>
    </network>
  </addresses>
  <atom:link href="http://openstack.example.com/v2/openstack/servers/26ea8424-758d-483a-addc-9a5905afc9e6" rel="self"/>
  <atom:link href="http://openstack.example.com/openstack/servers/26ea8424-758d-483a-addc-9a5905afc9e6" rel="bookmark"/>
</server>

This operation does not accept a request body.

GET

/v2/{tenant_id}/servers/detail

List details for servers

Lists details for servers, including their current availability zone.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.

{
    "servers": [
        {
            "OS-EXT-AZ:availability_zone": "nova",
            "accessIPv4": "",
            "accessIPv6": "",
            "addresses": {
                "private": [
                    {
                        "addr": "192.168.0.3",
                        "version": 4
                    }
                ]
            },
            "created": "2013-01-30T13:26:51Z",
            "flavor": {
                "id": "1",
                "links": [
                    {
                        "href": "http://openstack.example.com/openstack/flavors/1",
                        "rel": "bookmark"
                    }
                ]
            },
            "hostId": "60c988a84401fa15888a32833e5848e9caa99a45778310ba7b363165",
            "id": "3dbf5b00-dabc-41ff-b6ab-4409568fae9d",
            "image": {
                "id": "70a599e0-31e7-49b7-b260-868f441e862b",
                "links": [
                    {
                        "href": "http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b",
                        "rel": "bookmark"
                    }
                ]
            },
            "links": [
                {
                    "href": "http://openstack.example.com/v2/openstack/servers/3dbf5b00-dabc-41ff-b6ab-4409568fae9d",
                    "rel": "self"
                },
                {
                    "href": "http://openstack.example.com/openstack/servers/3dbf5b00-dabc-41ff-b6ab-4409568fae9d",
                    "rel": "bookmark"
                }
            ],
            "metadata": {
                "My Server Name": "Apache1"
            },
            "name": "new-server-test",
            "progress": 0,
            "status": "ACTIVE",
            "tenant_id": "openstack",
            "updated": "2013-01-30T13:26:52Z",
            "user_id": "fake"
        }
    ]
}

<?xml version='1.0' encoding='UTF-8'?>
<servers xmlns:OS-EXT-AZ="http://docs.openstack.org/compute/ext/extended_availability_zone/api/v2" xmlns:atom="http://www.w3.org/2005/Atom" xmlns="http://docs.openstack.org/compute/api/v1.1">
  <server status="ACTIVE" updated="2013-01-30T14:29:20Z" hostId="85adf7d0492dedf0a7e3dc44ef7d16186b768ca3df33c4d608e630d9" name="new-server-test" created="2013-01-30T14:29:19Z" userId="fake" tenantId="openstack" accessIPv4="" accessIPv6="" progress="0" id="a668c72d-2bac-4806-a297-c7c11d97e3b3" OS-EXT-AZ:availability_zone="nova">
    <image id="70a599e0-31e7-49b7-b260-868f441e862b">
      <atom:link href="http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b" rel="bookmark"/>
    </image>
    <flavor id="1">
      <atom:link href="http://openstack.example.com/openstack/flavors/1" rel="bookmark"/>
    </flavor>
    <metadata>
      <meta key="My Server Name">Apache1</meta>
    </metadata>
    <addresses>
      <network id="private">
        <ip version="4" addr="192.168.0.3"/>
      </network>
    </addresses>
    <atom:link href="http://openstack.example.com/v2/openstack/servers/a668c72d-2bac-4806-a297-c7c11d97e3b3" rel="self"/>
    <atom:link href="http://openstack.example.com/openstack/servers/a668c72d-2bac-4806-a297-c7c11d97e3b3" rel="bookmark"/>
  </server>
</servers>

This operation does not accept a request body.

Servers extended status (servers)

Shows the vm_state, task_state, and power_state extended status information in detailed server responses.

GET

/v2/{tenant_id}/servers/{server_id}

Show server extended status

Shows the extended status attributes in the response for a specified server.

The extended status attributes are vm_state, power_state, and task_state.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
server_id	URI	csapi:UUID	The UUID for the server of interest to you.

{
    "server": {
        "OS-EXT-STS:power_state": 1,
        "OS-EXT-STS:task_state": null,
        "OS-EXT-STS:vm_state": "active",
        "accessIPv4": "",
        "accessIPv6": "",
        "addresses": {
            "private": [
                {
                    "addr": "192.168.0.3",
                    "version": 4
                }
            ]
        },
        "created": "2013-02-07T19:35:09Z",
        "flavor": {
            "id": "1",
            "links": [
                {
                    "href": "http://openstack.example.com/openstack/flavors/1",
                    "rel": "bookmark"
                }
            ]
        },
        "hostId": "570eff4776ab310707d11d181037337197086998a8b3305c90bf87c8",
        "id": "ecb5e433-fa75-4db2-af3d-a29ae8618edc",
        "image": {
            "id": "70a599e0-31e7-49b7-b260-868f441e862b",
            "links": [
                {
                    "href": "http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b",
                    "rel": "bookmark"
                }
            ]
        },
        "links": [
            {
                "href": "http://openstack.example.com/v2/openstack/servers/ecb5e433-fa75-4db2-af3d-a29ae8618edc",
                "rel": "self"
            },
            {
                "href": "http://openstack.example.com/openstack/servers/ecb5e433-fa75-4db2-af3d-a29ae8618edc",
                "rel": "bookmark"
            }
        ],
        "metadata": {
            "My Server Name": "Apache1"
        },
        "name": "new-server-test",
        "progress": 0,
        "status": "ACTIVE",
        "tenant_id": "openstack",
        "updated": "2013-02-07T19:35:10Z",
        "user_id": "fake"
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<server xmlns:OS-EXT-STS="http://docs.openstack.org/compute/ext/extended_status/api/v1.1" xmlns:atom="http://www.w3.org/2005/Atom" xmlns="http://docs.openstack.org/compute/api/v1.1" status="ACTIVE" updated="2013-02-07T19:35:10Z" hostId="372afb648339fb6f22faa0b75fdd8834e2382fe02b352af8d7ee0b84" name="new-server-test" created="2013-02-07T19:35:09Z" userId="fake" tenantId="openstack" accessIPv4="" accessIPv6="" progress="0" id="68647408-85a7-4d9b-85e7-7f1e238983ad" OS-EXT-STS:vm_state="active" OS-EXT-STS:task_state="None" OS-EXT-STS:power_state="1">
  <image id="70a599e0-31e7-49b7-b260-868f441e862b">
    <atom:link href="http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b" rel="bookmark"/>
  </image>
  <flavor id="1">
    <atom:link href="http://openstack.example.com/openstack/flavors/1" rel="bookmark"/>
  </flavor>
  <metadata>
    <meta key="My Server Name">Apache1</meta>
  </metadata>
  <addresses>
    <network id="private">
      <ip version="4" addr="192.168.0.3"/>
    </network>
  </addresses>
  <atom:link href="http://openstack.example.com/v2/openstack/servers/68647408-85a7-4d9b-85e7-7f1e238983ad" rel="self"/>
  <atom:link href="http://openstack.example.com/openstack/servers/68647408-85a7-4d9b-85e7-7f1e238983ad" rel="bookmark"/>
</server>

This operation does not accept a request body.

GET

/v2/{tenant_id}/servers/detail

List extended status for servers

Lists the extended status attributes in the detailed response for all servers.

The extended status attributes are vm_state, power_state, and task_state.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.

{
    "servers": [
        {
            "OS-EXT-STS:power_state": 1,
            "OS-EXT-STS:task_state": null,
            "OS-EXT-STS:vm_state": "active",
            "accessIPv4": "",
            "accessIPv6": "",
            "addresses": {
                "private": [
                    {
                        "addr": "192.168.0.3",
                        "version": 4
                    }
                ]
            },
            "created": "2012-12-05T07:34:10Z",
            "flavor": {
                "id": "1",
                "links": [
                    {
                        "href": "http://openstack.example.com/openstack/flavors/1",
                        "rel": "bookmark"
                    }
                ]
            },
            "hostId": "585aa01f94eca692eff9f77ffe3eab866d8a819e97397e28c5c7df12",
            "id": "030758aa-5c41-41c6-8fb4-29d44eb96a85",
            "image": {
                "id": "70a599e0-31e7-49b7-b260-868f441e862b",
                "links": [
                    {
                        "href": "http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b",
                        "rel": "bookmark"
                    }
                ]
            },
            "links": [
                {
                    "href": "http://openstack.example.com/v2/openstack/servers/030758aa-5c41-41c6-8fb4-29d44eb96a85",
                    "rel": "self"
                },
                {
                    "href": "http://openstack.example.com/openstack/servers/030758aa-5c41-41c6-8fb4-29d44eb96a85",
                    "rel": "bookmark"
                }
            ],
            "metadata": {
                "My Server Name": "Apache1"
            },
            "name": "new-server-test",
            "progress": 0,
            "status": "ACTIVE",
            "tenant_id": "openstack",
            "updated": "2012-12-05T07:34:10Z",
            "user_id": "fake"
        }
    ]
}

<?xml version='1.0' encoding='UTF-8'?>
<servers xmlns:OS-EXT-STS="http://docs.openstack.org/compute/ext/extended_status/api/v1.1" xmlns:atom="http://www.w3.org/2005/Atom" xmlns="http://docs.openstack.org/compute/api/v1.1">
  <server status="ACTIVE" updated="2012-12-05T07:35:57Z" hostId="20171312b8f2c42b69b09360e08d7fe257b2e021107be687d0302a96" name="new-server-test" created="2012-12-05T07:35:56Z" userId="fake" tenantId="openstack" accessIPv4="" accessIPv6="" progress="0" id="085c76aa-a58f-45b8-ba78-4d1e541d5f89" OS-EXT-STS:vm_state="active" OS-EXT-STS:task_state="None" OS-EXT-STS:power_state="1">
    <image id="70a599e0-31e7-49b7-b260-868f441e862b">
      <atom:link href="http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b" rel="bookmark"/>
    </image>
    <flavor id="1">
      <atom:link href="http://openstack.example.com/openstack/flavors/1" rel="bookmark"/>
    </flavor>
    <metadata>
      <meta key="My Server Name">Apache1</meta>
    </metadata>
    <addresses>
      <network id="private">
        <ip version="4" addr="192.168.0.3"/>
      </network>
    </addresses>
    <atom:link href="http://openstack.example.com/v2/openstack/servers/085c76aa-a58f-45b8-ba78-4d1e541d5f89" rel="self"/>
    <atom:link href="http://openstack.example.com/openstack/servers/085c76aa-a58f-45b8-ba78-4d1e541d5f89" rel="bookmark"/>
  </server>
</servers>

This operation does not accept a request body.

Servers with IP type (servers)

Shows the type of the IP addresses that are assigned to an instance. Type is either fixed or floating.

GET

/v2/{tenant_id}/servers/{server_id}/action

Show IP type

Shows the type of IP assigned to a specified server, either fixed or floating.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The unique identifier of the tenant or account.
server_id	URI	csapi:UUID	The UUID for the server of interest to you.

{
    "server": {
        "accessIPv4": "",
        "accessIPv6": "",
        "addresses": {
            "private": [
                {
                    "OS-EXT-IPS:type": "fixed",
                    "addr": "192.168.0.3",
                    "version": 4
                }
            ]
        },
        "created": "2013-02-07T18:46:28Z",
        "flavor": {
            "id": "1",
            "links": [
                {
                    "href": "http://openstack.example.com/openstack/flavors/1",
                    "rel": "bookmark"
                }
            ]
        },
        "hostId": "4e2003eddbfdb1280c2618d04090bcdd6773203b8da8347af0b2723d",
        "id": "dc7281f9-ee47-40b9-9950-9f73e7961caa",
        "image": {
            "id": "70a599e0-31e7-49b7-b260-868f441e862b",
            "links": [
                {
                    "href": "http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b",
                    "rel": "bookmark"
                }
            ]
        },
        "links": [
            {
                "href": "http://openstack.example.com/v2/openstack/servers/dc7281f9-ee47-40b9-9950-9f73e7961caa",
                "rel": "self"
            },
            {
                "href": "http://openstack.example.com/openstack/servers/dc7281f9-ee47-40b9-9950-9f73e7961caa",
                "rel": "bookmark"
            }
        ],
        "metadata": {
            "My Server Name": "Apache1"
        },
        "name": "new-server-test",
        "progress": 0,
        "status": "ACTIVE",
        "tenant_id": "openstack",
        "updated": "2013-02-07T18:46:29Z",
        "user_id": "fake"
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<server xmlns:OS-EXT-IPS="http://docs.openstack.org/compute/ext/extended_ips/api/v1.1" xmlns:atom="http://www.w3.org/2005/Atom" xmlns="http://docs.openstack.org/compute/api/v1.1" status="ACTIVE" updated="2013-02-07T18:46:29Z" hostId="068cc5e2de14b6e533a239c6eac0a0bdedcd57cab25450a6d3da43af" name="new-server-test" created="2013-02-07T18:46:28Z" userId="fake" tenantId="openstack" accessIPv4="" accessIPv6="" progress="0" id="22e7cf4d-ab7a-4a3d-9599-7d0dbaf9ed55">
  <image id="70a599e0-31e7-49b7-b260-868f441e862b">
    <atom:link href="http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b" rel="bookmark"/>
  </image>
  <flavor id="1">
    <atom:link href="http://openstack.example.com/openstack/flavors/1" rel="bookmark"/>
  </flavor>
  <metadata>
    <meta key="My Server Name">Apache1</meta>
  </metadata>
  <addresses>
    <network id="private">
      <ip OS-EXT-IPS:type="fixed" version="4" addr="192.168.0.3"/>
    </network>
  </addresses>
  <atom:link href="http://openstack.example.com/v2/openstack/servers/22e7cf4d-ab7a-4a3d-9599-7d0dbaf9ed55" rel="self"/>
  <atom:link href="http://openstack.example.com/openstack/servers/22e7cf4d-ab7a-4a3d-9599-7d0dbaf9ed55" rel="bookmark"/>
</server>

This operation does not accept a request body.

GET

/v2/{tenant_id}/servers/detail

List servers with IP type

Lists servers and shows their IPs by type. Type is either fixed or floating.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The unique identifier of the tenant or account.

{
    "servers": [
        {
            "accessIPv4": "",
            "accessIPv6": "",
            "addresses": {
                "private": [
                    {
                        "OS-EXT-IPS:type": "fixed",
                        "addr": "192.168.0.3",
                        "version": 4
                    }
                ]
            },
            "created": "2013-02-07T18:40:59Z",
            "flavor": {
                "id": "1",
                "links": [
                    {
                        "href": "http://openstack.example.com/openstack/flavors/1",
                        "rel": "bookmark"
                    }
                ]
            },
            "hostId": "fe866a4962fe3bdb6c2db9c8f7dcdb9555aca73387e72b5cb9c45bd3",
            "id": "76908712-653a-4d16-807e-d89d41435d24",
            "image": {
                "id": "70a599e0-31e7-49b7-b260-868f441e862b",
                "links": [
                    {
                        "href": "http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b",
                        "rel": "bookmark"
                    }
                ]
            },
            "links": [
                {
                    "href": "http://openstack.example.com/v2/openstack/servers/76908712-653a-4d16-807e-d89d41435d24",
                    "rel": "self"
                },
                {
                    "href": "http://openstack.example.com/openstack/servers/76908712-653a-4d16-807e-d89d41435d24",
                    "rel": "bookmark"
                }
            ],
            "metadata": {
                "My Server Name": "Apache1"
            },
            "name": "new-server-test",
            "progress": 0,
            "status": "ACTIVE",
            "tenant_id": "openstack",
            "updated": "2013-02-07T18:40:59Z",
            "user_id": "fake"
        }
    ]
}

<?xml version='1.0' encoding='UTF-8'?>
<servers xmlns:OS-EXT-IPS="http://docs.openstack.org/compute/ext/extended_ips/api/v1.1" xmlns:atom="http://www.w3.org/2005/Atom" xmlns="http://docs.openstack.org/compute/api/v1.1">
  <server status="ACTIVE" updated="2013-02-07T18:40:59Z" hostId="51a80e6ee89b638b2cb57eb4e39d89a725e07c8a698f4d8e256f8665" name="new-server-test" created="2013-02-07T18:40:59Z" userId="fake" tenantId="openstack" accessIPv4="" accessIPv6="" progress="0" id="0337de6b-1d43-46c8-8804-35669f1dea9a">
    <image id="70a599e0-31e7-49b7-b260-868f441e862b">
      <atom:link href="http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b" rel="bookmark"/>
    </image>
    <flavor id="1">
      <atom:link href="http://openstack.example.com/openstack/flavors/1" rel="bookmark"/>
    </flavor>
    <metadata>
      <meta key="My Server Name">Apache1</meta>
    </metadata>
    <addresses>
      <network id="private">
        <ip OS-EXT-IPS:type="fixed" version="4" addr="192.168.0.3"/>
      </network>
    </addresses>
    <atom:link href="http://openstack.example.com/v2/openstack/servers/0337de6b-1d43-46c8-8804-35669f1dea9a" rel="self"/>
    <atom:link href="http://openstack.example.com/openstack/servers/0337de6b-1d43-46c8-8804-35669f1dea9a" rel="bookmark"/>
  </server>
</servers>

This operation does not accept a request body.

Servers multiple create (servers)

Creates one or more servers with an optional reservation ID. The request and response examples show how to create multiple servers with or without a reservation ID.

POST

/v2/{tenant_id}/servers

Create multiple servers

Creates one or more servers with an optional reservation ID.

Normal response codes

202

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
security_groups (Optional)	plain	xsd:string	One or more security groups. Specify the name of the security group in the `name` attribute. If you omit this attribute, the server is created in the `default` security group.
user_data (Optional)	plain	xsd:string	Configuration information or scripts to use upon launch. Must be Base64 encoded.
availability_zone (Optional)	plain	xsd:string	The availability zone in which to launch the server.
server	plain	csapi:ServerForCreate	server.
imageRef	plain	csapi:string	The image reference for the desired image for your server instance. Specify as an ID or full URL.
flavorRef	plain	csapi:string	The flavor reference for the desired flavor for your server instance. Specify as an ID or full URL.
networks (Optional)	plain	xsd:string	A `networks` object. By default, the server instance is provisioned with all isolated networks for the tenant. Optionally, you can create one or more NICs on the server. To provision the server instance with a NIC for a network, specify the UUID of the network in the `uuid` attribute in a `networks` object. To provision the server instance with a NIC for an already existing port, specify the port-id in the `port` attribute in a `networks` object. You can specify multiple NICs on the server.
uuid (Optional)	plain	xsd:string	To provision the server instance with a NIC for a network, specify the UUID of the network in the `uuid` attribute in a `networks` object. Required if you omit the `port` attribute.
port (Optional)	plain	xsd:string	To provision the server instance with a NIC for an already existing port, specify the port-id in the `port` attribute in a `networks` object. The port status must be `DOWN`. Required if you omit the `uuid` attribute.
fixed_ip (Optional)	plain	xsd:string	A fixed IPv4 address for the NIC. Valid with a `neutron` or `nova-networks` network.
name	plain	csapi:string	The server name.
metadata (Optional)	plain	csapi:string	Metadata key and value pairs. The maximum size of the metadata key and value is 255 bytes each.
personality (Optional)	plain	csapi:string	File path and contents (text only) to inject into the server at launch. The maximum size of the file path data is 255 bytes. The maximum limit refers to the number of bytes in the decoded data and not the number of characters in the encoded data.
block_device_mapping_v2 (Optional)	plain	csapi:string	Enables booting the server from a volume when additional parameters are given. If specified, the volume status must be `available`, and the volume `attach_status` in the OpenStack Block Storage database must be `detached`.
device_name	plain	csapi:string	Describes a path to the device for the volume you want to use to boot the server.
source_type	plain	csapi:string	The source type for the volume. A valid value is `blank`, `snapshot`, `volume`, or `image`.
destination_type (Optional)	plain	csapi:string	Defines where the volume comes from. A valid value is `local` or `volume`.
delete_on_termination	plain	csapi:string	To delete the boot volume when the server stops, specify `true`. Otherwise, specify `false`.
guest_format	plain	csapi:string	Specifies the guest server disk file system format, such as `ephemeral` or `swap`.
boot_index	plain	csapi:string	The boot order of the device. Use `-1` for the boot volume. Use `0` for an attached volume.
config_drive (Optional)	plain	xsd:boolean	Enables metadata injection in a server through a configuration drive. Specify `true` to enable a configuration drive. Otherwise, specify `false`.
key_name (Optional)	plain	xsd:string	Key pair name.
return_reservation_id (Optional)	plain	xsd:string	Set to `True`to generate a reservation ID for each server. Omit this attribute to create servers without a reservation ID. This extended attribute is enabled when the service provider enables multiple server launch.
min_count (Optional)	plain	xsd:string	The minimum number of servers to launch when the service provider enables multiple server launch.
max_count (Optional)	plain	xsd:string	The maximum number of servers to launch when the service provider enables multiple server launch.

Response parameters

Parameter	Style	Type	Description
security_groups (Optional)	plain	xsd:string	One or more security groups. Specify the name of the security group in the `name` attribute. If you omit this attribute, the server is created in the `default` security group.
user_data (Optional)	plain	xsd:string	Configuration information or scripts to use upon launch. Must be Base64 encoded.
availability_zone (Optional)	plain	xsd:string	The availability zone in which to launch the server.
server	plain	csapi:ServerForCreate	server.
imageRef	plain	csapi:string	The image reference for the desired image for your server instance. Specify as an ID or full URL.
flavorRef	plain	csapi:string	The flavor reference for the desired flavor for your server instance. Specify as an ID or full URL.
networks (Optional)	plain	xsd:string	A `networks` object. By default, the server instance is provisioned with all isolated networks for the tenant. Optionally, you can create one or more NICs on the server. To provision the server instance with a NIC for a network, specify the UUID of the network in the `uuid` attribute in a `networks` object. To provision the server instance with a NIC for an already existing port, specify the port-id in the `port` attribute in a `networks` object. You can specify multiple NICs on the server.
uuid (Optional)	plain	xsd:string	To provision the server instance with a NIC for a network, specify the UUID of the network in the `uuid` attribute in a `networks` object. Required if you omit the `port` attribute.
port (Optional)	plain	xsd:string	To provision the server instance with a NIC for an already existing port, specify the port-id in the `port` attribute in a `networks` object. The port status must be `DOWN`. Required if you omit the `uuid` attribute.
fixed_ip (Optional)	plain	xsd:string	A fixed IPv4 address for the NIC. Valid with a `neutron` or `nova-networks` network.
name	plain	csapi:string	The server name.
metadata (Optional)	plain	csapi:string	Metadata key and value pairs. The maximum size of the metadata key and value is 255 bytes each.
personality (Optional)	plain	csapi:string	File path and contents (text only) to inject into the server at launch. The maximum size of the file path data is 255 bytes. The maximum limit refers to the number of bytes in the decoded data and not the number of characters in the encoded data.
block_device_mapping_v2 (Optional)	plain	csapi:string	Enables booting the server from a volume when additional parameters are given. If specified, the volume status must be `available`, and the volume `attach_status` in the OpenStack Block Storage database must be `detached`.
device_name	plain	csapi:string	Describes a path to the device for the volume you want to use to boot the server.
source_type	plain	csapi:string	The source type for the volume. A valid value is `blank`, `snapshot`, `volume`, or `image`.
destination_type (Optional)	plain	csapi:string	Defines where the volume comes from. A valid value is `local` or `volume`.
delete_on_termination	plain	csapi:string	To delete the boot volume when the server stops, specify `true`. Otherwise, specify `false`.
guest_format	plain	csapi:string	Specifies the guest server disk file system format, such as `ephemeral` or `swap`.
boot_index	plain	csapi:string	The boot order of the device. Use `-1` for the boot volume. Use `0` for an attached volume.
config_drive (Optional)	plain	xsd:boolean	Enables metadata injection in a server through a configuration drive. Specify `true` to enable a configuration drive. Otherwise, specify `false`.
key_name (Optional)	plain	xsd:string	Key pair name.

{
    "server": {
        "name": "new-server-test",
        "imageRef": "http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b",
        "flavorRef": "http://openstack.example.com/openstack/flavors/1",
        "metadata": {
            "My Server Name": "Apache1"
        },
        "min_count": "2",
        "max_count": "3",
        "personality": [
            {
                "path": "/etc/banner.txt",
                "contents": "ICAgICAgDQoiQSBjbG91ZCBkb2VzIG5vdCBrbm93IHdoeSBpdCBtb3ZlcyBpbiBqdXN0IHN1Y2ggYSBkaXJlY3Rpb24gYW5kIGF0IHN1Y2ggYSBzcGVlZC4uLkl0IGZlZWxzIGFuIGltcHVsc2lvbi4uLnRoaXMgaXMgdGhlIHBsYWNlIHRvIGdvIG5vdy4gQnV0IHRoZSBza3kga25vd3MgdGhlIHJlYXNvbnMgYW5kIHRoZSBwYXR0ZXJucyBiZWhpbmQgYWxsIGNsb3VkcywgYW5kIHlvdSB3aWxsIGtub3csIHRvbywgd2hlbiB5b3UgbGlmdCB5b3Vyc2VsZiBoaWdoIGVub3VnaCB0byBzZWUgYmV5b25kIGhvcml6b25zLiINCg0KLVJpY2hhcmQgQmFjaA=="
            }
        ]
    }
}

{
    "server": {
        "name": "new-server-test",
        "imageRef": "http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b",
        "flavorRef": "http://openstack.example.com/openstack/flavors/1",
        "metadata": {
            "My Server Name": "Apache1"
        },
        "return_reservation_id": "True",
        "min_count": "2",
        "max_count": "3",
        "personality": [
            {
                "path": "/etc/banner.txt",
                "contents": "ICAgICAgDQoiQSBjbG91ZCBkb2VzIG5vdCBrbm93IHdoeSBpdCBtb3ZlcyBpbiBqdXN0IHN1Y2ggYSBkaXJlY3Rpb24gYW5kIGF0IHN1Y2ggYSBzcGVlZC4uLkl0IGZlZWxzIGFuIGltcHVsc2lvbi4uLnRoaXMgaXMgdGhlIHBsYWNlIHRvIGdvIG5vdy4gQnV0IHRoZSBza3kga25vd3MgdGhlIHJlYXNvbnMgYW5kIHRoZSBwYXR0ZXJucyBiZWhpbmQgYWxsIGNsb3VkcywgYW5kIHlvdSB3aWxsIGtub3csIHRvbywgd2hlbiB5b3UgbGlmdCB5b3Vyc2VsZiBoaWdoIGVub3VnaCB0byBzZWUgYmV5b25kIGhvcml6b25zLiINCg0KLVJpY2hhcmQgQmFjaA=="
            }
        ]
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<server xmlns="http://docs.openstack.org/compute/api/v1.1"
        imageRef="http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b"
        flavorRef="http://openstack.example.com/openstack/flavors/1"
        name="new-server-test"
        min_count="2"
        max_count="3">
  <metadata>
    <meta key="My Server Name">Apache1</meta>
  </metadata>
  <personality>
    <file path="/etc/banner.txt">
        ICAgICAgDQoiQSBjbG91ZCBkb2VzIG5vdCBrbm93IHdoeSBp
        dCBtb3ZlcyBpbiBqdXN0IHN1Y2ggYSBkaXJlY3Rpb24gYW5k
        IGF0IHN1Y2ggYSBzcGVlZC4uLkl0IGZlZWxzIGFuIGltcHVs
        c2lvbi4uLnRoaXMgaXMgdGhlIHBsYWNlIHRvIGdvIG5vdy4g
        QnV0IHRoZSBza3kga25vd3MgdGhlIHJlYXNvbnMgYW5kIHRo
        ZSBwYXR0ZXJucyBiZWhpbmQgYWxsIGNsb3VkcywgYW5kIHlv
        dSB3aWxsIGtub3csIHRvbywgd2hlbiB5b3UgbGlmdCB5b3Vy
        c2VsZiBoaWdoIGVub3VnaCB0byBzZWUgYmV5b25kIGhvcml6
        b25zLiINCg0KLVJpY2hhcmQgQmFjaA==
    </file>
  </personality>
</server>

<?xml version="1.0" encoding="UTF-8"?>
<server xmlns="http://docs.openstack.org/compute/api/v1.1"
        imageRef="http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b"
        flavorRef="http://openstack.example.com/openstack/flavors/1"
        name="new-server-test"
        min_count="2"
        max_count="3"
        return_reservation_id="True">
  <metadata>
    <meta key="My Server Name">Apache1</meta>
  </metadata>
  <personality>
    <file path="/etc/banner.txt">
        ICAgICAgDQoiQSBjbG91ZCBkb2VzIG5vdCBrbm93IHdoeSBp
        dCBtb3ZlcyBpbiBqdXN0IHN1Y2ggYSBkaXJlY3Rpb24gYW5k
        IGF0IHN1Y2ggYSBzcGVlZC4uLkl0IGZlZWxzIGFuIGltcHVs
        c2lvbi4uLnRoaXMgaXMgdGhlIHBsYWNlIHRvIGdvIG5vdy4g
        QnV0IHRoZSBza3kga25vd3MgdGhlIHJlYXNvbnMgYW5kIHRo
        ZSBwYXR0ZXJucyBiZWhpbmQgYWxsIGNsb3VkcywgYW5kIHlv
        dSB3aWxsIGtub3csIHRvbywgd2hlbiB5b3UgbGlmdCB5b3Vy
        c2VsZiBoaWdoIGVub3VnaCB0byBzZWUgYmV5b25kIGhvcml6
        b25zLiINCg0KLVJpY2hhcmQgQmFjaA==
    </file>
  </personality>
</server>

{
    "server": {
        "adminPass": "wfksH3GTTseP",
        "id": "440cf918-3ee0-4143-b289-f63e1d2000e6",
        "links": [
            {
                "href": "http://openstack.example.com/v2/openstack/servers/440cf918-3ee0-4143-b289-f63e1d2000e6",
                "rel": "self"
            },
            {
                "href": "http://openstack.example.com/openstack/servers/440cf918-3ee0-4143-b289-f63e1d2000e6",
                "rel": "bookmark"
            }
        ]
    }
}

{
    "reservation_id": "r-3fhpjulh"
}

<?xml version='1.0' encoding='UTF-8'?>
<server xmlns:atom="http://www.w3.org/2005/Atom" xmlns="http://docs.openstack.org/compute/api/v1.1" id="0857bea2-df83-4810-876a-093a6b9afb15" adminPass="edBzA3AnJP67">
  <metadata/>
  <atom:link href="http://openstack.example.com/v2/openstack/servers/0857bea2-df83-4810-876a-093a6b9afb15" rel="self"/>
  <atom:link href="http://openstack.example.com/openstack/servers/0857bea2-df83-4810-876a-093a6b9afb15" rel="bookmark"/>
</server>

<?xml version='1.0' encoding='UTF-8'?>
<server xmlns:atom="http://www.w3.org/2005/Atom" xmlns="http://docs.openstack.org/compute/api/v1.1" reservation_id="r-fq0lg4za"/>

Servers with mac_addr extended attribute (servers)

Creates, shows information for, and lists servers with the mac_addr extended attribute.

POST

/v2/{tenant_id}/servers

Create server with OS-EXT-IPS-MAC:mac_addr extended attribute

Creates a server with the OS-EXT-IPS-MAC:mac_addr extended attribute.

Normal response codes

202

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
security_groups (Optional)	plain	xsd:string	One or more security groups. Specify the name of the security group in the `name` attribute. If you omit this attribute, the server is created in the `default` security group.
user_data (Optional)	plain	xsd:string	Configuration information or scripts to use upon launch. Must be Base64 encoded.
availability_zone (Optional)	plain	xsd:string	The availability zone in which to launch the server.
server	plain	csapi:ServerForCreate	server.
imageRef	plain	csapi:string	The image reference for the desired image for your server instance. Specify as an ID or full URL.
flavorRef	plain	csapi:string	The flavor reference for the desired flavor for your server instance. Specify as an ID or full URL.
networks (Optional)	plain	xsd:string	A `networks` object. By default, the server instance is provisioned with all isolated networks for the tenant. Optionally, you can create one or more NICs on the server. To provision the server instance with a NIC for a network, specify the UUID of the network in the `uuid` attribute in a `networks` object. To provision the server instance with a NIC for an already existing port, specify the port-id in the `port` attribute in a `networks` object. You can specify multiple NICs on the server.
uuid (Optional)	plain	xsd:string	To provision the server instance with a NIC for a network, specify the UUID of the network in the `uuid` attribute in a `networks` object. Required if you omit the `port` attribute.
port (Optional)	plain	xsd:string	To provision the server instance with a NIC for an already existing port, specify the port-id in the `port` attribute in a `networks` object. The port status must be `DOWN`. Required if you omit the `uuid` attribute.
fixed_ip (Optional)	plain	xsd:string	A fixed IPv4 address for the NIC. Valid with a `neutron` or `nova-networks` network.
name	plain	csapi:string	The server name.
metadata (Optional)	plain	csapi:string	Metadata key and value pairs. The maximum size of the metadata key and value is 255 bytes each.
personality (Optional)	plain	csapi:string	File path and contents (text only) to inject into the server at launch. The maximum size of the file path data is 255 bytes. The maximum limit refers to the number of bytes in the decoded data and not the number of characters in the encoded data.
block_device_mapping_v2 (Optional)	plain	csapi:string	Enables booting the server from a volume when additional parameters are given. If specified, the volume status must be `available`, and the volume `attach_status` in the OpenStack Block Storage database must be `detached`.
device_name	plain	csapi:string	Describes a path to the device for the volume you want to use to boot the server.
source_type	plain	csapi:string	The source type for the volume. A valid value is `blank`, `snapshot`, `volume`, or `image`.
destination_type (Optional)	plain	csapi:string	Defines where the volume comes from. A valid value is `local` or `volume`.
delete_on_termination	plain	csapi:string	To delete the boot volume when the server stops, specify `true`. Otherwise, specify `false`.
guest_format	plain	csapi:string	Specifies the guest server disk file system format, such as `ephemeral` or `swap`.
boot_index	plain	csapi:string	The boot order of the device. Use `-1` for the boot volume. Use `0` for an attached volume.
config_drive (Optional)	plain	xsd:boolean	Enables metadata injection in a server through a configuration drive. Specify `true` to enable a configuration drive. Otherwise, specify `false`.
key_name (Optional)	plain	xsd:string	Key pair name.
OS-EXT-IPS-MAC:mac_addr (Optional)	plain	xsd:string	Associated MAC address.

Response parameters

Parameter	Style	Type	Description
security_groups (Optional)	plain	xsd:string	One or more security groups. Specify the name of the security group in the `name` attribute. If you omit this attribute, the server is created in the `default` security group.
user_data (Optional)	plain	xsd:string	Configuration information or scripts to use upon launch. Must be Base64 encoded.
availability_zone (Optional)	plain	xsd:string	The availability zone in which to launch the server.
server	plain	csapi:ServerForCreate	server.
imageRef	plain	csapi:string	The image reference for the desired image for your server instance. Specify as an ID or full URL.
flavorRef	plain	csapi:string	The flavor reference for the desired flavor for your server instance. Specify as an ID or full URL.
networks (Optional)	plain	xsd:string	A `networks` object. By default, the server instance is provisioned with all isolated networks for the tenant. Optionally, you can create one or more NICs on the server. To provision the server instance with a NIC for a network, specify the UUID of the network in the `uuid` attribute in a `networks` object. To provision the server instance with a NIC for an already existing port, specify the port-id in the `port` attribute in a `networks` object. You can specify multiple NICs on the server.
uuid (Optional)	plain	xsd:string	To provision the server instance with a NIC for a network, specify the UUID of the network in the `uuid` attribute in a `networks` object. Required if you omit the `port` attribute.
port (Optional)	plain	xsd:string	To provision the server instance with a NIC for an already existing port, specify the port-id in the `port` attribute in a `networks` object. The port status must be `DOWN`. Required if you omit the `uuid` attribute.
fixed_ip (Optional)	plain	xsd:string	A fixed IPv4 address for the NIC. Valid with a `neutron` or `nova-networks` network.
name	plain	csapi:string	The server name.
metadata (Optional)	plain	csapi:string	Metadata key and value pairs. The maximum size of the metadata key and value is 255 bytes each.
personality (Optional)	plain	csapi:string	File path and contents (text only) to inject into the server at launch. The maximum size of the file path data is 255 bytes. The maximum limit refers to the number of bytes in the decoded data and not the number of characters in the encoded data.
block_device_mapping_v2 (Optional)	plain	csapi:string	Enables booting the server from a volume when additional parameters are given. If specified, the volume status must be `available`, and the volume `attach_status` in the OpenStack Block Storage database must be `detached`.
device_name	plain	csapi:string	Describes a path to the device for the volume you want to use to boot the server.
source_type	plain	csapi:string	The source type for the volume. A valid value is `blank`, `snapshot`, `volume`, or `image`.
destination_type (Optional)	plain	csapi:string	Defines where the volume comes from. A valid value is `local` or `volume`.
delete_on_termination	plain	csapi:string	To delete the boot volume when the server stops, specify `true`. Otherwise, specify `false`.
guest_format	plain	csapi:string	Specifies the guest server disk file system format, such as `ephemeral` or `swap`.
boot_index	plain	csapi:string	The boot order of the device. Use `-1` for the boot volume. Use `0` for an attached volume.
config_drive (Optional)	plain	xsd:boolean	Enables metadata injection in a server through a configuration drive. Specify `true` to enable a configuration drive. Otherwise, specify `false`.
key_name (Optional)	plain	xsd:string	Key pair name.

{
    "server": {
        "name": "new-server-test",
        "imageRef": "http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b",
        "flavorRef": "http://openstack.example.com/openstack/flavors/1",
        "metadata": {
            "My Server Name": "Apache1"
        },
        "personality": [
            {
                "path": "/etc/banner.txt",
                "contents": "ICAgICAgDQoiQSBjbG91ZCBkb2VzIG5vdCBrbm93IHdoeSBpdCBtb3ZlcyBpbiBqdXN0IHN1Y2ggYSBkaXJlY3Rpb24gYW5kIGF0IHN1Y2ggYSBzcGVlZC4uLkl0IGZlZWxzIGFuIGltcHVsc2lvbi4uLnRoaXMgaXMgdGhlIHBsYWNlIHRvIGdvIG5vdy4gQnV0IHRoZSBza3kga25vd3MgdGhlIHJlYXNvbnMgYW5kIHRoZSBwYXR0ZXJucyBiZWhpbmQgYWxsIGNsb3VkcywgYW5kIHlvdSB3aWxsIGtub3csIHRvbywgd2hlbiB5b3UgbGlmdCB5b3Vyc2VsZiBoaWdoIGVub3VnaCB0byBzZWUgYmV5b25kIGhvcml6b25zLiINCg0KLVJpY2hhcmQgQmFjaA=="
            }
        ]
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<server xmlns="http://docs.openstack.org/compute/api/v1.1" imageRef="http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b" flavorRef="http://openstack.example.com/openstack/flavors/1" name="new-server-test">
  <metadata>
    <meta key="My Server Name">Apache1</meta>
  </metadata>
  <personality>
    <file path="/etc/banner.txt">
        ICAgICAgDQoiQSBjbG91ZCBkb2VzIG5vdCBrbm93IHdoeSBp
        dCBtb3ZlcyBpbiBqdXN0IHN1Y2ggYSBkaXJlY3Rpb24gYW5k
        IGF0IHN1Y2ggYSBzcGVlZC4uLkl0IGZlZWxzIGFuIGltcHVs
        c2lvbi4uLnRoaXMgaXMgdGhlIHBsYWNlIHRvIGdvIG5vdy4g
        QnV0IHRoZSBza3kga25vd3MgdGhlIHJlYXNvbnMgYW5kIHRo
        ZSBwYXR0ZXJucyBiZWhpbmQgYWxsIGNsb3VkcywgYW5kIHlv
        dSB3aWxsIGtub3csIHRvbywgd2hlbiB5b3UgbGlmdCB5b3Vy
        c2VsZiBoaWdoIGVub3VnaCB0byBzZWUgYmV5b25kIGhvcml6
        b25zLiINCg0KLVJpY2hhcmQgQmFjaA==
    </file>
  </personality>
</server>

{
    "server": {
        "adminPass": "zD7wDKTXiHsp",
        "id": "b44e5008-42f7-4048-b4c8-f40a29da88ba",
        "links": [
            {
                "href": "http://openstack.example.com/v2/openstack/servers/b44e5008-42f7-4048-b4c8-f40a29da88ba",
                "rel": "self"
            },
            {
                "href": "http://openstack.example.com/openstack/servers/b44e5008-42f7-4048-b4c8-f40a29da88ba",
                "rel": "bookmark"
            }
        ]
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<server xmlns:atom="http://www.w3.org/2005/Atom" xmlns="http://docs.openstack.org/compute/api/v1.1" id="752dd57d-933b-4a57-a0ae-4c3431c5abc7" adminPass="B2gvFFjBQCVQ">
  <metadata/>
  <atom:link href="http://openstack.example.com/v2/openstack/servers/752dd57d-933b-4a57-a0ae-4c3431c5abc7" rel="self"/>
  <atom:link href="http://openstack.example.com/openstack/servers/752dd57d-933b-4a57-a0ae-4c3431c5abc7" rel="bookmark"/>
</server>

GET

/v2/{tenant_id}/servers/{server_id}

Show server information

Shows information for a specified server. Includes the OS-EXT-IPS-MAC:mac_addr extended attribute.

Normal response codes

202

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
server_id	URI	csapi:UUID	The UUID for the server of interest to you.

Response parameters

Parameter	Style	Type	Description
security_groups (Optional)	plain	xsd:string	One or more security groups. Specify the name of the security group in the `name` attribute. If you omit this attribute, the server is created in the `default` security group.
user_data (Optional)	plain	xsd:string	Configuration information or scripts to use upon launch. Must be Base64 encoded.
availability_zone (Optional)	plain	xsd:string	The availability zone in which to launch the server.
server	plain	csapi:ServerForCreate	server.
imageRef	plain	csapi:string	The image reference for the desired image for your server instance. Specify as an ID or full URL.
flavorRef	plain	csapi:string	The flavor reference for the desired flavor for your server instance. Specify as an ID or full URL.
networks (Optional)	plain	xsd:string	A `networks` object. By default, the server instance is provisioned with all isolated networks for the tenant. Optionally, you can create one or more NICs on the server. To provision the server instance with a NIC for a network, specify the UUID of the network in the `uuid` attribute in a `networks` object. To provision the server instance with a NIC for an already existing port, specify the port-id in the `port` attribute in a `networks` object. You can specify multiple NICs on the server.
uuid (Optional)	plain	xsd:string	To provision the server instance with a NIC for a network, specify the UUID of the network in the `uuid` attribute in a `networks` object. Required if you omit the `port` attribute.
port (Optional)	plain	xsd:string	To provision the server instance with a NIC for an already existing port, specify the port-id in the `port` attribute in a `networks` object. The port status must be `DOWN`. Required if you omit the `uuid` attribute.
fixed_ip (Optional)	plain	xsd:string	A fixed IPv4 address for the NIC. Valid with a `neutron` or `nova-networks` network.
name	plain	csapi:string	The server name.
metadata (Optional)	plain	csapi:string	Metadata key and value pairs. The maximum size of the metadata key and value is 255 bytes each.
personality (Optional)	plain	csapi:string	File path and contents (text only) to inject into the server at launch. The maximum size of the file path data is 255 bytes. The maximum limit refers to the number of bytes in the decoded data and not the number of characters in the encoded data.
block_device_mapping_v2 (Optional)	plain	csapi:string	Enables booting the server from a volume when additional parameters are given. If specified, the volume status must be `available`, and the volume `attach_status` in the OpenStack Block Storage database must be `detached`.
device_name	plain	csapi:string	Describes a path to the device for the volume you want to use to boot the server.
source_type	plain	csapi:string	The source type for the volume. A valid value is `blank`, `snapshot`, `volume`, or `image`.
destination_type (Optional)	plain	csapi:string	Defines where the volume comes from. A valid value is `local` or `volume`.
delete_on_termination	plain	csapi:string	To delete the boot volume when the server stops, specify `true`. Otherwise, specify `false`.
guest_format	plain	csapi:string	Specifies the guest server disk file system format, such as `ephemeral` or `swap`.
boot_index	plain	csapi:string	The boot order of the device. Use `-1` for the boot volume. Use `0` for an attached volume.
config_drive (Optional)	plain	xsd:boolean	Enables metadata injection in a server through a configuration drive. Specify `true` to enable a configuration drive. Otherwise, specify `false`.
key_name (Optional)	plain	xsd:string	Key pair name.
OS-EXT-IPS-MAC:mac_addr (Optional)	plain	xsd:string	Associated MAC address.

{
    "server": {
        "accessIPv4": "",
        "accessIPv6": "",
        "addresses": {
            "private": [
                {
                    "addr": "192.168.0.3",
                    "version": 4,
                    "OS-EXT-IPS-MAC:mac_addr": "00:0c:29:e1:42:90"
                }
            ]
        },
        "created": "2013-02-07T18:46:28Z",
        "flavor": {
            "id": "1",
            "links": [
                {
                    "href": "http://openstack.example.com/openstack/flavors/1",
                    "rel": "bookmark"
                }
            ]
        },
        "hostId": "4e2003eddbfdb1280c2618d04090bcdd6773203b8da8347af0b2723d",
        "id": "dc7281f9-ee47-40b9-9950-9f73e7961caa",
        "image": {
            "id": "70a599e0-31e7-49b7-b260-868f441e862b",
            "links": [
                {
                    "href": "http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b",
                    "rel": "bookmark"
                }
            ]
        },
        "links": [
            {
                "href": "http://openstack.example.com/v2/openstack/servers/dc7281f9-ee47-40b9-9950-9f73e7961caa",
                "rel": "self"
            },
            {
                "href": "http://openstack.example.com/openstack/servers/dc7281f9-ee47-40b9-9950-9f73e7961caa",
                "rel": "bookmark"
            }
        ],
        "metadata": {
            "My Server Name": "Apache1"
        },
        "name": "new-server-test",
        "progress": 0,
        "status": "ACTIVE",
        "tenant_id": "openstack",
        "updated": "2013-02-07T18:46:29Z",
        "user_id": "fake"
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<server xmlns:OS-EXT-IPS-MAC="http://docs.openstack.org/compute/ext/extended_ips_mac/api/v1.1" xmlns:atom="http://www.w3.org/2005/Atom" xmlns="http://docs.openstack.org/compute/api/v1.1" status="ACTIVE" updated="2013-02-07T18:46:29Z" hostId="068cc5e2de14b6e533a239c6eac0a0bdedcd57cab25450a6d3da43af" name="new-server-test" created="2013-02-07T18:46:28Z" userId="fake" tenantId="openstack" accessIPv4="" accessIPv6="" progress="0" id="22e7cf4d-ab7a-4a3d-9599-7d0dbaf9ed55">
  <image id="70a599e0-31e7-49b7-b260-868f441e862b">
    <atom:link href="http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b" rel="bookmark"/>
  </image>
  <flavor id="1">
    <atom:link href="http://openstack.example.com/openstack/flavors/1" rel="bookmark"/>
  </flavor>
  <metadata>
    <meta key="My Server Name">Apache1</meta>
  </metadata>
  <addresses>
    <network id="private">
      <ip version="4" addr="192.168.0.3" OS-EXT-IPS-MAC:mac_addr="00:0c:29:e1:42:90"/>
    </network>
  </addresses>
  <atom:link href="http://openstack.example.com/v2/openstack/servers/22e7cf4d-ab7a-4a3d-9599-7d0dbaf9ed55" rel="self"/>
  <atom:link href="http://openstack.example.com/openstack/servers/22e7cf4d-ab7a-4a3d-9599-7d0dbaf9ed55" rel="bookmark"/>
</server>

This operation does not accept a request body.

GET

/v2/{tenant_id}/servers/detail

Get server details

Lists details for all servers. Includes the OS-EXT-IPS-MAC:mac_addr extended attribute.

Normal response codes

202

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
changes-since (Optional)	query	xsd:dateTime	A time/date stamp for when the server last changed status.
image (Optional)	query	csapi:UUID	The UUID for the image.
flavor (Optional)	query	csapi:UUID	The UUID for the specific flavor, which is a combination of memory, disk size, and CPUs.
name (Optional)	query	regexp	Name of the server as a string. Can be queried with regular expressions. The regular expression `?name=bob` returns both bob and bobb. If you must match on only bob, you can use a regular expression that matches the syntax of the underlying database server that is implemented for Compute, such as MySQL or PostgreSQL.
status (Optional)	query	csapi:ServerStatus	Value of the status of the server so that you can filter on "ACTIVE" for example.
host (Optional)	query	xsd:string	Name of the host as a string.

Response parameters

Parameter	Style	Type	Description
security_groups (Optional)	plain	xsd:string	One or more security groups. Specify the name of the security group in the `name` attribute. If you omit this attribute, the server is created in the `default` security group.
user_data (Optional)	plain	xsd:string	Configuration information or scripts to use upon launch. Must be Base64 encoded.
availability_zone (Optional)	plain	xsd:string	The availability zone in which to launch the server.
server	plain	csapi:ServerForCreate	server.
imageRef	plain	csapi:string	The image reference for the desired image for your server instance. Specify as an ID or full URL.
flavorRef	plain	csapi:string	The flavor reference for the desired flavor for your server instance. Specify as an ID or full URL.
networks (Optional)	plain	xsd:string	A `networks` object. By default, the server instance is provisioned with all isolated networks for the tenant. Optionally, you can create one or more NICs on the server. To provision the server instance with a NIC for a network, specify the UUID of the network in the `uuid` attribute in a `networks` object. To provision the server instance with a NIC for an already existing port, specify the port-id in the `port` attribute in a `networks` object. You can specify multiple NICs on the server.
uuid (Optional)	plain	xsd:string	To provision the server instance with a NIC for a network, specify the UUID of the network in the `uuid` attribute in a `networks` object. Required if you omit the `port` attribute.
port (Optional)	plain	xsd:string	To provision the server instance with a NIC for an already existing port, specify the port-id in the `port` attribute in a `networks` object. The port status must be `DOWN`. Required if you omit the `uuid` attribute.
fixed_ip (Optional)	plain	xsd:string	A fixed IPv4 address for the NIC. Valid with a `neutron` or `nova-networks` network.
name	plain	csapi:string	The server name.
metadata (Optional)	plain	csapi:string	Metadata key and value pairs. The maximum size of the metadata key and value is 255 bytes each.
personality (Optional)	plain	csapi:string	File path and contents (text only) to inject into the server at launch. The maximum size of the file path data is 255 bytes. The maximum limit refers to the number of bytes in the decoded data and not the number of characters in the encoded data.
block_device_mapping_v2 (Optional)	plain	csapi:string	Enables booting the server from a volume when additional parameters are given. If specified, the volume status must be `available`, and the volume `attach_status` in the OpenStack Block Storage database must be `detached`.
device_name	plain	csapi:string	Describes a path to the device for the volume you want to use to boot the server.
source_type	plain	csapi:string	The source type for the volume. A valid value is `blank`, `snapshot`, `volume`, or `image`.
destination_type (Optional)	plain	csapi:string	Defines where the volume comes from. A valid value is `local` or `volume`.
delete_on_termination	plain	csapi:string	To delete the boot volume when the server stops, specify `true`. Otherwise, specify `false`.
guest_format	plain	csapi:string	Specifies the guest server disk file system format, such as `ephemeral` or `swap`.
boot_index	plain	csapi:string	The boot order of the device. Use `-1` for the boot volume. Use `0` for an attached volume.
config_drive (Optional)	plain	xsd:boolean	Enables metadata injection in a server through a configuration drive. Specify `true` to enable a configuration drive. Otherwise, specify `false`.
key_name (Optional)	plain	xsd:string	Key pair name.
OS-EXT-IPS-MAC:mac_addr (Optional)	plain	xsd:string	Associated MAC address.

{
    "servers": [
        {
            "accessIPv4": "",
            "accessIPv6": "",
            "addresses": {
                "private": [
                    {
                        "addr": "192.168.0.3",
                        "version": 4,
                        "OS-EXT-IPS-MAC:mac_addr": "00:0c:29:e1:42:90"
                    }
                ]
            },
            "created": "2013-02-07T18:40:59Z",
            "flavor": {
                "id": "1",
                "links": [
                    {
                        "href": "http://openstack.example.com/openstack/flavors/1",
                        "rel": "bookmark"
                    }
                ]
            },
            "hostId": "fe866a4962fe3bdb6c2db9c8f7dcdb9555aca73387e72b5cb9c45bd3",
            "id": "76908712-653a-4d16-807e-d89d41435d24",
            "image": {
                "id": "70a599e0-31e7-49b7-b260-868f441e862b",
                "links": [
                    {
                        "href": "http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b",
                        "rel": "bookmark"
                    }
                ]
            },
            "links": [
                {
                    "href": "http://openstack.example.com/v2/openstack/servers/76908712-653a-4d16-807e-d89d41435d24",
                    "rel": "self"
                },
                {
                    "href": "http://openstack.example.com/openstack/servers/76908712-653a-4d16-807e-d89d41435d24",
                    "rel": "bookmark"
                }
            ],
            "metadata": {
                "My Server Name": "Apache1"
            },
            "name": "new-server-test",
            "progress": 0,
            "status": "ACTIVE",
            "tenant_id": "openstack",
            "updated": "2013-02-07T18:40:59Z",
            "user_id": "fake"
        }
    ]
}

<?xml version='1.0' encoding='UTF-8'?>
<servers xmlns:OS-EXT-IPS-MAC="http://docs.openstack.org/compute/ext/extended_ips_mac/api/v1.1" xmlns:atom="http://www.w3.org/2005/Atom" xmlns="http://docs.openstack.org/compute/api/v1.1">
  <server status="ACTIVE" updated="2013-02-07T18:40:59Z" hostId="51a80e6ee89b638b2cb57eb4e39d89a725e07c8a698f4d8e256f8665" name="new-server-test" created="2013-02-07T18:40:59Z" userId="fake" tenantId="openstack" accessIPv4="" accessIPv6="" progress="0" id="0337de6b-1d43-46c8-8804-35669f1dea9a">
    <image id="70a599e0-31e7-49b7-b260-868f441e862b">
      <atom:link href="http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b" rel="bookmark"/>
    </image>
    <flavor id="1">
      <atom:link href="http://openstack.example.com/openstack/flavors/1" rel="bookmark"/>
    </flavor>
    <metadata>
      <meta key="My Server Name">Apache1</meta>
    </metadata>
    <addresses>
      <network id="private">
        <ip version="4" addr="192.168.0.3" OS-EXT-IPS-MAC:mac_addr="00:0c:29:e1:42:90"/>
      </network>
    </addresses>
    <atom:link href="http://openstack.example.com/v2/openstack/servers/0337de6b-1d43-46c8-8804-35669f1dea9a" rel="self"/>
    <atom:link href="http://openstack.example.com/openstack/servers/0337de6b-1d43-46c8-8804-35669f1dea9a" rel="bookmark"/>
  </server>
</servers>

Servers with scheduler hints (servers)

Creates a server with scheduler hints.

POST

/v2/{tenant_id}/servers

Create server with scheduler hints

Creates a server with scheduler hints that are passed directly to the scheduler.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
security_groups (Optional)	plain	xsd:string	One or more security groups. Specify the name of the security group in the `name` attribute. If you omit this attribute, the server is created in the `default` security group.
user_data (Optional)	plain	xsd:string	Configuration information or scripts to use upon launch. Must be Base64 encoded.
availability_zone (Optional)	plain	xsd:string	The availability zone in which to launch the server.
server	plain	csapi:ServerForCreate	server.
imageRef	plain	csapi:string	The image reference for the desired image for your server instance. Specify as an ID or full URL.
flavorRef	plain	csapi:string	The flavor reference for the desired flavor for your server instance. Specify as an ID or full URL.
networks (Optional)	plain	xsd:string	A `networks` object. By default, the server instance is provisioned with all isolated networks for the tenant. Optionally, you can create one or more NICs on the server. To provision the server instance with a NIC for a network, specify the UUID of the network in the `uuid` attribute in a `networks` object. To provision the server instance with a NIC for an already existing port, specify the port-id in the `port` attribute in a `networks` object. You can specify multiple NICs on the server.
uuid (Optional)	plain	xsd:string	To provision the server instance with a NIC for a network, specify the UUID of the network in the `uuid` attribute in a `networks` object. Required if you omit the `port` attribute.
port (Optional)	plain	xsd:string	To provision the server instance with a NIC for an already existing port, specify the port-id in the `port` attribute in a `networks` object. The port status must be `DOWN`. Required if you omit the `uuid` attribute.
fixed_ip (Optional)	plain	xsd:string	A fixed IPv4 address for the NIC. Valid with a `neutron` or `nova-networks` network.
name	plain	csapi:string	The server name.
metadata (Optional)	plain	csapi:string	Metadata key and value pairs. The maximum size of the metadata key and value is 255 bytes each.
personality (Optional)	plain	csapi:string	File path and contents (text only) to inject into the server at launch. The maximum size of the file path data is 255 bytes. The maximum limit refers to the number of bytes in the decoded data and not the number of characters in the encoded data.
block_device_mapping_v2 (Optional)	plain	csapi:string	Enables booting the server from a volume when additional parameters are given. If specified, the volume status must be `available`, and the volume `attach_status` in the OpenStack Block Storage database must be `detached`.
device_name	plain	csapi:string	Describes a path to the device for the volume you want to use to boot the server.
source_type	plain	csapi:string	The source type for the volume. A valid value is `blank`, `snapshot`, `volume`, or `image`.
destination_type (Optional)	plain	csapi:string	Defines where the volume comes from. A valid value is `local` or `volume`.
delete_on_termination	plain	csapi:string	To delete the boot volume when the server stops, specify `true`. Otherwise, specify `false`.
guest_format	plain	csapi:string	Specifies the guest server disk file system format, such as `ephemeral` or `swap`.
boot_index	plain	csapi:string	The boot order of the device. Use `-1` for the boot volume. Use `0` for an attached volume.
config_drive (Optional)	plain	xsd:boolean	Enables metadata injection in a server through a configuration drive. Specify `true` to enable a configuration drive. Otherwise, specify `false`.
key_name (Optional)	plain	xsd:string	Key pair name.
os:scheduler_hints	plain	xsd:dict	Dictionary of data to send to the scheduler. Alternatively, you can specify `OS-SCH-HNT:scheduler_hints` as the string.

Response parameters

Parameter	Style	Type	Description
security_groups (Optional)	plain	xsd:string	One or more security groups. Specify the name of the security group in the `name` attribute. If you omit this attribute, the server is created in the `default` security group.
user_data (Optional)	plain	xsd:string	Configuration information or scripts to use upon launch. Must be Base64 encoded.
availability_zone (Optional)	plain	xsd:string	The availability zone in which to launch the server.
server	plain	csapi:ServerForCreate	server.
imageRef	plain	csapi:string	The image reference for the desired image for your server instance. Specify as an ID or full URL.
flavorRef	plain	csapi:string	The flavor reference for the desired flavor for your server instance. Specify as an ID or full URL.
networks (Optional)	plain	xsd:string	A `networks` object. By default, the server instance is provisioned with all isolated networks for the tenant. Optionally, you can create one or more NICs on the server. To provision the server instance with a NIC for a network, specify the UUID of the network in the `uuid` attribute in a `networks` object. To provision the server instance with a NIC for an already existing port, specify the port-id in the `port` attribute in a `networks` object. You can specify multiple NICs on the server.
uuid (Optional)	plain	xsd:string	To provision the server instance with a NIC for a network, specify the UUID of the network in the `uuid` attribute in a `networks` object. Required if you omit the `port` attribute.
port (Optional)	plain	xsd:string	To provision the server instance with a NIC for an already existing port, specify the port-id in the `port` attribute in a `networks` object. The port status must be `DOWN`. Required if you omit the `uuid` attribute.
fixed_ip (Optional)	plain	xsd:string	A fixed IPv4 address for the NIC. Valid with a `neutron` or `nova-networks` network.
name	plain	csapi:string	The server name.
metadata (Optional)	plain	csapi:string	Metadata key and value pairs. The maximum size of the metadata key and value is 255 bytes each.
personality (Optional)	plain	csapi:string	File path and contents (text only) to inject into the server at launch. The maximum size of the file path data is 255 bytes. The maximum limit refers to the number of bytes in the decoded data and not the number of characters in the encoded data.
block_device_mapping_v2 (Optional)	plain	csapi:string	Enables booting the server from a volume when additional parameters are given. If specified, the volume status must be `available`, and the volume `attach_status` in the OpenStack Block Storage database must be `detached`.
device_name	plain	csapi:string	Describes a path to the device for the volume you want to use to boot the server.
source_type	plain	csapi:string	The source type for the volume. A valid value is `blank`, `snapshot`, `volume`, or `image`.
destination_type (Optional)	plain	csapi:string	Defines where the volume comes from. A valid value is `local` or `volume`.
delete_on_termination	plain	csapi:string	To delete the boot volume when the server stops, specify `true`. Otherwise, specify `false`.
guest_format	plain	csapi:string	Specifies the guest server disk file system format, such as `ephemeral` or `swap`.
boot_index	plain	csapi:string	The boot order of the device. Use `-1` for the boot volume. Use `0` for an attached volume.
config_drive (Optional)	plain	xsd:boolean	Enables metadata injection in a server through a configuration drive. Specify `true` to enable a configuration drive. Otherwise, specify `false`.
key_name (Optional)	plain	xsd:string	Key pair name.

{
    "server": {
        "name": "new-server-test",
        "imageRef": "70a599e0-31e7-49b7-b260-868f441e862b",
        "flavorRef": "1"
    },
    "os:scheduler_hints": {
        "hypervisor": "xen",
        "near": "2b7c42eb-7736-4a0f-afab-f23969a35ada"
    }
}

<server
        xmlns="http://docs.openstack.org/compute/api/v1.1"
        xmlns:OS-SCH-HNT="http://docs.openstack.org/compute/ext/scheduler-hints/api/v2"
        name='new-server-test'
        imageRef='70a599e0-31e7-49b7-b260-868f441e862b'
        flavorRef='1'
>
        <OS-SCH-HNT:scheduler_hints>
                <hypervisor>xen</hypervisor>
                <near>eb999657-dd6b-464e-8713-95c532ac3b18</near>
        </OS-SCH-HNT:scheduler_hints>
</server>

{
    "server": {
        "adminPass": "yjzytFHb7XHc",
        "id": "f8f4f3ce-f6e0-4e05-8f79-bf984fdfce45",
        "links": [
            {
                "href": "http://openstack.example.com/v2/openstack/servers/f8f4f3ce-f6e0-4e05-8f79-bf984fdfce45",
                "rel": "self"
            },
            {
                "href": "http://openstack.example.com/openstack/servers/f8f4f3ce-f6e0-4e05-8f79-bf984fdfce45",
                "rel": "bookmark"
            }
        ]
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<server xmlns:atom="http://www.w3.org/2005/Atom" xmlns="http://docs.openstack.org/compute/api/v1.1" id="a14a9bf5-93b3-49e4-85f1-01d7cf2645b4" adminPass="Q6jfHPrnvB9X">
  <metadata/>
  <atom:link href="http://openstack.example.com/v2/openstack/servers/a14a9bf5-93b3-49e4-85f1-01d7cf2645b4" rel="self"/>
  <atom:link href="http://openstack.example.com/openstack/servers/a14a9bf5-93b3-49e4-85f1-01d7cf2645b4" rel="bookmark"/>
</server>

Servers administrative actions (servers, action)

Administrator only. Performs actions on a server. Specify the action in the request body.

POST

/v2/{tenant_id}/servers/{server_id}/action

Pause server

Pauses a server. Changes its status to PAUSED.

This operation stores the state of the VM in RAM. A paused instance continues to run in a frozen state.

Normal response codes

202

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
server_id	URI	csapi:UUID	The UUID for the server of interest to you.
pause	plain	xsd:string	Specify the `pause` action in the request body.

{
    "pause": null
}

<?xml version="1.0" encoding="UTF-8"?>
<pause />

This operation does not return a response body.

POST

/v2/{tenant_id}/servers/{server_id}/action

Unpause server

Unpauses a PAUSED server. Changes its status to ACTIVE.

Normal response codes

202

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
server_id	URI	csapi:UUID	The UUID for the server of interest to you.
unpause	plain	xsd:string	Specify the `unpause` action in the request body.

{
    "unpause": null
}

<?xml version="1.0" encoding="UTF-8"?>
<unpause />

This operation does not return a response body.

POST

/v2/{tenant_id}/servers/{server_id}/action

Suspend server

Suspends a server. Changes its status to SUSPENDED.

This operation stores the VM state on disk, writes all memory to disk, and stops the virtual machine.

Administrative users might suspend an infrequently used instance or suspend an instance to perform system maintenance. Suspending an instance is similar to placing a device in hibernation; memory and vCPUs become available to create other instances.

Normal response codes

202

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
server_id	URI	csapi:UUID	The UUID for the server of interest to you.
suspend	plain	xsd:string	Specify the `suspend` action in the request body.

{
    "suspend": null
}

<?xml version="1.0" encoding="UTF-8"?>
<suspend />

This operation does not return a response body.

POST

/v2/{tenant_id}/servers/{server_id}/action

Resume server

Resumes a SUSPENDED server. Changes its status to ACTIVE.

Normal response codes

202

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
server_id	URI	csapi:UUID	The UUID for the server of interest to you.
resume	plain	xsd:string	Specify the `resume` action in the request body.

{
    "resume": null
}

<?xml version="1.0" encoding="UTF-8"?>
<resume />

This operation does not return a response body.

POST

/v2/{tenant_id}/servers/{server_id}/action

Migrate server

Migrates a server to a host. The scheduler chooses the host.

Normal response codes

202

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
server_id	URI	csapi:UUID	The UUID for the server of interest to you.
migrate	plain	xsd:string	Specify the `migrate` action in the request body.

{
    "migrate": null
}

<?xml version="1.0" encoding="UTF-8"?>
<migrate />

This operation does not return a response body.

POST

/v2/{tenant_id}/servers/{server_id}/action

Reset networking on server

Resets networking on a server.

Normal response codes

202

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
server_id	URI	csapi:UUID	The UUID for the server of interest to you.
resetNetwork	plain	xsd:string	Specify the `resetNetwork` action in the request body.

{
    "resetNetwork": null
}

<?xml version="1.0" encoding="UTF-8"?>
<resetNetwork />

This operation does not return a response body.

POST

/v2/{tenant_id}/servers/{server_id}/action

Inject network information

Injects network information into a server.

Normal response codes

202

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
server_id	URI	csapi:UUID	The UUID for the server of interest to you.
injectNetworkInfo	plain	xsd:string	Specify the `injectNetworkInfo` action in the request body.

{
    "injectNetworkInfo": null
}

<?xml version="1.0" encoding="UTF-8"?>
<injectNetworkInfo />

This operation does not return a response body.

POST

/v2/{tenant_id}/servers/{server_id}/action

Lock server

Locks a server.

Normal response codes

202

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
server_id	URI	csapi:UUID	The UUID for the server of interest to you.
lock	plain	xsd:string	Specify the `lock` action in the request body.

{
    "lock": null
}

<?xml version="1.0" encoding="UTF-8"?>
<lock />

This operation does not return a response body.

POST

/v2/{tenant_id}/servers/{server_id}/action

Unlock server

Unlocks a server.

Normal response codes

202

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
server_id	URI	csapi:UUID	The UUID for the server of interest to you.
unlock	plain	xsd:string	Specify the `unlock` action in the request body.

{
    "unlock": null
}

<?xml version="1.0" encoding="UTF-8"?>
<unlock />

This operation does not return a response body.

POST

/v2/{tenant_id}/servers/{server_id}/action

Create server backup

Backs up a server instance.

Normal response codes

202

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
server_id	URI	csapi:UUID	The UUID for the server of interest to you.
createBackup	plain	xsd:string	Specify the `createBackup` action in the request body.
name	plain	xsd:string	Name of the backup image.
backup_type	plain	xsd:string	The backup type. Either 'daily' or 'weekly.'
rotation	plain	xsd:int	An integer value that represents the number of backups to maintain.

{
    "createBackup": {
        "name": "Backup 1",
        "backup_type": "daily",
        "rotation": 1
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<createBackup>
    <name>Backup 1</name>
    <backup_type>daily</backup_type>
    <rotation>1</rotation>
</createBackup>

This operation does not return a response body.

POST

/v2/{tenant_id}/servers/{server_id}/action

Live-migrate server

Live-migrates a server to a new host without rebooting.

Normal response codes

202

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
server_id	URI	csapi:UUID	The UUID for the server of interest to you.
os-migrateLive	plain	xsd:string	Specify the `os-migrateLive` action in the request body.
host	plain	xsd:string	Name of the new host.
block_migration	plain	xsd:boolean	If true, block migration is allowed.
disk_over_commit	plain	xsd:boolean	If true, disk over commit is allowed.

{
    "os-migrateLive": {
        "host": "0443e9a1254044d8b99f35eace132080",
        "block_migration": false,
        "disk_over_commit": false
    }
}

<?xml version="1.0" encoding="UTF-8" ?>
<os-migrateLive>
    <host>6217bf142bb3491995f966af999f9f23</host>
    <block_migration>false</block_migration>
    <disk_over_commit>false</disk_over_commit>
</os-migrateLive>

This operation does not return a response body.

POST

/v2/{tenant_id}/servers/{server_id}/action

Reset server state

Resets the state of a server to a specified state.

Normal response codes

202

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
server_id	URI	csapi:UUID	The UUID for the server of interest to you.
resetState	plain	xsd:string	Specify the `resetState` action in the request body.
state	plain	xsd:string	The desired state of a server.

{
    "os-resetState": {
        "state": "active"
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<os-resetState>
    <state>active</state>
</os-resetState>

This operation does not return a response body.

POST

/v2/{tenant_id}/servers/{server_id}/action

Evacuate server

Evacuates a server from failed host.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
server_id	URI	csapi:UUID	The UUID for the server of interest to you.
evacuate	plain	xsd:string	Specify the `evacuate` action in the request body.
host (Optional)	plain	xsd:string	The name or ID of the host where the server is evacuated.
adminPass (Optional)	plain	xsd:string	Specifies a new admin password for the evacuated instance.
onSharedStorage	plain	xsd:string	If server is on shared storage, set to True. Otherwise, set to False.

{
    "evacuate": {
        "host": "TargetHost",
        "adminPass": "MySecretPass",
        "onSharedStorage": "True"
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<evacuate xmlns="http://docs.openstack.org/compute/api/v2"
    host="TargetHost"
    adminPass="MySecretPass"
    onSharedStorage="True"/>

{
    "adminPass": "MySecretPass"
}

<?xml version='1.0' encoding='UTF-8'?>
<adminPass>MySecretPass</adminPass>

POST

/v2/{tenant_id}/servers/{server_id}/action

Add floating IP address

Adds a floating IP address to an instance.

You can optionally associate a fixed IP address with the floating IP address.

Normal response codes

200

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
server_id	URI	csapi:UUID	The UUID for the server of interest to you.
addFloatingIp	plain	xsd:string	Specify the `addFloatingIP` action in the request body.
fixed_address (Optional)	plain	xsd:string	A fixed IP address that you want to associate with the floating IP address.
address	plain	xsd:string	A floating IP address to associate with the instance.

{
    "addFloatingIp": {
        "fixed_address": "166.78.185.201",
        "address": "172.24.4.225"
    }
}

This operation does not return a response body.

Servers deferred delete (servers, action)

Force-deletes a server and restores a deleted server.

POST

/v2/{tenant_id}/servers/{server_id}/action

Force delete server

Force-deletes a server.

Normal response codes

202

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
server_id	URI	csapi:UUID	The UUID for the server of interest to you.
forceDelete	plain	xsd:string	Specify the `forceDelete` action in the request body.

{
    "forceDelete": null
}

<?xml version="1.0" encoding="UTF-8"?>
<forceDelete />

This operation does not return a response body.

POST

/v2/{tenant_id}/servers/{server_id}/action

Restore server

Restores a deleted server.

Normal response codes

202

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
server_id	URI	csapi:UUID	The UUID for the server of interest to you.
restore	plain	xsd:string	Specify the `restore` action in the request body.

{
    "restore": null
}

<?xml version="1.0" encoding="UTF-8"?>
<restore />

This operation does not return a response body.

Servers rescue and unrescue (servers, action)

Puts a server into rescue mode and unrescues a server in rescue mode.

POST

/v2/{tenant_id}/servers/{server_id}/action

Rescue server

Puts a server in rescue mode. Changes status to RESCUE.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
server_id	URI	csapi:UUID	The UUID for the server of interest to you.
rescue	plain	xsd:string	Specify the `rescue` action in the request body.
adminPass (Optional)	plain	csapi:string	Use this password for the rescued instance. Generate a new password if none is provided.

{
    "rescue": {
        "adminPass": "MySecretPass"
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<rescue xmlns="http://docs.openstack.org/compute/api/v1.1"
    adminPass="MySecretPass"/>

{
    "adminPass": "MySecretPass"
}

<?xml version='1.0' encoding='UTF-8'?>
<adminPass>MySecretPass</adminPass>

POST

/v2/{tenant_id}/servers/{server_id}/action

Unrescue server

Unrescues a server.

Normal response codes

202

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
server_id	URI	csapi:UUID	The UUID for the server of interest to you.
unrescue	plain	xsd:string	Specify the `unrescue` action in the request body.

{
    "unrescue": null
}

<?xml version="1.0" encoding="UTF-8"?>
<unrescue xmlns="http://docs.openstack.org/compute/api/v1.1"/>

This operation does not return a response body.

Servers shelve (servers, action)

Shelves running servers, restores shelved servers, and removes shelved servers.

Shelving is useful when you have an unused instance that you would like to keep for later use. For example, at the end of a work week you can shelve an instance and at the start of the next week you can unshelve it.

Your cloud provider might bill you for a shelved server.

Use the shelve action to shelve a server. All associated data and resources are kept but anything still in memory is not retained.

Use the unshelve action to restore a shelved instance.

Use the shelveOffload action to remove a shelved instance that you no longer need.

POST

/v2/{tenant_id}/servers/{server_id}/action

Shelve server

Shelves a running server.

All associated data and resources are kept; however, anything still in memory is not retained. To restore a shelved instance, use the unshelve action. To remove a shelved instance, use the shelveOffload action.

Preconditions

The server status must be ACTIVE, SHUTOFF, PAUSED, or SUSPENDED.
If the specified server is locked, you must have administrator privileges to shelve the server.

Asynchronous Postconditions

After successfully shelving a server, its status changes to SHELVED and the image status is ACTIVE. The server instance data appears on the compute node that the Compute service manages.
The Compute service automatically deletes the instance on compute nodes and changes the server status to SHELVED_OFFLOADED if the server is booted from volumes or shelved_offload_time is set to 0.

Troubleshooting

If the server status does not change to SHELVED or SHELVED_OFFLOADED, the shelve operation failed. Ensure that you meet the preconditions and run the request again. If the request fails again, investigate whether another operation is running that causes a race condition.

Normal response codes

202

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
server_id	URI	csapi:UUID	The UUID for the server of interest to you.
shelve	plain	xsd:string	Specify the `shelve` action in the request body.

{
    "shelve": null
}

<?xml version="1.0" encoding="UTF-8"?>
<shelve/>

This operation does not return a response body.

POST

/v2/{tenant_id}/servers/{server_id}/action

Remove a shelved instance

Removes an instance from the server.

Data and resource associations are deleted. If an instance is no longer needed, you can remove that instance from the hypervisor to minimize resource usage.

Preconditions

The server status must be SHELVED.
If the specified server is locked, you must have administrator privileges to shelve-offload the server.

Asynchronous Postconditions

After you successfully shelve-offload a server, the status changes to SHELVED_OFFLOAD. The server instance data appears on the compute node.

Troubleshooting

If the server status does not change to SHELVEDED_OFFLOADED, the shelve-offload operation failed. Ensure that you meet the preconditions and run the request again. If the request fails again, investigate whether another operation is running that causes a race condition.

Normal response codes

202

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
server_id	URI	csapi:UUID	The UUID for the server of interest to you.
shelveOffload	plain	xsd:string	Specify the `shelveOffload` action in the request body.

{
    "shelveOffload": null
}

<?xml version="1.0" encoding="UTF-8"?>
<shelveOffload/>

This operation does not return a response body.

POST

/v2/{tenant_id}/servers/{server_id}/action

Restore shelved server

Restores a shelved server.

Preconditions

The server status must be SHELVED or SHELVED_OFFLOADED.
If the specified server is locked, you must have administrator privileges to unshelve the server.

Asynchronous Postconditions

After successfully shelving a server, the status changes to ACTIVE. The server appears on the compute node.
The shelved image is deleted from the list of images returned by an API call.

Troubleshooting

If the server status does not change to ACTIVE, the unshelve operation failed. Ensure that you meet the preconditions and run the request again. If the request fails again, investigate whether another operation is running that causes a race condition.

Normal response codes

202

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
server_id	URI	csapi:UUID	The UUID for the server of interest to you.
unshelve	plain	xsd:string	Specify the `unshelve` action in the request body.

{
    "unshelve": null
}

<?xml version="1.0" encoding="UTF-8"?>
<unshelve/>

This operation does not return a response body.

Servers start and stop (servers, action)

Starts a stopped server and stops a running server.

POST

/v2/{tenant_id}/servers/{server_id}/action

Start server

Starts a stopped server and changes its status to ACTIVE.

Preconditions

The server status must be SHUTOFF.
If the specified server is locked, you must have administrator privileges to start the server.

Asynchronous Postconditions

After you successfully start a server, its status changes to ACTIVE. The server appears on the compute node that the Compute service manages.

Troubleshooting

If the server status does not change to ACTIVE, the start operation failed. Ensure that you meet the preconditions and run the request again. If the request fails again, investigate whether another operation is running that causes a race condition.

Normal response codes

202

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
server_id	URI	csapi:UUID	The UUID for the server of interest to you.
os-start	plain	xsd:string	Specify the `os-start` action in the request body.

{
    "os-start": null
}

<?xml version="1.0" encoding="UTF-8"?>
<os-start/>

This operation does not return a response body.

POST

/v2/{tenant_id}/servers/{server_id}/action

Stop server

Stops a running server and changes its status to SHUTOFF.

Preconditions

The server status must be ACTIVE or ERROR.
If the specified server is locked, you must have administrator privileges to stop the server.

Asynchronous Postconditions

After you successfully stop a server, its status changes to SHUTOFF. The server instance data appears only on the compute node that Compute service manages.

Normal response codes

202

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
server_id	URI	csapi:UUID	The UUID for the server of interest to you.
os-stop	plain	xsd:string	Specify the `os-stop` action in the request body.

{
    "os-stop": null
}

<?xml version="1.0" encoding="UTF-8"?>
<os-stop />

This operation does not return a response body.

Servers diagnostics (servers, diagnostics)

Gets the usage data for a server.

GET

/v2/{tenant_id}/servers/{server_id}/diagnostics

Get server diagnostics

Gets basic usage data for a specified server.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
server_id	URI	csapi:UUID	The UUID for the server of interest to you.

{
    "vnet0_tx_errors": 0,
    "vda_errors": -1,
    "vda_read": 4447232,
    "vda_write": 4347904,
    "vnet0_tx_packets": 1259,
    "vda_write_req": 3523,
    "memory-actual": 524288,
    "cpu0_time": 195230000000,
    "vnet0_tx": 364840,
    "vnet0_rx_drop": 0,
    "vnet0_rx_packets": 1423,
    "vnet0_rx_errors": 0,
    "memory": 524288,
    "memory-rss": 243188,
    "vda_read_req": 291,
    "vnet0_rx": 363725,
    "vnet0_tx_drop": 0
}

This operation does not accept a request body.

Servers and images with disk config (servers, images)

Extends servers with the diskConfig attribute.

POST

/v2/{tenant_id}/servers

Create server

Creates a server.

Normal response codes

202

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
security_groups (Optional)	plain	xsd:string	One or more security groups. Specify the name of the security group in the `name` attribute. If you omit this attribute, the server is created in the `default` security group.
user_data (Optional)	plain	xsd:string	Configuration information or scripts to use upon launch. Must be Base64 encoded.
availability_zone (Optional)	plain	xsd:string	The availability zone in which to launch the server.
server	plain	csapi:ServerForCreate	server.
imageRef	plain	csapi:string	The image reference for the desired image for your server instance. Specify as an ID or full URL.
flavorRef	plain	csapi:string	The flavor reference for the desired flavor for your server instance. Specify as an ID or full URL.
networks (Optional)	plain	xsd:string	A `networks` object. By default, the server instance is provisioned with all isolated networks for the tenant. Optionally, you can create one or more NICs on the server. To provision the server instance with a NIC for a network, specify the UUID of the network in the `uuid` attribute in a `networks` object. To provision the server instance with a NIC for an already existing port, specify the port-id in the `port` attribute in a `networks` object. You can specify multiple NICs on the server.
uuid (Optional)	plain	xsd:string	To provision the server instance with a NIC for a network, specify the UUID of the network in the `uuid` attribute in a `networks` object. Required if you omit the `port` attribute.
port (Optional)	plain	xsd:string	To provision the server instance with a NIC for an already existing port, specify the port-id in the `port` attribute in a `networks` object. The port status must be `DOWN`. Required if you omit the `uuid` attribute.
fixed_ip (Optional)	plain	xsd:string	A fixed IPv4 address for the NIC. Valid with a `neutron` or `nova-networks` network.
name	plain	csapi:string	The server name.
metadata (Optional)	plain	csapi:string	Metadata key and value pairs. The maximum size of the metadata key and value is 255 bytes each.
personality (Optional)	plain	csapi:string	File path and contents (text only) to inject into the server at launch. The maximum size of the file path data is 255 bytes. The maximum limit refers to the number of bytes in the decoded data and not the number of characters in the encoded data.
block_device_mapping_v2 (Optional)	plain	csapi:string	Enables booting the server from a volume when additional parameters are given. If specified, the volume status must be `available`, and the volume `attach_status` in the OpenStack Block Storage database must be `detached`.
device_name	plain	csapi:string	Describes a path to the device for the volume you want to use to boot the server.
source_type	plain	csapi:string	The source type for the volume. A valid value is `blank`, `snapshot`, `volume`, or `image`.
destination_type (Optional)	plain	csapi:string	Defines where the volume comes from. A valid value is `local` or `volume`.
delete_on_termination	plain	csapi:string	To delete the boot volume when the server stops, specify `true`. Otherwise, specify `false`.
guest_format	plain	csapi:string	Specifies the guest server disk file system format, such as `ephemeral` or `swap`.
boot_index	plain	csapi:string	The boot order of the device. Use `-1` for the boot volume. Use `0` for an attached volume.
config_drive (Optional)	plain	xsd:boolean	Enables metadata injection in a server through a configuration drive. Specify `true` to enable a configuration drive. Otherwise, specify `false`.
key_name (Optional)	plain	xsd:string	Key pair name.
OS-DCF:diskConfig (Optional)	plain	String	A valid value is AUTO or MANUAL.

Response parameters

Parameter	Style	Type	Description
security_groups (Optional)	plain	xsd:string	One or more security groups. Specify the name of the security group in the `name` attribute. If you omit this attribute, the server is created in the `default` security group.
user_data (Optional)	plain	xsd:string	Configuration information or scripts to use upon launch. Must be Base64 encoded.
availability_zone (Optional)	plain	xsd:string	The availability zone in which to launch the server.
server	plain	csapi:ServerForCreate	server.
imageRef	plain	csapi:string	The image reference for the desired image for your server instance. Specify as an ID or full URL.
flavorRef	plain	csapi:string	The flavor reference for the desired flavor for your server instance. Specify as an ID or full URL.
networks (Optional)	plain	xsd:string	A `networks` object. By default, the server instance is provisioned with all isolated networks for the tenant. Optionally, you can create one or more NICs on the server. To provision the server instance with a NIC for a network, specify the UUID of the network in the `uuid` attribute in a `networks` object. To provision the server instance with a NIC for an already existing port, specify the port-id in the `port` attribute in a `networks` object. You can specify multiple NICs on the server.
uuid (Optional)	plain	xsd:string	To provision the server instance with a NIC for a network, specify the UUID of the network in the `uuid` attribute in a `networks` object. Required if you omit the `port` attribute.
port (Optional)	plain	xsd:string	To provision the server instance with a NIC for an already existing port, specify the port-id in the `port` attribute in a `networks` object. The port status must be `DOWN`. Required if you omit the `uuid` attribute.
fixed_ip (Optional)	plain	xsd:string	A fixed IPv4 address for the NIC. Valid with a `neutron` or `nova-networks` network.
name	plain	csapi:string	The server name.
metadata (Optional)	plain	csapi:string	Metadata key and value pairs. The maximum size of the metadata key and value is 255 bytes each.
personality (Optional)	plain	csapi:string	File path and contents (text only) to inject into the server at launch. The maximum size of the file path data is 255 bytes. The maximum limit refers to the number of bytes in the decoded data and not the number of characters in the encoded data.
block_device_mapping_v2 (Optional)	plain	csapi:string	Enables booting the server from a volume when additional parameters are given. If specified, the volume status must be `available`, and the volume `attach_status` in the OpenStack Block Storage database must be `detached`.
device_name	plain	csapi:string	Describes a path to the device for the volume you want to use to boot the server.
source_type	plain	csapi:string	The source type for the volume. A valid value is `blank`, `snapshot`, `volume`, or `image`.
destination_type (Optional)	plain	csapi:string	Defines where the volume comes from. A valid value is `local` or `volume`.
delete_on_termination	plain	csapi:string	To delete the boot volume when the server stops, specify `true`. Otherwise, specify `false`.
guest_format	plain	csapi:string	Specifies the guest server disk file system format, such as `ephemeral` or `swap`.
boot_index	plain	csapi:string	The boot order of the device. Use `-1` for the boot volume. Use `0` for an attached volume.
config_drive (Optional)	plain	xsd:boolean	Enables metadata injection in a server through a configuration drive. Specify `true` to enable a configuration drive. Otherwise, specify `false`.
key_name (Optional)	plain	xsd:string	Key pair name.

{
    "server": {
        "name": "new-server-test",
        "imageRef": "http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b",
        "flavorRef": "http://openstack.example.com/openstack/flavors/1",
        "metadata": {
            "My Server Name": "Apache1"
        },
        "personality": [
            {
                "path": "/etc/banner.txt",
                "contents": "ICAgICAgDQoiQSBjbG91ZCBkb2VzIG5vdCBrbm93IHdoeSBpdCBtb3ZlcyBpbiBqdXN0IHN1Y2ggYSBkaXJlY3Rpb24gYW5kIGF0IHN1Y2ggYSBzcGVlZC4uLkl0IGZlZWxzIGFuIGltcHVsc2lvbi4uLnRoaXMgaXMgdGhlIHBsYWNlIHRvIGdvIG5vdy4gQnV0IHRoZSBza3kga25vd3MgdGhlIHJlYXNvbnMgYW5kIHRoZSBwYXR0ZXJucyBiZWhpbmQgYWxsIGNsb3VkcywgYW5kIHlvdSB3aWxsIGtub3csIHRvbywgd2hlbiB5b3UgbGlmdCB5b3Vyc2VsZiBoaWdoIGVub3VnaCB0byBzZWUgYmV5b25kIGhvcml6b25zLiINCg0KLVJpY2hhcmQgQmFjaA=="
            }
        ]
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<server xmlns="http://docs.openstack.org/compute/api/v1.1"
  xmlns:OS-DCF="http://docs.openstack.org/compute/ext/disk_config/api/v1.1"
  imageRef="http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b" flavorRef="http://openstack.example.com/openstack/flavors/1" name="new-server-test" OS-DCF:diskConfig="AUTO">
  <metadata>
    <meta key="My Server Name">Apache1</meta>
  </metadata>
  <personality>
    <file path="/etc/banner.txt">
        ICAgICAgDQoiQSBjbG91ZCBkb2VzIG5vdCBrbm93IHdoeSBp
        dCBtb3ZlcyBpbiBqdXN0IHN1Y2ggYSBkaXJlY3Rpb24gYW5k
        IGF0IHN1Y2ggYSBzcGVlZC4uLkl0IGZlZWxzIGFuIGltcHVs
        c2lvbi4uLnRoaXMgaXMgdGhlIHBsYWNlIHRvIGdvIG5vdy4g
        QnV0IHRoZSBza3kga25vd3MgdGhlIHJlYXNvbnMgYW5kIHRo
        ZSBwYXR0ZXJucyBiZWhpbmQgYWxsIGNsb3VkcywgYW5kIHlv
        dSB3aWxsIGtub3csIHRvbywgd2hlbiB5b3UgbGlmdCB5b3Vy
        c2VsZiBoaWdoIGVub3VnaCB0byBzZWUgYmV5b25kIGhvcml6
        b25zLiINCg0KLVJpY2hhcmQgQmFjaA==
    </file>
  </personality>
</server>

{
    "server": {
        "OS-DCF:diskConfig": "AUTO",
        "adminPass": "CQH9gWzgkVno",
        "id": "324dfb7d-f4a9-419a-9a19-237df04b443b",
        "links": [
            {
                "href": "http://openstack.example.com/v2/openstack/servers/324dfb7d-f4a9-419a-9a19-237df04b443b",
                "rel": "self"
            },
            {
                "href": "http://openstack.example.com/openstack/servers/324dfb7d-f4a9-419a-9a19-237df04b443b",
                "rel": "bookmark"
            }
        ]
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<server xmlns:OS-DCF="http://docs.openstack.org/compute/ext/disk_config/api/v1.1" xmlns:atom="http://www.w3.org/2005/Atom" xmlns="http://docs.openstack.org/compute/api/v1.1" id="900a4ef7-f374-413f-8816-52d3dbfaf498" adminPass="Cj6sZgWq85qm" OS-DCF:diskConfig="AUTO">
  <metadata/>
  <atom:link href="http://openstack.example.com/v2/openstack/servers/900a4ef7-f374-413f-8816-52d3dbfaf498" rel="self"/>
  <atom:link href="http://openstack.example.com/openstack/servers/900a4ef7-f374-413f-8816-52d3dbfaf498" rel="bookmark"/>
</server>

GET

/v2/{tenant_id}/servers/{server_id}

Show server information

Shows information for a specified server.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
server_id	URI	csapi:UUID	The UUID for the server of interest to you.

Response parameters

Parameter	Style	Type	Description
OS-DCF:diskConfig (Optional)	plain	xsd:string	Valid value is AUTO or MANUAL.

{
    "server": {
        "OS-DCF:diskConfig": "AUTO",
        "accessIPv4": "",
        "accessIPv6": "",
        "addresses": {
            "private": [
                {
                    "addr": "192.168.0.3",
                    "version": 4
                }
            ]
        },
        "created": "2012-12-02T02:11:55Z",
        "flavor": {
            "id": "1",
            "links": [
                {
                    "href": "http://openstack.example.com/openstack/flavors/1",
                    "rel": "bookmark"
                }
            ]
        },
        "hostId": "c949ab4256cea23b6089b710aa2df48bf6577ed915278b62e33ad8bb",
        "id": "5046e2f2-3b33-4041-b3cf-e085f73e78e7",
        "image": {
            "id": "70a599e0-31e7-49b7-b260-868f441e862b",
            "links": [
                {
                    "href": "http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b",
                    "rel": "bookmark"
                }
            ]
        },
        "links": [
            {
                "href": "http://openstack.example.com/v2/openstack/servers/5046e2f2-3b33-4041-b3cf-e085f73e78e7",
                "rel": "self"
            },
            {
                "href": "http://openstack.example.com/openstack/servers/5046e2f2-3b33-4041-b3cf-e085f73e78e7",
                "rel": "bookmark"
            }
        ],
        "metadata": {
            "My Server Name": "Apache1"
        },
        "name": "new-server-test",
        "progress": 0,
        "status": "ACTIVE",
        "tenant_id": "openstack",
        "updated": "2012-12-02T02:11:55Z",
        "user_id": "fake"
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<server xmlns:OS-DCF="http://docs.openstack.org/compute/ext/disk_config/api/v1.1" xmlns:atom="http://www.w3.org/2005/Atom" xmlns="http://docs.openstack.org/compute/api/v1.1" status="ACTIVE" updated="2012-12-02T02:15:37Z" hostId="afa0a883de4743c7a0c164327bda5284b875c50e1a9e30de910ac126" name="new-server-test" created="2012-12-02T02:15:37Z" userId="fake" tenantId="openstack" accessIPv4="" accessIPv6="" progress="0" id="d5d844c0-ecc3-4202-90ed-2e85b7fe513d" OS-DCF:diskConfig="AUTO">
  <image id="70a599e0-31e7-49b7-b260-868f441e862b">
    <atom:link href="http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b" rel="bookmark"/>
  </image>
  <flavor id="1">
    <atom:link href="http://openstack.example.com/openstack/flavors/1" rel="bookmark"/>
  </flavor>
  <metadata>
    <meta key="My Server Name">Apache1</meta>
  </metadata>
  <addresses>
    <network id="private">
      <ip version="4" addr="192.168.0.3"/>
    </network>
  </addresses>
  <atom:link href="http://openstack.example.com/v2/openstack/servers/d5d844c0-ecc3-4202-90ed-2e85b7fe513d" rel="self"/>
  <atom:link href="http://openstack.example.com/openstack/servers/d5d844c0-ecc3-4202-90ed-2e85b7fe513d" rel="bookmark"/>
</server>

This operation does not accept a request body.

PUT

/v2/{tenant_id}/servers/{server_id}

Update server

Updates a specified server.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
server_id	URI	csapi:UUID	The UUID for the server of interest to you.

{
    "server": {
        "OS-DCF:diskConfig": "AUTO"
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<server xmlns:OS-DCF="http://docs.openstack.org/compute/ext/disk_config/api/v1.1"
        xmlns:atom="http://www.w3.org/2005/Atom"
        xmlns="http://docs.openstack.org/compute/api/v1.1"
        OS-DCF:diskConfig="AUTO" />

{
    "server": {
        "OS-DCF:diskConfig": "AUTO",
        "accessIPv4": "",
        "accessIPv6": "",
        "addresses": {
            "private": [
                {
                    "addr": "192.168.0.3",
                    "version": 4
                }
            ]
        },
        "created": "2012-12-02T02:11:57Z",
        "flavor": {
            "id": "1",
            "links": [
                {
                    "href": "http://openstack.example.com/openstack/flavors/1",
                    "rel": "bookmark"
                }
            ]
        },
        "hostId": "6e84af987b4e7ec1c039b16d21f508f4a505672bd94fb0218b668d07",
        "id": "324dfb7d-f4a9-419a-9a19-237df04b443b",
        "image": {
            "id": "70a599e0-31e7-49b7-b260-868f441e862b",
            "links": [
                {
                    "href": "http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b",
                    "rel": "bookmark"
                }
            ]
        },
        "links": [
            {
                "href": "http://openstack.example.com/v2/openstack/servers/324dfb7d-f4a9-419a-9a19-237df04b443b",
                "rel": "self"
            },
            {
                "href": "http://openstack.example.com/openstack/servers/324dfb7d-f4a9-419a-9a19-237df04b443b",
                "rel": "bookmark"
            }
        ],
        "metadata": {
            "My Server Name": "Apache1"
        },
        "name": "new-server-test",
        "progress": 0,
        "status": "ACTIVE",
        "tenant_id": "openstack",
        "updated": "2012-12-02T02:11:58Z",
        "user_id": "fake"
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<server xmlns:OS-DCF="http://docs.openstack.org/compute/ext/disk_config/api/v1.1" xmlns:atom="http://www.w3.org/2005/Atom" xmlns="http://docs.openstack.org/compute/api/v1.1" status="ACTIVE" updated="2012-12-02T02:15:40Z" hostId="e987bebf62599c59c4559b249d0f5f300a302d1e9ff22dd1f0c5c4b0" name="new-server-test" created="2012-12-02T02:15:40Z" userId="fake" tenantId="openstack" accessIPv4="" accessIPv6="" progress="0" id="900a4ef7-f374-413f-8816-52d3dbfaf498" OS-DCF:diskConfig="AUTO">
  <image id="70a599e0-31e7-49b7-b260-868f441e862b">
    <atom:link href="http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b" rel="bookmark"/>
  </image>
  <flavor id="1">
    <atom:link href="http://openstack.example.com/openstack/flavors/1" rel="bookmark"/>
  </flavor>
  <metadata>
    <meta key="My Server Name">Apache1</meta>
  </metadata>
  <addresses>
    <network id="private">
      <ip version="4" addr="192.168.0.3"/>
    </network>
  </addresses>
  <atom:link href="http://openstack.example.com/v2/openstack/servers/900a4ef7-f374-413f-8816-52d3dbfaf498" rel="self"/>
  <atom:link href="http://openstack.example.com/openstack/servers/900a4ef7-f374-413f-8816-52d3dbfaf498" rel="bookmark"/>
</server>

POST

/v2/{tenant_id}/servers/{server_id}/action

Resize server

Resizes a server.

Normal response codes

202

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
server_id	URI	csapi:UUID	The UUID for the server of interest to you.

{
    "resize": {
        "flavorRef": "3",
        "OS-DCF:diskConfig": "AUTO"
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<resize xmlns:OS-DCF="http://docs.openstack.org/compute/ext/disk_config/api/v1.1"
        xmlns:atom="http://www.w3.org/2005/Atom"
        xmlns="http://docs.openstack.org/compute/api/v1.1"
        OS-DCF:diskConfig="AUTO"
        flavorRef="3" />

This operation does not return a response body.

POST

/v2/{tenant_id}/servers/{server_id}/action

Rebuild server

Rebuilds a specified server.

Normal response codes

202

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
server_id	URI	csapi:UUID	The UUID for the server of interest to you.

{
    "rebuild": {
        "imageRef": "http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b",
        "OS-DCF:diskConfig": "AUTO"
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<rebuild xmlns:OS-DCF="http://docs.openstack.org/compute/ext/disk_config/api/v1.1"
         xmlns:atom="http://www.w3.org/2005/Atom"
         xmlns="http://docs.openstack.org/compute/api/v1.1"
         imageRef="http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b"
         OS-DCF:diskConfig="AUTO" />

{
    "server": {
        "OS-DCF:diskConfig": "AUTO",
        "accessIPv4": "",
        "accessIPv6": "",
        "addresses": {
            "private": [
                {
                    "addr": "192.168.0.3",
                    "version": 4
                }
            ]
        },
        "adminPass": "NBjMaJoFL4EF",
        "created": "2012-12-02T02:11:56Z",
        "flavor": {
            "id": "1",
            "links": [
                {
                    "href": "http://openstack.example.com/openstack/flavors/1",
                    "rel": "bookmark"
                }
            ]
        },
        "hostId": "c076393ad900d62c4805a42df10d9b364f629842681c00cce035487f",
        "id": "63a8aa13-60fe-41c4-b079-77f6fdf3c841",
        "image": {
            "id": "70a599e0-31e7-49b7-b260-868f441e862b",
            "links": [
                {
                    "href": "http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b",
                    "rel": "bookmark"
                }
            ]
        },
        "links": [
            {
                "href": "http://openstack.example.com/v2/openstack/servers/63a8aa13-60fe-41c4-b079-77f6fdf3c841",
                "rel": "self"
            },
            {
                "href": "http://openstack.example.com/openstack/servers/63a8aa13-60fe-41c4-b079-77f6fdf3c841",
                "rel": "bookmark"
            }
        ],
        "metadata": {
            "My Server Name": "Apache1"
        },
        "name": "new-server-test",
        "progress": 0,
        "status": "ACTIVE",
        "tenant_id": "openstack",
        "updated": "2012-12-02T02:11:56Z",
        "user_id": "fake"
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<server xmlns:OS-DCF="http://docs.openstack.org/compute/ext/disk_config/api/v1.1" xmlns:atom="http://www.w3.org/2005/Atom" xmlns="http://docs.openstack.org/compute/api/v1.1" status="ACTIVE" updated="2012-12-02T02:15:39Z" hostId="981de784ae4d8c49ca075024977828a16e7f3c2beeb19115b0366e17" name="new-server-test" created="2012-12-02T02:15:38Z" userId="fake" tenantId="openstack" accessIPv4="" accessIPv6="" progress="0" id="10791a94-8900-4d0c-b93d-0debb224882e" adminPass="mTxoVD3eALpv" OS-DCF:diskConfig="AUTO">
  <image id="70a599e0-31e7-49b7-b260-868f441e862b">
    <atom:link href="http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b" rel="bookmark"/>
  </image>
  <flavor id="1">
    <atom:link href="http://openstack.example.com/openstack/flavors/1" rel="bookmark"/>
  </flavor>
  <metadata>
    <meta key="My Server Name">Apache1</meta>
  </metadata>
  <addresses>
    <network id="private">
      <ip version="4" addr="192.168.0.3"/>
    </network>
  </addresses>
  <atom:link href="http://openstack.example.com/v2/openstack/servers/10791a94-8900-4d0c-b93d-0debb224882e" rel="self"/>
  <atom:link href="http://openstack.example.com/openstack/servers/10791a94-8900-4d0c-b93d-0debb224882e" rel="bookmark"/>
</server>

GET

/v2/{tenant_id}/servers/detail

List servers

Lists servers with detailed config drive information.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.

Response parameters

Parameter	Style	Type	Description
OS-DCF:diskConfig (Optional)	plain	xsd:string	Valid value is AUTO or MANUAL.

{
    "servers": [
        {
            "OS-DCF:diskConfig": "AUTO",
            "accessIPv4": "",
            "accessIPv6": "",
            "addresses": {
                "private": [
                    {
                        "addr": "192.168.0.3",
                        "version": 4
                    }
                ]
            },
            "created": "2012-12-02T02:11:55Z",
            "flavor": {
                "id": "1",
                "links": [
                    {
                        "href": "http://openstack.example.com/openstack/flavors/1",
                        "rel": "bookmark"
                    }
                ]
            },
            "hostId": "99428f32351a5d89d0f7727c6eec68c1777c545a0972aaac645508dc",
            "id": "05372e62-05b9-4ee2-9343-9a1fdf2a5fda",
            "image": {
                "id": "70a599e0-31e7-49b7-b260-868f441e862b",
                "links": [
                    {
                        "href": "http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b",
                        "rel": "bookmark"
                    }
                ]
            },
            "links": [
                {
                    "href": "http://openstack.example.com/v2/openstack/servers/05372e62-05b9-4ee2-9343-9a1fdf2a5fda",
                    "rel": "self"
                },
                {
                    "href": "http://openstack.example.com/openstack/servers/05372e62-05b9-4ee2-9343-9a1fdf2a5fda",
                    "rel": "bookmark"
                }
            ],
            "metadata": {
                "My Server Name": "Apache1"
            },
            "name": "new-server-test",
            "progress": 0,
            "status": "ACTIVE",
            "tenant_id": "openstack",
            "updated": "2012-12-02T02:11:56Z",
            "user_id": "fake"
        }
    ]
}

<?xml version='1.0' encoding='UTF-8'?>
<servers xmlns:OS-DCF="http://docs.openstack.org/compute/ext/disk_config/api/v1.1" xmlns:atom="http://www.w3.org/2005/Atom" xmlns="http://docs.openstack.org/compute/api/v1.1">
  <server status="ACTIVE" updated="2012-12-02T02:15:38Z" hostId="85973b57730e91f4eea36b3e7a2a7e3fdaf56008af335dd59f897a59" name="new-server-test" created="2012-12-02T02:15:38Z" userId="fake" tenantId="openstack" accessIPv4="" accessIPv6="" progress="0" id="08266bed-2651-4b6c-9dc8-83f0c3ef9d38" OS-DCF:diskConfig="AUTO">
    <image id="70a599e0-31e7-49b7-b260-868f441e862b">
      <atom:link href="http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b" rel="bookmark"/>
    </image>
    <flavor id="1">
      <atom:link href="http://openstack.example.com/openstack/flavors/1" rel="bookmark"/>
    </flavor>
    <metadata>
      <meta key="My Server Name">Apache1</meta>
    </metadata>
    <addresses>
      <network id="private">
        <ip version="4" addr="192.168.0.3"/>
      </network>
    </addresses>
    <atom:link href="http://openstack.example.com/v2/openstack/servers/08266bed-2651-4b6c-9dc8-83f0c3ef9d38" rel="self"/>
    <atom:link href="http://openstack.example.com/openstack/servers/08266bed-2651-4b6c-9dc8-83f0c3ef9d38" rel="bookmark"/>
  </server>
</servers>

This operation does not accept a request body.

GET

/v2/{tenant_id}/images/{image_id}

Get image information

Gets information for a specified image.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
image_id	URI	String	The UUID for the image of interest to you.

Response parameters

Parameter	Style	Type	Description
OS-DCF:diskConfig (Optional)	plain	xsd:string	Valid value is AUTO or MANUAL.

{
    "image": {
        "OS-DCF:diskConfig": "AUTO",
        "created": "2011-01-01T01:02:03Z",
        "id": "70a599e0-31e7-49b7-b260-868f441e862b",
        "links": [
            {
                "href": "http://openstack.example.com/v2/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b",
                "rel": "self"
            },
            {
                "href": "http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b",
                "rel": "bookmark"
            },
            {
                "href": "http://glance.openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b",
                "rel": "alternate",
                "type": "application/vnd.openstack.image"
            }
        ],
        "metadata": {
            "architecture": "x86_64",
            "auto_disk_config": "True",
            "kernel_id": "nokernel",
            "ramdisk_id": "nokernel"
        },
        "minDisk": 0,
        "minRam": 0,
        "name": "fakeimage7",
        "progress": 100,
        "status": "ACTIVE",
        "updated": "2011-01-01T01:02:03Z"
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<image xmlns:OS-DCF="http://docs.openstack.org/compute/ext/disk_config/api/v1.1" xmlns:atom="http://www.w3.org/2005/Atom" xmlns="http://docs.openstack.org/compute/api/v1.1" status="ACTIVE" updated="2011-01-01T01:02:03Z" name="fakeimage7" created="2011-01-01T01:02:03Z" minDisk="0" progress="100" minRam="0" id="70a599e0-31e7-49b7-b260-868f441e862b" OS-DCF:diskConfig="AUTO">
  <metadata>
    <meta key="kernel_id">nokernel</meta>
    <meta key="auto_disk_config">True</meta>
    <meta key="ramdisk_id">nokernel</meta>
    <meta key="architecture">x86_64</meta>
  </metadata>
  <atom:link href="http://openstack.example.com/v2/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b" rel="self"/>
  <atom:link href="http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b" rel="bookmark"/>
  <atom:link href="http://glance.openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b" type="application/vnd.openstack.image" rel="alternate"/>
</image>

This operation does not accept a request body.

GET

/v2/{tenant_id}/images/detail

List images

Lists images.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.

Response parameters

Parameter	Style	Type	Description
OS-DCF:diskConfig (Optional)	plain	xsd:string	Valid value is AUTO or MANUAL.

{
    "images": [
        {
            "OS-DCF:diskConfig": "AUTO",
            "created": "2011-01-01T01:02:03Z",
            "id": "70a599e0-31e7-49b7-b260-868f441e862b",
            "links": [
                {
                    "href": "http://openstack.example.com/v2/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b",
                    "rel": "self"
                },
                {
                    "href": "http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b",
                    "rel": "bookmark"
                },
                {
                    "href": "http://glance.openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b",
                    "rel": "alternate",
                    "type": "application/vnd.openstack.image"
                }
            ],
            "metadata": {
                "architecture": "x86_64",
                "auto_disk_config": "True",
                "kernel_id": "nokernel",
                "ramdisk_id": "nokernel"
            },
            "minDisk": 0,
            "minRam": 0,
            "name": "fakeimage7",
            "progress": 100,
            "status": "ACTIVE",
            "updated": "2011-01-01T01:02:03Z"
        },
        {
            "created": "2011-01-01T01:02:03Z",
            "id": "155d900f-4e14-4e4c-a73d-069cbf4541e6",
            "links": [
                {
                    "href": "http://openstack.example.com/v2/openstack/images/155d900f-4e14-4e4c-a73d-069cbf4541e6",
                    "rel": "self"
                },
                {
                    "href": "http://openstack.example.com/openstack/images/155d900f-4e14-4e4c-a73d-069cbf4541e6",
                    "rel": "bookmark"
                },
                {
                    "href": "http://glance.openstack.example.com/openstack/images/155d900f-4e14-4e4c-a73d-069cbf4541e6",
                    "rel": "alternate",
                    "type": "application/vnd.openstack.image"
                }
            ],
            "metadata": {
                "architecture": "x86_64",
                "kernel_id": "nokernel",
                "ramdisk_id": "nokernel"
            },
            "minDisk": 0,
            "minRam": 0,
            "name": "fakeimage123456",
            "progress": 100,
            "status": "ACTIVE",
            "updated": "2011-01-01T01:02:03Z"
        },
        {
            "created": "2011-01-01T01:02:03Z",
            "id": "a2459075-d96c-40d5-893e-577ff92e721c",
            "links": [
                {
                    "href": "http://openstack.example.com/v2/openstack/images/a2459075-d96c-40d5-893e-577ff92e721c",
                    "rel": "self"
                },
                {
                    "href": "http://openstack.example.com/openstack/images/a2459075-d96c-40d5-893e-577ff92e721c",
                    "rel": "bookmark"
                },
                {
                    "href": "http://glance.openstack.example.com/openstack/images/a2459075-d96c-40d5-893e-577ff92e721c",
                    "rel": "alternate",
                    "type": "application/vnd.openstack.image"
                }
            ],
            "metadata": {
                "kernel_id": "nokernel",
                "ramdisk_id": "nokernel"
            },
            "minDisk": 0,
            "minRam": 0,
            "name": "fakeimage123456",
            "progress": 100,
            "status": "ACTIVE",
            "updated": "2011-01-01T01:02:03Z"
        },
        {
            "OS-DCF:diskConfig": "MANUAL",
            "created": "2011-01-01T01:02:03Z",
            "id": "a440c04b-79fa-479c-bed1-0b816eaec379",
            "links": [
                {
                    "href": "http://openstack.example.com/v2/openstack/images/a440c04b-79fa-479c-bed1-0b816eaec379",
                    "rel": "self"
                },
                {
                    "href": "http://openstack.example.com/openstack/images/a440c04b-79fa-479c-bed1-0b816eaec379",
                    "rel": "bookmark"
                },
                {
                    "href": "http://glance.openstack.example.com/openstack/images/a440c04b-79fa-479c-bed1-0b816eaec379",
                    "rel": "alternate",
                    "type": "application/vnd.openstack.image"
                }
            ],
            "metadata": {
                "architecture": "x86_64",
                "auto_disk_config": "False",
                "kernel_id": "nokernel",
                "ramdisk_id": "nokernel"
            },
            "minDisk": 0,
            "minRam": 0,
            "name": "fakeimage6",
            "progress": 100,
            "status": "ACTIVE",
            "updated": "2011-01-01T01:02:03Z"
        },
        {
            "created": "2011-01-01T01:02:03Z",
            "id": "c905cedb-7281-47e4-8a62-f26bc5fc4c77",
            "links": [
                {
                    "href": "http://openstack.example.com/v2/openstack/images/c905cedb-7281-47e4-8a62-f26bc5fc4c77",
                    "rel": "self"
                },
                {
                    "href": "http://openstack.example.com/openstack/images/c905cedb-7281-47e4-8a62-f26bc5fc4c77",
                    "rel": "bookmark"
                },
                {
                    "href": "http://glance.openstack.example.com/openstack/images/c905cedb-7281-47e4-8a62-f26bc5fc4c77",
                    "rel": "alternate",
                    "type": "application/vnd.openstack.image"
                }
            ],
            "metadata": {
                "kernel_id": "155d900f-4e14-4e4c-a73d-069cbf4541e6",
                "ramdisk_id": null
            },
            "minDisk": 0,
            "minRam": 0,
            "name": "fakeimage123456",
            "progress": 100,
            "status": "ACTIVE",
            "updated": "2011-01-01T01:02:03Z"
        },
        {
            "created": "2011-01-01T01:02:03Z",
            "id": "cedef40a-ed67-4d10-800e-17455edce175",
            "links": [
                {
                    "href": "http://openstack.example.com/v2/openstack/images/cedef40a-ed67-4d10-800e-17455edce175",
                    "rel": "self"
                },
                {
                    "href": "http://openstack.example.com/openstack/images/cedef40a-ed67-4d10-800e-17455edce175",
                    "rel": "bookmark"
                },
                {
                    "href": "http://glance.openstack.example.com/openstack/images/cedef40a-ed67-4d10-800e-17455edce175",
                    "rel": "alternate",
                    "type": "application/vnd.openstack.image"
                }
            ],
            "metadata": {
                "kernel_id": "nokernel",
                "ramdisk_id": "nokernel"
            },
            "minDisk": 0,
            "minRam": 0,
            "name": "fakeimage123456",
            "progress": 100,
            "status": "ACTIVE",
            "updated": "2011-01-01T01:02:03Z"
        },
        {
            "created": "2011-01-01T01:02:03Z",
            "id": "76fa36fc-c930-4bf3-8c8a-ea2a2420deb6",
            "links": [
                {
                    "href": "http://openstack.example.com/v2/openstack/images/76fa36fc-c930-4bf3-8c8a-ea2a2420deb6",
                    "rel": "self"
                },
                {
                    "href": "http://openstack.example.com/openstack/images/76fa36fc-c930-4bf3-8c8a-ea2a2420deb6",
                    "rel": "bookmark"
                },
                {
                    "href": "http://glance.openstack.example.com/openstack/images/76fa36fc-c930-4bf3-8c8a-ea2a2420deb6",
                    "rel": "alternate",
                    "type": "application/vnd.openstack.image"
                }
            ],
            "metadata": {
                "kernel_id": "nokernel",
                "ramdisk_id": "nokernel"
            },
            "minDisk": 0,
            "minRam": 0,
            "name": "fakeimage123456",
            "progress": 100,
            "status": "ACTIVE",
            "updated": "2011-01-01T01:02:03Z"
        }
    ]
}

<?xml version='1.0' encoding='UTF-8'?>
<images xmlns:OS-DCF="http://docs.openstack.org/compute/ext/disk_config/api/v1.1" xmlns:atom="http://www.w3.org/2005/Atom" xmlns="http://docs.openstack.org/compute/api/v1.1">
  <image status="ACTIVE" updated="2011-01-01T01:02:03Z" name="fakeimage7" created="2011-01-01T01:02:03Z" minDisk="0" progress="100" minRam="0" id="70a599e0-31e7-49b7-b260-868f441e862b" OS-DCF:diskConfig="AUTO">
    <metadata>
      <meta key="kernel_id">nokernel</meta>
      <meta key="auto_disk_config">True</meta>
      <meta key="ramdisk_id">nokernel</meta>
      <meta key="architecture">x86_64</meta>
    </metadata>
    <atom:link href="http://openstack.example.com/v2/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b" rel="self"/>
    <atom:link href="http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b" rel="bookmark"/>
    <atom:link href="http://glance.openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b" type="application/vnd.openstack.image" rel="alternate"/>
  </image>
  <image status="ACTIVE" updated="2011-01-01T01:02:03Z" name="fakeimage123456" created="2011-01-01T01:02:03Z" minDisk="0" progress="100" minRam="0" id="155d900f-4e14-4e4c-a73d-069cbf4541e6">
    <metadata>
      <meta key="kernel_id">nokernel</meta>
      <meta key="ramdisk_id">nokernel</meta>
      <meta key="architecture">x86_64</meta>
    </metadata>
    <atom:link href="http://openstack.example.com/v2/openstack/images/155d900f-4e14-4e4c-a73d-069cbf4541e6" rel="self"/>
    <atom:link href="http://openstack.example.com/openstack/images/155d900f-4e14-4e4c-a73d-069cbf4541e6" rel="bookmark"/>
    <atom:link href="http://glance.openstack.example.com/openstack/images/155d900f-4e14-4e4c-a73d-069cbf4541e6" type="application/vnd.openstack.image" rel="alternate"/>
  </image>
  <image status="ACTIVE" updated="2011-01-01T01:02:03Z" name="fakeimage123456" created="2011-01-01T01:02:03Z" minDisk="0" progress="100" minRam="0" id="a2459075-d96c-40d5-893e-577ff92e721c">
    <metadata>
      <meta key="kernel_id">nokernel</meta>
      <meta key="ramdisk_id">nokernel</meta>
    </metadata>
    <atom:link href="http://openstack.example.com/v2/openstack/images/a2459075-d96c-40d5-893e-577ff92e721c" rel="self"/>
    <atom:link href="http://openstack.example.com/openstack/images/a2459075-d96c-40d5-893e-577ff92e721c" rel="bookmark"/>
    <atom:link href="http://glance.openstack.example.com/openstack/images/a2459075-d96c-40d5-893e-577ff92e721c" type="application/vnd.openstack.image" rel="alternate"/>
  </image>
  <image status="ACTIVE" updated="2011-01-01T01:02:03Z" name="fakeimage6" created="2011-01-01T01:02:03Z" minDisk="0" progress="100" minRam="0" id="a440c04b-79fa-479c-bed1-0b816eaec379" OS-DCF:diskConfig="MANUAL">
    <metadata>
      <meta key="kernel_id">nokernel</meta>
      <meta key="auto_disk_config">False</meta>
      <meta key="ramdisk_id">nokernel</meta>
      <meta key="architecture">x86_64</meta>
    </metadata>
    <atom:link href="http://openstack.example.com/v2/openstack/images/a440c04b-79fa-479c-bed1-0b816eaec379" rel="self"/>
    <atom:link href="http://openstack.example.com/openstack/images/a440c04b-79fa-479c-bed1-0b816eaec379" rel="bookmark"/>
    <atom:link href="http://glance.openstack.example.com/openstack/images/a440c04b-79fa-479c-bed1-0b816eaec379" type="application/vnd.openstack.image" rel="alternate"/>
  </image>
  <image status="ACTIVE" updated="2011-01-01T01:02:03Z" name="fakeimage123456" created="2011-01-01T01:02:03Z" minDisk="0" progress="100" minRam="0" id="c905cedb-7281-47e4-8a62-f26bc5fc4c77">
    <metadata>
      <meta key="kernel_id">155d900f-4e14-4e4c-a73d-069cbf4541e6</meta>
      <meta key="ramdisk_id">None</meta>
    </metadata>
    <atom:link href="http://openstack.example.com/v2/openstack/images/c905cedb-7281-47e4-8a62-f26bc5fc4c77" rel="self"/>
    <atom:link href="http://openstack.example.com/openstack/images/c905cedb-7281-47e4-8a62-f26bc5fc4c77" rel="bookmark"/>
    <atom:link href="http://glance.openstack.example.com/openstack/images/c905cedb-7281-47e4-8a62-f26bc5fc4c77" type="application/vnd.openstack.image" rel="alternate"/>
  </image>
  <image status="ACTIVE" updated="2011-01-01T01:02:03Z" name="fakeimage123456" created="2011-01-01T01:02:03Z" minDisk="0" progress="100" minRam="0" id="cedef40a-ed67-4d10-800e-17455edce175">
    <metadata>
      <meta key="kernel_id">nokernel</meta>
      <meta key="ramdisk_id">nokernel</meta>
    </metadata>
    <atom:link href="http://openstack.example.com/v2/openstack/images/cedef40a-ed67-4d10-800e-17455edce175" rel="self"/>
    <atom:link href="http://openstack.example.com/openstack/images/cedef40a-ed67-4d10-800e-17455edce175" rel="bookmark"/>
    <atom:link href="http://glance.openstack.example.com/openstack/images/cedef40a-ed67-4d10-800e-17455edce175" type="application/vnd.openstack.image" rel="alternate"/>
  </image>
  <image status="ACTIVE" updated="2011-01-01T01:02:03Z" name="fakeimage123456" created="2011-01-01T01:02:03Z" minDisk="0" progress="100" minRam="0" id="76fa36fc-c930-4bf3-8c8a-ea2a2420deb6">
    <metadata>
      <meta key="kernel_id">nokernel</meta>
      <meta key="ramdisk_id">nokernel</meta>
    </metadata>
    <atom:link href="http://openstack.example.com/v2/openstack/images/76fa36fc-c930-4bf3-8c8a-ea2a2420deb6" rel="self"/>
    <atom:link href="http://openstack.example.com/openstack/images/76fa36fc-c930-4bf3-8c8a-ea2a2420deb6" rel="bookmark"/>
    <atom:link href="http://glance.openstack.example.com/openstack/images/76fa36fc-c930-4bf3-8c8a-ea2a2420deb6" type="application/vnd.openstack.image" rel="alternate"/>
  </image>
</images>

This operation does not accept a request body.

Servers availability zones (servers, os-availability-zone)

Gets availability zone information.

POST

/v2/{tenant_id}/servers

Create server with availability zone

Creates a server with an availability zone.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.

{
    "server": {
        "name": "new-server-test",
        "imageRef": "http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b",
        "flavorRef": "http://openstack.example.com/openstack/flavors/1",
        "metadata": {
            "My Server Name": "Apache1"
        },
        "availability_zone": "nova",
        "personality": [
            {
                "path": "/etc/banner.txt",
                "contents": "ICAgICAgDQoiQSBjbG91ZCBkb2VzIG5vdCBrbm93IHdoeSBpdCBtb3ZlcyBpbiBqdXN0IHN1Y2ggYSBkaXJlY3Rpb24gYW5kIGF0IHN1Y2ggYSBzcGVlZC4uLkl0IGZlZWxzIGFuIGltcHVsc2lvbi4uLnRoaXMgaXMgdGhlIHBsYWNlIHRvIGdvIG5vdy4gQnV0IHRoZSBza3kga25vd3MgdGhlIHJlYXNvbnMgYW5kIHRoZSBwYXR0ZXJucyBiZWhpbmQgYWxsIGNsb3VkcywgYW5kIHlvdSB3aWxsIGtub3csIHRvbywgd2hlbiB5b3UgbGlmdCB5b3Vyc2VsZiBoaWdoIGVub3VnaCB0byBzZWUgYmV5b25kIGhvcml6b25zLiINCg0KLVJpY2hhcmQgQmFjaA=="
            }
        ]
    }
}

{
    "server": {
        "adminPass": "k4pKvTfcA4gY",
        "id": "3e45fa2a-5204-466f-a684-c2a8e1c82d7f",
        "links": [
            {
                "href": "http://openstack.example.com/v2/openstack/servers/3e45fa2a-5204-466f-a684-c2a8e1c82d7f",
                "rel": "self"
            },
            {
                "href": "http://openstack.example.com/openstack/servers/3e45fa2a-5204-466f-a684-c2a8e1c82d7f",
                "rel": "bookmark"
            }
        ]
    }
}

GET

/v2/{tenant_id}/os-availability-zone

List availability zones

Lists all availability zones.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.

{
    "availabilityZoneInfo": [
        {
            "hosts": null,
            "zoneName": "nova",
            "zoneState": {
                "available": true
            }
        }
    ]
}

This operation does not accept a request body.

GET

/v2/{tenant_id}/os-availability-zone/detail

List availability zones with details

Lists all availability zones with details.

Normal response codes

200

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.

{
    "availabilityZoneInfo": [
        {
            "hosts": {
                "cells": {
                    "nova-cells": {
                        "active": true,
                        "available": true,
                        "updated_at": null
                    }
                },
                "cert": {
                    "nova-cert": {
                        "active": true,
                        "available": true,
                        "updated_at": null
                    }
                },
                "conductor": {
                    "nova-conductor": {
                        "active": true,
                        "available": true,
                        "updated_at": null
                    }
                },
                "consoleauth": {
                    "nova-consoleauth": {
                        "active": true,
                        "available": true,
                        "updated_at": null
                    }
                },
                "network": {
                    "nova-network": {
                        "active": true,
                        "available": true,
                        "updated_at": null
                    }
                },
                "scheduler": {
                    "nova-scheduler": {
                        "active": true,
                        "available": true,
                        "updated_at": null
                    }
                }
            },
            "zoneName": "internal",
            "zoneState": {
                "available": true
            }
        },
        {
            "hosts": {
                "compute": {
                    "nova-compute": {
                        "active": true,
                        "available": true,
                        "updated_at": null
                    }
                }
            },
            "zoneName": "nova",
            "zoneState": {
                "available": true
            }
        }
    ]
}

This operation does not accept a request body.

GET

/v2/{tenant_id}/os-availability-zone/{availability_zone_id}

Show availability zone information

Shows information for a specified availability zone.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
availability_zone_id	URI	csapi:UUID	The ID associated with an availability zone.

{
    "availabilityZoneInfo": [
        {
            "zoneState": {
                "available": true
            },
            "hosts": null,
            "zoneName": "nova"
        }
    ]
}

This operation does not accept a request body.

Servers instance actions (servers, os-instance-actions)

Lists available actions for a specified server. Administrators can get details for a specified action for a specified server.

GET

/v2/{tenant_id}/servers/{server_id}/os-instance-actions

List server actions

Lists history of successful actions for a specified server. Deployers set permissions for this request in the policy.json file. By default, all users can list actions.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
server_id	URI	csapi:UUID	The UUID of the server instance for which you want to list actions.

{
    "instanceActions": [
        {
            "action": "resize",
            "instance_uuid": "b48316c5-71e8-45e4-9884-6c78055b9b13",
            "message": "",
            "project_id": "842",
            "request_id": "req-25517360-b757-47d3-be45-0e8d2a01b36a",
            "start_time": "2012-12-05 01:00:00.000000",
            "user_id": "789"
        },
        {
            "action": "reboot",
            "instance_uuid": "b48316c5-71e8-45e4-9884-6c78055b9b13",
            "message": "",
            "project_id": "147",
            "request_id": "req-3293a3f1-b44c-4609-b8d2-d81b105636b8",
            "start_time": "2012-12-05 00:00:00.000000",
            "user_id": "789"
        }
    ]
}

<?xml version='1.0' encoding='UTF-8'?>
<instanceActions>
  <instanceAction instance_uuid="b48316c5-71e8-45e4-9884-6c78055b9b13" user_id="789" start_time="2012-12-05 01:00:00.000000" request_id="req-25517360-b757-47d3-be45-0e8d2a01b36a" action="resize" message="" project_id="842"/>
  <instanceAction instance_uuid="b48316c5-71e8-45e4-9884-6c78055b9b13" user_id="789" start_time="2012-12-05 00:00:00.000000" request_id="req-3293a3f1-b44c-4609-b8d2-d81b105636b8" action="reboot" message="" project_id="147"/>
</instanceActions>

This operation does not accept a request body.

GET

/v2/{tenant_id}/servers/{server_id}/os-instance-actions/{action_id}

Get action details

Gets details for a specified action for a specified server instance. Deployers set permissions for this request in the policy.json file. By default, only administrators can get details for an action.

Normal response codes

200, 203

Error response codes

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
server_id	URI	csapi:UUID	The UUID of the server instance for which you want to list actions.
action_id	URI	csapi:UUID	The UUID of the action for which you want to get details.

{
    "instanceAction": {
        "action": "reboot",
        "events": [
            {
                "event": "schedule",
                "finish_time": "2012-12-05 01:02:00.000000",
                "result": "Success",
                "start_time": "2012-12-05 01:00:02.000000",
                "traceback": ""
            },
            {
                "event": "compute_create",
                "finish_time": "2012-12-05 01:04:00.000000",
                "result": "Success",
                "start_time": "2012-12-05 01:03:00.000000",
                "traceback": ""
            }
        ],
        "instance_uuid": "b48316c5-71e8-45e4-9884-6c78055b9b13",
        "message": "",
        "project_id": "147",
        "request_id": "req-3293a3f1-b44c-4609-b8d2-d81b105636b8",
        "start_time": "2012-12-05 00:00:00.000000",
        "user_id": "789"
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<instanceAction instance_uuid="b48316c5-71e8-45e4-9884-6c78055b9b13" user_id="789" start_time="2012-12-05T00:00:00.000000" request_id="req-3293a3f1-b44c-4609-b8d2-d81b105636b8" action="reboot" message="" project_id="147">
  <events finish_time="2012-12-05 01:02:00.000000" start_time="2012-12-05 01:00:02.000000" traceback="" event="schedule" result="Success"/>
  <events finish_time="2012-12-05 01:04:00.000000" start_time="2012-12-05 01:03:00.000000" traceback="" event="compute_create" result="Success"/>
</instanceAction>

This operation does not accept a request body.

Servers password (servers, os-server-password)

Gets and resets the encrypted administrative password set through the metadata service.

GET

/v2/{tenant_id}/servers/{server_id}/os-server-password

Get server password

Gets the administrative password for a specified server.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
server_id	URI	csapi:UUID	The UUID for the server of interest to you.

{
    "password": "xlozO3wLCBRWAa2yDjCCVx8vwNPypxnypmRYDa/zErlQ+EzPe1S/Gz6nfmC52mOlOSCRuUOmG7kqqgejPof6M7bOezS387zjq4LSvvwp28zUknzy4YzfFGhnHAdai3TxUJ26pfQCYrq8UTzmKF2Bq8ioSEtVVzM0A96pDh8W2i7BOz6MdoiVyiev/I1K2LsuipfxSJR7Wdke4zNXJjHHP2RfYsVbZ/k9ANu+Nz4iIH8/7Cacud/pphH7EjrY6a4RZNrjQskrhKYed0YERpotyjYk1eDtRe72GrSiXteqCM4biaQ5w3ruS+AcX//PXk3uJ5kC7d67fPXaVz4WaQRYMg=="
}

<?xml version='1.0' encoding='UTF-8'?>
<password>xlozO3wLCBRWAa2yDjCCVx8vwNPypxnypmRYDa/zErlQ+EzPe1S/Gz6nfmC52mOlOSCRuUOmG7kqqgejPof6M7bOezS387zjq4LSvvwp28zUknzy4YzfFGhnHAdai3TxUJ26pfQCYrq8UTzmKF2Bq8ioSEtVVzM0A96pDh8W2i7BOz6MdoiVyiev/I1K2LsuipfxSJR7Wdke4zNXJjHHP2RfYsVbZ/k9ANu+Nz4iIH8/7Cacud/pphH7EjrY6a4RZNrjQskrhKYed0YERpotyjYk1eDtRe72GrSiXteqCM4biaQ5w3ruS+AcX//PXk3uJ5kC7d67fPXaVz4WaQRYMg==</password>

This operation does not accept a request body.

DELETE

/v2/{tenant_id}/servers/{server_id}/os-server-password

Clear server password

Clears the encrypted copy of the password in the metadata server. This is done after the client has retrieved the password and knows it doesn't need it in the metadata server anymore. The password for the server remains the same.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
server_id	URI	csapi:UUID	The UUID for the server of interest to you.

{
    "server": {
        "name": "new-server-test",
        "imageRef": "http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b",
        "flavorRef": "http://openstack.example.com/openstack/flavors/1",
        "metadata": {
            "My Server Name": "Apache1"
        },
        "personality": [
            {
                "path": "/etc/banner.txt",
                "contents": "ICAgICAgDQoiQSBjbG91ZCBkb2VzIG5vdCBrbm93IHdoeSBpdCBtb3ZlcyBpbiBqdXN0IHN1Y2ggYSBkaXJlY3Rpb24gYW5kIGF0IHN1Y2ggYSBzcGVlZC4uLkl0IGZlZWxzIGFuIGltcHVsc2lvbi4uLnRoaXMgaXMgdGhlIHBsYWNlIHRvIGdvIG5vdy4gQnV0IHRoZSBza3kga25vd3MgdGhlIHJlYXNvbnMgYW5kIHRoZSBwYXR0ZXJucyBiZWhpbmQgYWxsIGNsb3VkcywgYW5kIHlvdSB3aWxsIGtub3csIHRvbywgd2hlbiB5b3UgbGlmdCB5b3Vyc2VsZiBoaWdoIGVub3VnaCB0byBzZWUgYmV5b25kIGhvcml6b25zLiINCg0KLVJpY2hhcmQgQmFjaA=="
            }
        ]
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<server xmlns="http://docs.openstack.org/compute/api/v1.1" imageRef="http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b" flavorRef="http://openstack.example.com/openstack/flavors/1" name="new-server-test">
  <metadata>
    <meta key="My Server Name">Apache1</meta>
  </metadata>
  <personality>
    <file path="/etc/banner.txt">
        ICAgICAgDQoiQSBjbG91ZCBkb2VzIG5vdCBrbm93IHdoeSBp
        dCBtb3ZlcyBpbiBqdXN0IHN1Y2ggYSBkaXJlY3Rpb24gYW5k
        IGF0IHN1Y2ggYSBzcGVlZC4uLkl0IGZlZWxzIGFuIGltcHVs
        c2lvbi4uLnRoaXMgaXMgdGhlIHBsYWNlIHRvIGdvIG5vdy4g
        QnV0IHRoZSBza3kga25vd3MgdGhlIHJlYXNvbnMgYW5kIHRo
        ZSBwYXR0ZXJucyBiZWhpbmQgYWxsIGNsb3VkcywgYW5kIHlv
        dSB3aWxsIGtub3csIHRvbywgd2hlbiB5b3UgbGlmdCB5b3Vy
        c2VsZiBoaWdoIGVub3VnaCB0byBzZWUgYmV5b25kIGhvcml6
        b25zLiINCg0KLVJpY2hhcmQgQmFjaA==
    </file>
  </personality>
</server>

{
    "server": {
        "adminPass": "78AtBtuxTqZV",
        "id": "66fd64e1-de18-4506-bfb6-b5e73ef78a43",
        "links": [
            {
                "href": "http://openstack.example.com/v2/openstack/servers/66fd64e1-de18-4506-bfb6-b5e73ef78a43",
                "rel": "self"
            },
            {
                "href": "http://openstack.example.com/openstack/servers/66fd64e1-de18-4506-bfb6-b5e73ef78a43",
                "rel": "bookmark"
            }
        ]
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<server xmlns:atom="http://www.w3.org/2005/Atom" xmlns="http://docs.openstack.org/compute/api/v1.1" id="b68e3354-0b1a-4e92-a664-8b332cff27f5" adminPass="sLV7uLzmgoHu">
  <metadata/>
  <atom:link href="http://openstack.example.com/v2/openstack/servers/b68e3354-0b1a-4e92-a664-8b332cff27f5" rel="self"/>
  <atom:link href="http://openstack.example.com/openstack/servers/b68e3354-0b1a-4e92-a664-8b332cff27f5" rel="bookmark"/>
</server>

Servers virtual interfaces (servers, os-virtual-interfaces)

Lists the virtual interfaces for a specified server instance.

GET

/v2/{tenant_id}/servers/{server_id}/os-virtual-interfaces

List virtual interfaces

Lists the virtual interfaces for a specified instance.

Normal response codes

202

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
server_id	URI	csapi:UUID	The UUID for the server of interest to you.

{
    "virtual_interfaces": [
        {
            "id": "cec8b9bb-5d22-4104-b3c8-4c35db3210a6",
            "mac_address": "fa:16:3e:3c:ce:6f"
        }
    ]
}

<?xml version='1.0' encoding='UTF-8'?>
<virtual_interfaces xmlns="http://docs.openstack.org/compute/api/v1.1">
  <virtual_interface id="94edf7aa-565a-469a-8f45-656b4acf8229" mac_address="fa:16:3e:7d:31:9a"/>
</virtual_interfaces>

This operation does not accept a request body.

GET

/v2/{tenant_id}/servers/{server_id}/os-virtual-interfaces

Show virtual interface and attached network

Shows the virtual interface for a specified instance. Includes the OS-EXT-VIF-NET:net_id attribute that shows to which network the interface is attached.

Normal response codes

202

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
server_id	URI	csapi:UUID	The UUID for the server of interest to you.

{
    "virtual_interfaces": [
        {
            "id": "cec8b9bb-5d22-4104-b3c8-4c35db3210a6",
            "mac_address": "fa:16:3e:3c:ce:6f",
            "OS-EXT-VIF-NET:net_id": "cec8b9bb-5d22-4104-b3c8-4c35db3210a7"
        }
    ]
}

<?xml version='1.0' encoding='UTF-8'?>
<virtual_interfaces
xmlns:OS-EXT-VIF-NET="http://docs.openstack.org/compute/ext/extended-virtual-interfaces-net/api/v1.1"
xmlns="http://docs.openstack.org/compute/api/v1.1">
  <virtual_interface id="94edf7aa-565a-469a-8f45-656b4acf8229"
                     mac_address="fa:16:3e:7d:31:9a"
                     OS-EXT-VIF-NET:net_id="94edf7aa-565a-469a-8f45-656b4acf8230"/>
</virtual_interfaces>

This operation does not accept a request body.

Servers with volume attachments (servers, os-volume_attachments)

Attaches volumes that are created through the volume API to server instances. Also, lists volume attachments for a server instance, gets volume details for a volume attachment, and detaches a volume.

POST

/v2/{tenant_id}/servers/{server_id}/os-volume_attachments

Attach volume

Attaches a volume to the specified server.

Preconditions

You can attach a volume to a server with an ACTIVE, PAUSED, SHUTOFF, VERIFY_RESIZE, or SOFT_DELETED status.
You can attach a volume to a server with a status that is not locked.
You can attach a volume when its status is available.
You can attach a volume when its volume type supports volume attaching.

Asynchronous Postconditions

After successfully attaching a volume to a server, the volume status changes to in-use.
You can see the attached volume when you log in to the server.

Troubleshooting

If the volume status remains in available state, the request failed. Ensure that you meet the preconditions and run the request again. If the request fails again, investigate the server and the volume status.

Normal response codes

202

Error response codes

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
server_id	URI	csapi:UUID	The UUID for the server of interest to you.
volumeId	URI	xsd:string	ID of the volume to attach.
device	URI	xsd:string	Name of the device such as, `/dev/vdb`. Omit or set this parameter to null for auto-assignment, if supported. If you specify this parameter, the device must not exist in the guest operating system.
volumeAttachment	URI	xsd:string	A dictionary representation of a volume attachment.

{
    "volumeAttachment": {
        "volumeId": "a26887c6-c47b-4654-abb5-dfadf7d3f803"
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<volumeAttachment volumeId="a26887c6-c47b-4654-abb5-dfadf7d3f803" />

{
    "volumeAttachment": {
        "device": "/dev/vdd",
        "id": "a26887c6-c47b-4654-abb5-dfadf7d3f803",
        "serverId": "0c92f3f6-c253-4c9b-bd43-e880a8d2eb0a",
        "volumeId": "a26887c6-c47b-4654-abb5-dfadf7d3f803"
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<volumeAttachment device="/dev/vdd" serverId="20f0cb44-7b00-4019-a612-364777cd2931" id="a26887c6-c47b-4654-abb5-dfadf7d3f803" volumeId="a26887c6-c47b-4654-abb5-dfadf7d3f803"/>

GET

/v2/{tenant_id}/servers/{server_id}/os-volume_attachments

List volume attachments

Lists the volume attachments for a specified server.

Normal response codes

202

Error response codes

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
server_id	URI	csapi:UUID	The UUID for the server of interest to you.

{
    "volumeAttachments": [
        {
            "device": "/dev/sdd",
            "id": "a26887c6-c47b-4654-abb5-dfadf7d3f803",
            "serverId": "4d8c3732-a248-40ed-bebc-539a6ffd25c0",
            "volumeId": "a26887c6-c47b-4654-abb5-dfadf7d3f803"
        },
        {
            "device": "/dev/sdc",
            "id": "a26887c6-c47b-4654-abb5-dfadf7d3f804",
            "serverId": "4d8c3732-a248-40ed-bebc-539a6ffd25c0",
            "volumeId": "a26887c6-c47b-4654-abb5-dfadf7d3f804"
        }
    ]
}

<?xml version='1.0' encoding='UTF-8'?>
<volumeAttachments>
  <volumeAttachment device="/dev/sdd" serverId="4335bab6-6086-4247-8274-8b8b048edaaa" id="a26887c6-c47b-4654-abb5-dfadf7d3f803" volumeId="a26887c6-c47b-4654-abb5-dfadf7d3f803"/>
  <volumeAttachment device="/dev/sdc" serverId="4335bab6-6086-4247-8274-8b8b048edaaa" id="a26887c6-c47b-4654-abb5-dfadf7d3f804" volumeId="a26887c6-c47b-4654-abb5-dfadf7d3f804"/>
</volumeAttachments>

GET

/v2/{tenant_id}/servers/{server_id}/os-volume_attachments/{attachment_id}

Show volume attachment details

Shows details for the specified volume attachment.

Preconditions

The specified volume must be attached to the server.

Normal response codes

202

Error response codes

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
server_id	URI	csapi:UUID	The UUID for the server of interest to you.
attachment_id	URI	xsd:string	Volume attachment ID.

{
    "volumeAttachment": {
        "device": "/dev/sdd",
        "id": "a26887c6-c47b-4654-abb5-dfadf7d3f803",
        "serverId": "2390fb4d-1693-45d7-b309-e29c4af16538",
        "volumeId": "a26887c6-c47b-4654-abb5-dfadf7d3f803"
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<volumeAttachment device="/dev/sdd" serverId="20f12907-3993-44f7-a680-d51e2ceedbd9" id="a26887c6-c47b-4654-abb5-dfadf7d3f803" volumeId="a26887c6-c47b-4654-abb5-dfadf7d3f803"/>

DELETE

/v2/{tenant_id}/servers/{server_id}/os-volume_attachments/{attachment_id}

Detach volume

Detaches the specified volume from a specified server.

Preconditions

The specified volume must be attached to the server.
You can detach a volume when the server status is ACTIVE, PAUSED, SHUTOFF, VERIFY_RESIZE, or SOFT_DELETED.
You can detach a volume when its status is in-use.
You can detach a volume from a server with a status that is not locked.
You cannot detach a root device volume.

Asynchronous Postconditions

After successfully detaching a volume, its status changes to available.
The detached volume is no longer visible on the server.

Troubleshooting

If the volume status remains in available state, the request failed. Ensure that you meet the preconditions and run the request again. If the request fails again, investigate whether another operation is running that causes a race condition.
If you attempt to detach a root device volume, this operation returns the 403 HTTP Forbidden error code.

Normal response codes

202

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
server_id	URI	csapi:UUID	The UUID for the server of interest to you.
attachment_id	URI	xsd:string	Volume attachment ID.

This operation does not return a response body.

Server boot from volume (os-volumes_boot)

Starts an instance by using a volume with the bootable attribute. The image on the volume is used to boot the instance.

POST

/v2/{tenant_id}/os-volumes_boot

Create server

Starts a new instance from a bootable volume.

Preconditions

You can attach a volume to a server with a status that is not locked.
You can boot to a volume when its status is available.
You can boot to a volume when the volume was created as a bootable volume.

Asynchronous Postconditions

After successfully booting a server, the volume status changes to in-use.

Troubleshooting

If the volume status remains in available state, the request failed. Ensure that you meet the preconditions and run the request again. If the request fails again, investigate the server and the volume status.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
imageRef	URI	xsd:string	ID of the image to use to boot from volume.
display_name	URI	xsd:string	Name of the bootable volume.
volume_type	URI	xsd:string	A type of volume such as SSD.

{
    "server": {
        "name": "BFVServer",
        "imageRef": "",
        "block_device_mapping": [
            {
                "source_type": "volume",
                "boot_index": 0,
                "uuid": "7b4dc407-d515-4d96-9eba-cf86bd4a61f7",
                "volume_id": "7b4dc407-d515-4d96-9eba-cf86bd4a61f7",
                "device_name": "vda"
            }
        ],
        "flavorRef": "1",
        "max_count": 1,
        "min_count": 1
    }
}

{
    "server": {
        "security_groups": [
            {
                "name": "default"
            }
        ],
        "OS-DCF:diskConfig": "MANUAL",
        "id": "2eb966e3-0511-4a71-a05a-ca3fcf09eea9",
        "links": [
            {
                "href": "http://8.21.28.222:8774/v2/f9828a18c6484624b571e85728780ba8/servers/2eb966e3-0511-4a71-a05a-ca3fcf09eea9",
                "rel": "self"
            },
            {
                "href": "http://8.21.28.222:8774/f9828a18c6484624b571e85728780ba8/servers/2eb966e3-0511-4a71-a05a-ca3fcf09eea9",
                "rel": "bookmark"
            }
        ],
        "adminPass": "secretsecret"
    }
}

Flavors create and delete (flavors)

Creates, lists, and deletes flavors.

POST

/v2/{tenant_id}/flavors

Create flavor

Creates a flavor.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The unique ID of the tenant or account.
name	plain	String	The name for the new flavor.
ram	plain	String	The amount of RAM, in MBs, for this flavor.
vcpus	plain	String	The virtual CPUs, in a whole integer amount, for the new flavor.
disk	plain	String	The amount of disk space, in GBs.
id	plain	String	The ID for the new flavor, which is a unique integer value.

{
    "flavor": {
        "name": "test_flavor",
        "ram": 1024,
        "vcpus": 2,
        "disk": 10,
        "id": "10"
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<flavor>
    <name>test_flavor</name>
    <ram>1024</ram>
    <vcpus>2</vcpus>
    <disk>10</disk>
    <id>10</id>
</flavor>

{
    "flavor": {
        "disk": 10,
        "id": "10",
        "links": [
            {
                "href": "http://openstack.example.com/v2/openstack/flavors/10",
                "rel": "self"
            },
            {
                "href": "http://openstack.example.com/openstack/flavors/10",
                "rel": "bookmark"
            }
        ],
        "name": "test_flavor",
        "ram": 1024,
        "vcpus": 2
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<flavor xmlns:atom="http://www.w3.org/2005/Atom" xmlns="http://docs.openstack.org/compute/api/v1.1" disk="10" vcpus="2" ram="1024" name="test_flavor" id="10">
  <atom:link href="http://openstack.example.com/v2/openstack/flavors/10" rel="self"/>
  <atom:link href="http://openstack.example.com/openstack/flavors/10" rel="bookmark"/>
</flavor>

DELETE

/v2/{tenant_id}/flavors/{flavor_id}

Delete flavor

Deletes a flavor.

Normal response codes

204

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The unique ID of the tenant or account.
flavor_id	URI	String	The flavor ID.

This operation does not accept a request body and does not return a response body.

Flavors with disabled attribute (flavors)

Lists and gets details for flavors. Includes the disabled extended attribute.

GET

/v2/{tenant_id}/flavors/{flavor_id}

Get flavor disabled status details

Gets details for a specified flavor. Includes the OS-FLV-DISABLED:disabled attribute.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
flavor_id	URI	csapi:uuid	The ID of the flavor of interest to you.

{
    "flavor": {
        "OS-FLV-DISABLED:disabled": false,
        "disk": 1,
        "id": "1",
        "links": [
            {
                "href": "http://openstack.example.com/v2/openstack/flavors/1",
                "rel": "self"
            },
            {
                "href": "http://openstack.example.com/openstack/flavors/1",
                "rel": "bookmark"
            }
        ],
        "name": "m1.tiny",
        "ram": 512,
        "vcpus": 1
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<flavor xmlns:OS-FLV-DISABLED="http://docs.openstack.org/compute/ext/flavor_disabled/api/v1.1" xmlns:atom="http://www.w3.org/2005/Atom" xmlns="http://docs.openstack.org/compute/api/v1.1" disk="1" vcpus="1" ram="512" name="m1.tiny" id="1" OS-FLV-DISABLED:disabled="False">
  <atom:link href="http://openstack.example.com/v2/openstack/flavors/1" rel="self"/>
  <atom:link href="http://openstack.example.com/openstack/flavors/1" rel="bookmark"/>
</flavor>

This operation does not accept a request body.

GET

/v2/{tenant_id}/flavors/detail

List flavors with flavor disabled status

Lists available flavors. Includes the OS-FLV-DISABLED:disabled attribute.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.

{
    "flavors": [
        {
            "OS-FLV-DISABLED:disabled": false,
            "disk": 1,
            "id": "1",
            "links": [
                {
                    "href": "http://openstack.example.com/v2/openstack/flavors/1",
                    "rel": "self"
                },
                {
                    "href": "http://openstack.example.com/openstack/flavors/1",
                    "rel": "bookmark"
                }
            ],
            "name": "m1.tiny",
            "ram": 512,
            "vcpus": 1
        },
        {
            "OS-FLV-DISABLED:disabled": false,
            "disk": 20,
            "id": "2",
            "links": [
                {
                    "href": "http://openstack.example.com/v2/openstack/flavors/2",
                    "rel": "self"
                },
                {
                    "href": "http://openstack.example.com/openstack/flavors/2",
                    "rel": "bookmark"
                }
            ],
            "name": "m1.small",
            "ram": 2048,
            "vcpus": 1
        },
        {
            "OS-FLV-DISABLED:disabled": false,
            "disk": 40,
            "id": "3",
            "links": [
                {
                    "href": "http://openstack.example.com/v2/openstack/flavors/3",
                    "rel": "self"
                },
                {
                    "href": "http://openstack.example.com/openstack/flavors/3",
                    "rel": "bookmark"
                }
            ],
            "name": "m1.medium",
            "ram": 4096,
            "vcpus": 2
        },
        {
            "OS-FLV-DISABLED:disabled": false,
            "disk": 80,
            "id": "4",
            "links": [
                {
                    "href": "http://openstack.example.com/v2/openstack/flavors/4",
                    "rel": "self"
                },
                {
                    "href": "http://openstack.example.com/openstack/flavors/4",
                    "rel": "bookmark"
                }
            ],
            "name": "m1.large",
            "ram": 8192,
            "vcpus": 4
        },
        {
            "OS-FLV-DISABLED:disabled": false,
            "disk": 160,
            "id": "5",
            "links": [
                {
                    "href": "http://openstack.example.com/v2/openstack/flavors/5",
                    "rel": "self"
                },
                {
                    "href": "http://openstack.example.com/openstack/flavors/5",
                    "rel": "bookmark"
                }
            ],
            "name": "m1.xlarge",
            "ram": 16384,
            "vcpus": 8
        }
    ]
}

<?xml version='1.0' encoding='UTF-8'?>
<flavors xmlns:OS-FLV-DISABLED="http://docs.openstack.org/compute/ext/flavor_disabled/api/v1.1" xmlns:atom="http://www.w3.org/2005/Atom" xmlns="http://docs.openstack.org/compute/api/v1.1">
  <flavor disk="1" vcpus="1" ram="512" name="m1.tiny" id="1" OS-FLV-DISABLED:disabled="False">
    <atom:link href="http://openstack.example.com/v2/openstack/flavors/1" rel="self"/>
    <atom:link href="http://openstack.example.com/openstack/flavors/1" rel="bookmark"/>
  </flavor>
  <flavor disk="20" vcpus="1" ram="2048" name="m1.small" id="2" OS-FLV-DISABLED:disabled="False">
    <atom:link href="http://openstack.example.com/v2/openstack/flavors/2" rel="self"/>
    <atom:link href="http://openstack.example.com/openstack/flavors/2" rel="bookmark"/>
  </flavor>
  <flavor disk="40" vcpus="2" ram="4096" name="m1.medium" id="3" OS-FLV-DISABLED:disabled="False">
    <atom:link href="http://openstack.example.com/v2/openstack/flavors/3" rel="self"/>
    <atom:link href="http://openstack.example.com/openstack/flavors/3" rel="bookmark"/>
  </flavor>
  <flavor disk="80" vcpus="4" ram="8192" name="m1.large" id="4" OS-FLV-DISABLED:disabled="False">
    <atom:link href="http://openstack.example.com/v2/openstack/flavors/4" rel="self"/>
    <atom:link href="http://openstack.example.com/openstack/flavors/4" rel="bookmark"/>
  </flavor>
  <flavor disk="160" vcpus="8" ram="16384" name="m1.xlarge" id="5" OS-FLV-DISABLED:disabled="False">
    <atom:link href="http://openstack.example.com/v2/openstack/flavors/5" rel="self"/>
    <atom:link href="http://openstack.example.com/openstack/flavors/5" rel="bookmark"/>
  </flavor>
</flavors>

This operation does not accept a request body.

Flavors with extended attributes (flavors)

Creates, gets details for, and lists details for flavors. Includes the rxtx_factor, OS-FLV-EXT-DATA:ephemeral, and swap extended attributes.

POST

/v2/{tenant_id}/flavors

Create flavor with extra data

Creates a flavor. Includes the rxtx_factor, OS-FLV-EXT-DATA:ephemeral, and swap extended attributes.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
name	plain	String	The name for the flavor.
ram	plain	String	The amount of RAM, in MBs, for the flavor.
vcpus	plain	String	The virtual CPUs, in a whole integer amount, for the flavor.
disk	plain	String	The amount of disk space, in GBs, for the flavor.
id	plain	String	The ID, a unique integer value, for the flavor.
rxtx_factor	plain	String	Enables you to override the bandwidth cap value, which defaults to the bandwidth cap value for the network to which the flavor is attached. The new bandwidth cap is calculated by multiplying the rxtx_factor valued that you specify by the rxtx_base property for the network.
OS-FLV-EXT-DATA:ephemeral	plain	String	The size of secondary drive, in GBs, to attach to a server.
swap	plain	String	The amount of swap disk space, in GBs, to allocate to a server.

{
    "flavor": {
        "name": "flavortest",
        "ram": 1024,
        "vcpus": 2,
        "disk": 10,
        "id": "666",
        "rxtx_factor": 2.0,
        "OS-FLV-EXT-DATA:ephemeral": 30,
        "swap": 5
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<flavor xmlns="http://docs.openstack.org/compute/api/v1.1"
    xmlns:OS-FLV-EXT-DATA="http://docs.openstack.org/compute/ext/flavor_extra_data/api/v1.1"
    name="flavortest"
    ram="1024"
    vcpus="2"
    disk="10"
    id="666"
    swap="5"
    rxtx_factor="2.0"
    OS-FLV-EXT-DATA:ephemeral="30" />

{
    "flavor": {
        "OS-FLV-EXT-DATA:ephemeral": 30,
        "disk": 10,
        "id": "666",
        "links": [
            {
                "href": "http://openstack.example.com/v2/openstack/flavors/666",
                "rel": "self"
            },
            {
                "href": "http://openstack.example.com/openstack/flavors/666",
                "rel": "bookmark"
            }
        ],
        "name": "flavortest",
        "ram": 1024,
        "vcpus": 2
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<flavor xmlns:OS-FLV-EXT-DATA="http://docs.openstack.org/compute/ext/flavor_extra_data/api/v1.1" xmlns:atom="http://www.w3.org/2005/Atom" xmlns="http://docs.openstack.org/compute/api/v1.1" disk="10" vcpus="2" ram="1024" name="flavortest" id="666" OS-FLV-EXT-DATA:ephemeral="30">
  <atom:link href="http://openstack.example.com/v2/openstack/flavors/666" rel="self"/>
  <atom:link href="http://openstack.example.com/openstack/flavors/666" rel="bookmark"/>
</flavor>

GET

/v2/{tenant_id}/flavors/{flavor_id}

Get flavor extra data details

Gets details for a specified flavor. Includes the rxtx_factor, OS-FLV-EXT-DATA:ephemeral, and swap extended attributes.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
flavor_id	URI	String	The ID of the flavor of interest to you.

{
    "flavor": {
        "OS-FLV-EXT-DATA:ephemeral": 0,
        "disk": 1,
        "id": "1",
        "links": [
            {
                "href": "http://openstack.example.com/v2/openstack/flavors/1",
                "rel": "self"
            },
            {
                "href": "http://openstack.example.com/openstack/flavors/1",
                "rel": "bookmark"
            }
        ],
        "name": "m1.tiny",
        "ram": 512,
        "vcpus": 1
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<flavor xmlns:OS-FLV-EXT-DATA="http://docs.openstack.org/compute/ext/flavor_extra_data/api/v1.1" xmlns:atom="http://www.w3.org/2005/Atom" xmlns="http://docs.openstack.org/compute/api/v1.1" disk="1" vcpus="1" ram="512" name="m1.tiny" id="1" OS-FLV-EXT-DATA:ephemeral="0">
  <atom:link href="http://openstack.example.com/v2/openstack/flavors/1" rel="self"/>
  <atom:link href="http://openstack.example.com/openstack/flavors/1" rel="bookmark"/>
</flavor>

This operation does not accept a request body.

GET

/v2/{tenant_id}/flavors/detail

List flavors with extra data

Lists available flavors. Includes the rxtx_factor, OS-FLV-EXT-DATA:ephemeral, and swap extended attributes.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.

{
    "flavors": [
        {
            "OS-FLV-EXT-DATA:ephemeral": 0,
            "disk": 1,
            "id": "1",
            "links": [
                {
                    "href": "http://openstack.example.com/v2/openstack/flavors/1",
                    "rel": "self"
                },
                {
                    "href": "http://openstack.example.com/openstack/flavors/1",
                    "rel": "bookmark"
                }
            ],
            "name": "m1.tiny",
            "ram": 512,
            "vcpus": 1
        },
        {
            "OS-FLV-EXT-DATA:ephemeral": 0,
            "disk": 20,
            "id": "2",
            "links": [
                {
                    "href": "http://openstack.example.com/v2/openstack/flavors/2",
                    "rel": "self"
                },
                {
                    "href": "http://openstack.example.com/openstack/flavors/2",
                    "rel": "bookmark"
                }
            ],
            "name": "m1.small",
            "ram": 2048,
            "vcpus": 1
        },
        {
            "OS-FLV-EXT-DATA:ephemeral": 0,
            "disk": 40,
            "id": "3",
            "links": [
                {
                    "href": "http://openstack.example.com/v2/openstack/flavors/3",
                    "rel": "self"
                },
                {
                    "href": "http://openstack.example.com/openstack/flavors/3",
                    "rel": "bookmark"
                }
            ],
            "name": "m1.medium",
            "ram": 4096,
            "vcpus": 2
        },
        {
            "OS-FLV-EXT-DATA:ephemeral": 0,
            "disk": 80,
            "id": "4",
            "links": [
                {
                    "href": "http://openstack.example.com/v2/openstack/flavors/4",
                    "rel": "self"
                },
                {
                    "href": "http://openstack.example.com/openstack/flavors/4",
                    "rel": "bookmark"
                }
            ],
            "name": "m1.large",
            "ram": 8192,
            "vcpus": 4
        },
        {
            "OS-FLV-EXT-DATA:ephemeral": 0,
            "disk": 160,
            "id": "5",
            "links": [
                {
                    "href": "http://openstack.example.com/v2/openstack/flavors/5",
                    "rel": "self"
                },
                {
                    "href": "http://openstack.example.com/openstack/flavors/5",
                    "rel": "bookmark"
                }
            ],
            "name": "m1.xlarge",
            "ram": 16384,
            "vcpus": 8
        }
    ]
}

<?xml version='1.0' encoding='UTF-8'?>
<flavors xmlns:OS-FLV-EXT-DATA="http://docs.openstack.org/compute/ext/flavor_extra_data/api/v1.1" xmlns:atom="http://www.w3.org/2005/Atom" xmlns="http://docs.openstack.org/compute/api/v1.1">
  <flavor disk="1" vcpus="1" ram="512" name="m1.tiny" id="1" OS-FLV-EXT-DATA:ephemeral="0">
    <atom:link href="http://openstack.example.com/v2/openstack/flavors/1" rel="self"/>
    <atom:link href="http://openstack.example.com/openstack/flavors/1" rel="bookmark"/>
  </flavor>
  <flavor disk="20" vcpus="1" ram="2048" name="m1.small" id="2" OS-FLV-EXT-DATA:ephemeral="0">
    <atom:link href="http://openstack.example.com/v2/openstack/flavors/2" rel="self"/>
    <atom:link href="http://openstack.example.com/openstack/flavors/2" rel="bookmark"/>
  </flavor>
  <flavor disk="40" vcpus="2" ram="4096" name="m1.medium" id="3" OS-FLV-EXT-DATA:ephemeral="0">
    <atom:link href="http://openstack.example.com/v2/openstack/flavors/3" rel="self"/>
    <atom:link href="http://openstack.example.com/openstack/flavors/3" rel="bookmark"/>
  </flavor>
  <flavor disk="80" vcpus="4" ram="8192" name="m1.large" id="4" OS-FLV-EXT-DATA:ephemeral="0">
    <atom:link href="http://openstack.example.com/v2/openstack/flavors/4" rel="self"/>
    <atom:link href="http://openstack.example.com/openstack/flavors/4" rel="bookmark"/>
  </flavor>
  <flavor disk="160" vcpus="8" ram="16384" name="m1.xlarge" id="5" OS-FLV-EXT-DATA:ephemeral="0">
    <atom:link href="http://openstack.example.com/v2/openstack/flavors/5" rel="self"/>
    <atom:link href="http://openstack.example.com/openstack/flavors/5" rel="bookmark"/>
  </flavor>
</flavors>

This operation does not accept a request body.

Flavors with rxtx_factor extended attribute (flavors)

Creates, gets details for, and lists details for flavors. Includes the rxtx_factor extended attribute, which is related to configured bandwidth cap values.

POST

/v2/{tenant_id}/flavors

Create flavor with rxtx_factor

Creates a flavor. Includes the rxtx_factor extended attribute.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.

{
    "flavor": {
        "name": "flavortest",
        "ram": 1024,
        "vcpus": 2,
        "disk": 10,
        "id": "100",
        "rxtx_factor": 2.0
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<flavor xmlns="http://docs.openstack.org/compute/api/v1.1"
    xmlns:OS-FLV-EXT-DATA="http://docs.openstack.org/compute/ext/flavor_extra_data/api/v1.1"
    name="flavortest"
    ram="1024"
    vcpus="2"
    disk="10"
    id="100"
    rxtx_factor="2.0" />

{
    "flavor": {
        "disk": 10,
        "id": "100",
        "links": [
            {
                "href": "http://openstack.example.com/v2/openstack/flavors/100",
                "rel": "self"
            },
            {
                "href": "http://openstack.example.com/openstack/flavors/100",
                "rel": "bookmark"
            }
        ],
        "name": "flavortest",
        "ram": 1024,
        "rxtx_factor": 2.0,
        "vcpus": 2
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<flavor xmlns:atom="http://www.w3.org/2005/Atom" xmlns="http://docs.openstack.org/compute/api/v1.1" disk="10" vcpus="2" ram="1024" name="flavortest" id="100" rxtx_factor="2.0">
  <atom:link href="http://openstack.example.com/v2/openstack/flavors/100" rel="self"/>
  <atom:link href="http://openstack.example.com/openstack/flavors/100" rel="bookmark"/>
</flavor>

GET

/v2/{tenant_id}/flavors/{flavor_id}

Get flavor with rxtx_factor

Gets details for a specified flavor. Includes the rxtx_factor extended attribute.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
flavor_id	URI	String	The flavor ID.

{
    "flavor": {
        "disk": 1,
        "id": "1",
        "links": [
            {
                "href": "http://openstack.example.com/v2/openstack/flavors/1",
                "rel": "self"
            },
            {
                "href": "http://openstack.example.com/openstack/flavors/1",
                "rel": "bookmark"
            }
        ],
        "name": "m1.tiny",
        "ram": 512,
        "rxtx_factor": 1.0,
        "vcpus": 1
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<flavor xmlns:atom="http://www.w3.org/2005/Atom" xmlns="http://docs.openstack.org/compute/api/v1.1" disk="1" vcpus="1" ram="512" name="m1.tiny" id="1" rxtx_factor="1.0">
  <atom:link href="http://openstack.example.com/v2/openstack/flavors/1" rel="self"/>
  <atom:link href="http://openstack.example.com/openstack/flavors/1" rel="bookmark"/>
</flavor>

This operation does not accept a request body.

GET

/v2/{tenant_id}/flavors/detail

Get flavor Details with rxtx_factor

Lists details for available flavors and includes the rxtx_factor extended attribute.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.

{
    "flavors": [
        {
            "disk": 1,
            "id": "1",
            "links": [
                {
                    "href": "http://openstack.example.com/v2/openstack/flavors/1",
                    "rel": "self"
                },
                {
                    "href": "http://openstack.example.com/openstack/flavors/1",
                    "rel": "bookmark"
                }
            ],
            "name": "m1.tiny",
            "ram": 512,
            "rxtx_factor": 1.0,
            "vcpus": 1
        },
        {
            "disk": 20,
            "id": "2",
            "links": [
                {
                    "href": "http://openstack.example.com/v2/openstack/flavors/2",
                    "rel": "self"
                },
                {
                    "href": "http://openstack.example.com/openstack/flavors/2",
                    "rel": "bookmark"
                }
            ],
            "name": "m1.small",
            "ram": 2048,
            "rxtx_factor": 1.0,
            "vcpus": 1
        },
        {
            "disk": 40,
            "id": "3",
            "links": [
                {
                    "href": "http://openstack.example.com/v2/openstack/flavors/3",
                    "rel": "self"
                },
                {
                    "href": "http://openstack.example.com/openstack/flavors/3",
                    "rel": "bookmark"
                }
            ],
            "name": "m1.medium",
            "ram": 4096,
            "rxtx_factor": 1.0,
            "vcpus": 2
        },
        {
            "disk": 80,
            "id": "4",
            "links": [
                {
                    "href": "http://openstack.example.com/v2/openstack/flavors/4",
                    "rel": "self"
                },
                {
                    "href": "http://openstack.example.com/openstack/flavors/4",
                    "rel": "bookmark"
                }
            ],
            "name": "m1.large",
            "ram": 8192,
            "rxtx_factor": 1.0,
            "vcpus": 4
        },
        {
            "disk": 160,
            "id": "5",
            "links": [
                {
                    "href": "http://openstack.example.com/v2/openstack/flavors/5",
                    "rel": "self"
                },
                {
                    "href": "http://openstack.example.com/openstack/flavors/5",
                    "rel": "bookmark"
                }
            ],
            "name": "m1.xlarge",
            "ram": 16384,
            "rxtx_factor": 1.0,
            "vcpus": 8
        }
    ]
}

<?xml version='1.0' encoding='UTF-8'?>
<flavors xmlns:atom="http://www.w3.org/2005/Atom" xmlns="http://docs.openstack.org/compute/api/v1.1">
  <flavor disk="1" vcpus="1" ram="512" name="m1.tiny" id="1" rxtx_factor="1.0">
    <atom:link href="http://openstack.example.com/v2/openstack/flavors/1" rel="self"/>
    <atom:link href="http://openstack.example.com/openstack/flavors/1" rel="bookmark"/>
  </flavor>
  <flavor disk="20" vcpus="1" ram="2048" name="m1.small" id="2" rxtx_factor="1.0">
    <atom:link href="http://openstack.example.com/v2/openstack/flavors/2" rel="self"/>
    <atom:link href="http://openstack.example.com/openstack/flavors/2" rel="bookmark"/>
  </flavor>
  <flavor disk="40" vcpus="2" ram="4096" name="m1.medium" id="3" rxtx_factor="1.0">
    <atom:link href="http://openstack.example.com/v2/openstack/flavors/3" rel="self"/>
    <atom:link href="http://openstack.example.com/openstack/flavors/3" rel="bookmark"/>
  </flavor>
  <flavor disk="80" vcpus="4" ram="8192" name="m1.large" id="4" rxtx_factor="1.0">
    <atom:link href="http://openstack.example.com/v2/openstack/flavors/4" rel="self"/>
    <atom:link href="http://openstack.example.com/openstack/flavors/4" rel="bookmark"/>
  </flavor>
  <flavor disk="160" vcpus="8" ram="16384" name="m1.xlarge" id="5" rxtx_factor="1.0">
    <atom:link href="http://openstack.example.com/v2/openstack/flavors/5" rel="self"/>
    <atom:link href="http://openstack.example.com/openstack/flavors/5" rel="bookmark"/>
  </flavor>
</flavors>

This operation does not accept a request body.

Flavors with extra-specs (flavors, os-extra-specs)

Lists, creates, and updates the extra-specs or keys for a flavor.

GET

/v2/{tenant_id}/flavors/{flavor_id}/os-extra_specs

List flavor extra specs

Lists the extra-specs or keys for the specified flavor.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
flavor_id	URI	String	The ID of the flavor of interest to you.

{
    "extra_specs": {
        "key1": "value1",
        "key2": "value2"
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<extra_specs>
  <key2>value2</key2>
  <key1>value1</key1>
</extra_specs>

This operation does not accept a request body.

POST

/v2/{tenant_id}/flavors/{flavor_id}/os-extra_specs

Create flavor extra specs

Creates extra-specs or keys for the specified flavor.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
flavor_id	URI	String	The ID of the flavor of interest to you.

{
    "extra_specs": {
        "key1": "value1",
        "key2": "value2"
    }
}

<?xml version="1.0" encoding="UTF-8" ?>
<extra_specs>
    <key1>value1</key1>
    <key2>value2</key2>
</extra_specs>

{
    "extra_specs": {
        "key1": "value1",
        "key2": "value2"
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<extra_specs>
  <key2>value2</key2>
  <key1>value1</key1>
</extra_specs>

GET

/v2/{tenant_id}/flavors/{flavor_id}/os-extra_specs/{key_id}

Get flavor extra spec details

Gets the value of the specified key.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
flavor_id	URI	String	The ID of the flavor of interest to you.

{
    "key1": "value1"
}

<?xml version='1.0' encoding='UTF-8'?>
<extra_spec key="key1">value1</extra_spec>

This operation does not accept a request body.

PUT

/v2/{tenant_id}/flavors/{flavor_id}/os-extra_specs/{key_id}

Update flavor extra specs

Updates the value of the specified extra-spec or key.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
flavor_id	URI	String	The ID of the flavor of interest to you.

{
    "key1": "new_value1"
}

<?xml version="1.0" encoding="UTF-8"?>
<key1>new_value1</key1>

{
    "key1": "new_value1"
}

<?xml version='1.0' encoding='UTF-8'?>
<extra_spec key="key1">new_value1</extra_spec>

DELETE

/v2/{tenant_id}/flavors/{flavor_id}/os-extra_specs/{key_id}

Delete flavor extra specs

Deletes a specified extra-spec by key.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
flavor_id	URI	String	The ID of the flavor of interest to you.

This operation does not return a response body.

Flavors access (flavors, os-flavor-access)

Creates and gets details for private flavors. Also, lists, adds, and removes tenants' access to private flavors.

GET

/v2/{tenant_id}/flavors

List flavors with access type

Lists flavors and includes the access type, which is public or private.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID of the tenant or account in a multi-tenancy cloud.

Response parameters

Parameter	Style	Type	Description
disk	plain	xsd:int	Integer value for the minimum disk space in GB.
id	plain	xsd:int	The flavor ID.
links	plain	xsd:string	Flavor links.
name	plain	xsd:string	The flavor name.
ram	plain	xsd:int	Amount of RAM.
vcpus	plain	xsd:int	Number of VCPUs.
os-flavor-access:is_public	plain	xsd:Boolean	Set to true if access is public. Set to false if access is private.

{
    "flavors": [
        {
            "disk": 1,
            "id": "1",
            "links": [
                {
                    "href": "http://openstack.example.com/v2/openstack/flavors/1",
                    "rel": "self"
                },
                {
                    "href": "http://openstack.example.com/openstack/flavors/1",
                    "rel": "bookmark"
                }
            ],
            "name": "m1.tiny",
            "os-flavor-access:is_public": true,
            "ram": 512,
            "vcpus": 1
        },
        {
            "disk": 20,
            "id": "2",
            "links": [
                {
                    "href": "http://openstack.example.com/v2/openstack/flavors/2",
                    "rel": "self"
                },
                {
                    "href": "http://openstack.example.com/openstack/flavors/2",
                    "rel": "bookmark"
                }
            ],
            "name": "m1.small",
            "os-flavor-access:is_public": true,
            "ram": 2048,
            "vcpus": 1
        },
        {
            "disk": 40,
            "id": "3",
            "links": [
                {
                    "href": "http://openstack.example.com/v2/openstack/flavors/3",
                    "rel": "self"
                },
                {
                    "href": "http://openstack.example.com/openstack/flavors/3",
                    "rel": "bookmark"
                }
            ],
            "name": "m1.medium",
            "os-flavor-access:is_public": true,
            "ram": 4096,
            "vcpus": 2
        },
        {
            "disk": 80,
            "id": "4",
            "links": [
                {
                    "href": "http://openstack.example.com/v2/openstack/flavors/4",
                    "rel": "self"
                },
                {
                    "href": "http://openstack.example.com/openstack/flavors/4",
                    "rel": "bookmark"
                }
            ],
            "name": "m1.large",
            "os-flavor-access:is_public": true,
            "ram": 8192,
            "vcpus": 4
        },
        {
            "disk": 160,
            "id": "5",
            "links": [
                {
                    "href": "http://openstack.example.com/v2/openstack/flavors/5",
                    "rel": "self"
                },
                {
                    "href": "http://openstack.example.com/openstack/flavors/5",
                    "rel": "bookmark"
                }
            ],
            "name": "m1.xlarge",
            "os-flavor-access:is_public": true,
            "ram": 16384,
            "vcpus": 8
        }
    ]
}

This operation does not accept a request body.

POST

/v2/{tenant_id}/flavors

Create private flavor

Creates a private flavor.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID of the tenant or account in a multi-tenancy cloud.
disk	plain	xsd:int	Integer value for the minimum disk space in GB.
id	plain	xsd:int	The flavor ID.
name	plain	xsd:string	The flavor name.
ram	plain	xsd:int	Amount of RAM.
vcpus	plain	xsd:int	Number of VCPUs.
os-flavor-access:is_public	plain	xsd:Boolean	Set to true if access is public. Set to false if access is private.

Response parameters

Parameter	Style	Type	Description
disk	plain	xsd:int	Integer value for the minimum disk space in GB.
id	plain	xsd:int	The flavor ID.
links	plain	xsd:string	Flavor links.
name	plain	xsd:string	The flavor name.
ram	plain	xsd:int	Amount of RAM.
vcpus	plain	xsd:int	Number of VCPUs.
os-flavor-access:is_public	plain	xsd:Boolean	Set to true if access is public. Set to false if access is private.

{
    "flavor": {
        "name": "test_flavor",
        "ram": 1024,
        "vcpus": 2,
        "disk": 10,
        "id": "10",
        "os-flavor-access:is_public": false
    }
}

{
    "flavor": {
        "disk": 10,
        "id": "10",
        "links": [
            {
                "href": "http://openstack.example.com/v2/openstack/flavors/10",
                "rel": "self"
            },
            {
                "href": "http://openstack.example.com/openstack/flavors/10",
                "rel": "bookmark"
            }
        ],
        "name": "test_flavor",
        "os-flavor-access:is_public": false,
        "ram": 1024,
        "vcpus": 2
    }
}

GET

/v2/{tenant_id}/flavors/{flavor_id}

Show flavor access type

Gets the flavor access type, which is public or private.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID of the tenant or account in a multi-tenancy cloud.
flavor_id	URI	xsd:int	The ID of the flavor of interest to you.

Response parameters

Parameter	Style	Type	Description
disk	plain	xsd:int	Integer value for the minimum disk space in GB.
id	plain	xsd:int	The flavor ID.
links	plain	xsd:string	Flavor links.
name	plain	xsd:string	The flavor name.
ram	plain	xsd:int	Amount of RAM.
vcpus	plain	xsd:int	Number of VCPUs.
os-flavor-access:is_public	plain	xsd:Boolean	Set to true if access is public. Set to false if access is private.

{
    "flavor": {
        "disk": 1,
        "id": "1",
        "links": [
            {
                "href": "http://openstack.example.com/v2/openstack/flavors/1",
                "rel": "self"
            },
            {
                "href": "http://openstack.example.com/openstack/flavors/1",
                "rel": "bookmark"
            }
        ],
        "name": "m1.tiny",
        "os-flavor-access:is_public": true,
        "ram": 512,
        "vcpus": 1
    }
}

This operation does not accept a request body.

GET

/v2/{tenant_id}/flavors/{flavor_id}/os-flavor-access

List tenants with access to private flavor

Lists tenants with access to the specified private flavor.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID of the tenant or account in a multi-tenancy cloud.
flavor_id	URI	xsd:int	The ID of the flavor of interest to you.

Response parameters

Parameter	Style	Type	Description
flavor_id	plain	xsd:int	The flavor ID.
tenant_id	plain	csapi:uuid	The tenant ID.

{
    "flavor_access": [
        {
            "flavor_id": "10",
            "tenant_id": "TENANT_ID"
        }
    ]
}

This operation does not accept a request body.

POST

/v2/{tenant_id}/flavors/{flavor_id}/action

Add access to private flavor

Gives a specified tenant access to the specified private flavor.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID of the tenant or account in a multi-tenancy cloud.
flavor_id	URI	xsd:int	The ID of the flavor of interest to you.
addTenantAccess	plain	xsd:string	Specify the `addTenantAccess` action.
tenant	plain	csapi:uuid	The UUID of the tenant to which to give access.

Response parameters

Parameter	Style	Type	Description
flavor_id	plain	xsd:int	The flavor ID.
tenant_id	plain	csapi:uuid	The tenant ID.

{
    "addTenantAccess": {
        "tenant": "TENANT_ID"
    }
}

{
    "flavor_access": [
        {
            "flavor_id": "10",
            "tenant_id": "TENANT_ID"
        }
    ]
}

DELETE

/v2/{tenant_id}/flavors/{flavor_id}/action

Delete access from private flavor

Revokes access from the specified tenant for the specified private flavor.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID of the tenant or account in a multi-tenancy cloud.
flavor_id	URI	xsd:int	The ID of the flavor of interest to you.
removeTenantAccess	plain	xsd:string	Specify the `removeTenantAccess` action.
tenant	plain	csapi:uuid	The UUID of the tenant to which to give access.

Response parameters

Parameter	Style	Type	Description
flavor_id	plain	xsd:int	The flavor ID.
tenant_id	plain	csapi:uuid	The tenant ID.

{
    "removeTenantAccess": {
        "tenant": "TENANT_ID"
    }
}

{
    "flavor_access": []
}

Flavors swap (flavors, os-flavor-swap)

Creates and lists flavors with a swap value. Requires the os-flavormanage extension. The swap value is the amount of swap disk space, in GBs, to allocate to a server.

GET

/v2/{tenant_id}/flavors/{flavor_id}/os-flavor-swap

List flavor extra specs

Lists the flavor specs including swap value for the specified flavor. The swap value is the amount of swap disk space, in GBs, to allocate to a server.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
flavor_id	URI	String	The ID of the flavor of interest to you.

{
    "flavors": [
        {
            "disk": 1,
            "id": "1",
            "links": [
                {
                    "href": "http://openstack.example.com/v2/openstack/flavors/1",
                    "rel": "self"
                },
                {
                    "href": "http://openstack.example.com/openstack/flavors/1",
                    "rel": "bookmark"
                }
            ],
            "name": "m1.tiny",
            "ram": 512,
            "swap": "",
            "vcpus": 1
        },
        {
            "disk": 20,
            "id": "2",
            "links": [
                {
                    "href": "http://openstack.example.com/v2/openstack/flavors/2",
                    "rel": "self"
                },
                {
                    "href": "http://openstack.example.com/openstack/flavors/2",
                    "rel": "bookmark"
                }
            ],
            "name": "m1.small",
            "ram": 2048,
            "swap": "",
            "vcpus": 1
        },
        {
            "disk": 40,
            "id": "3",
            "links": [
                {
                    "href": "http://openstack.example.com/v2/openstack/flavors/3",
                    "rel": "self"
                },
                {
                    "href": "http://openstack.example.com/openstack/flavors/3",
                    "rel": "bookmark"
                }
            ],
            "name": "m1.medium",
            "ram": 4096,
            "swap": "",
            "vcpus": 2
        },
        {
            "disk": 80,
            "id": "4",
            "links": [
                {
                    "href": "http://openstack.example.com/v2/openstack/flavors/4",
                    "rel": "self"
                },
                {
                    "href": "http://openstack.example.com/openstack/flavors/4",
                    "rel": "bookmark"
                }
            ],
            "name": "m1.large",
            "ram": 8192,
            "swap": "",
            "vcpus": 4
        },
        {
            "disk": 160,
            "id": "5",
            "links": [
                {
                    "href": "http://openstack.example.com/v2/openstack/flavors/5",
                    "rel": "self"
                },
                {
                    "href": "http://openstack.example.com/openstack/flavors/5",
                    "rel": "bookmark"
                }
            ],
            "name": "m1.xlarge",
            "ram": 16384,
            "swap": "",
            "vcpus": 8
        }
    ]
}

<?xml version='1.0' encoding='UTF-8'?>
<flavors xmlns:atom="http://www.w3.org/2005/Atom" xmlns="http://docs.openstack.org/compute/api/v1.1">
  <flavor disk="1" vcpus="1" ram="512" name="m1.tiny" id="1" swap="">
    <atom:link href="http://openstack.example.com/v2/openstack/flavors/1" rel="self"/>
    <atom:link href="http://openstack.example.com/openstack/flavors/1" rel="bookmark"/>
  </flavor>
  <flavor disk="20" vcpus="1" ram="2048" name="m1.small" id="2" swap="">
    <atom:link href="http://openstack.example.com/v2/openstack/flavors/2" rel="self"/>
    <atom:link href="http://openstack.example.com/openstack/flavors/2" rel="bookmark"/>
  </flavor>
  <flavor disk="40" vcpus="2" ram="4096" name="m1.medium" id="3" swap="">
    <atom:link href="http://openstack.example.com/v2/openstack/flavors/3" rel="self"/>
    <atom:link href="http://openstack.example.com/openstack/flavors/3" rel="bookmark"/>
  </flavor>
  <flavor disk="80" vcpus="4" ram="8192" name="m1.large" id="4" swap="">
    <atom:link href="http://openstack.example.com/v2/openstack/flavors/4" rel="self"/>
    <atom:link href="http://openstack.example.com/openstack/flavors/4" rel="bookmark"/>
  </flavor>
  <flavor disk="160" vcpus="8" ram="16384" name="m1.xlarge" id="5" swap="">
    <atom:link href="http://openstack.example.com/v2/openstack/flavors/5" rel="self"/>
    <atom:link href="http://openstack.example.com/openstack/flavors/5" rel="bookmark"/>
  </flavor>
</flavors>

This operation does not accept a request body.

POST

/v2/{tenant_id}/flavors/{flavor_id}/os-flavor-swap

Create flavor extra specs

Creates flavor including swap value for the specified flavor. The swap value is the amount of swap disk space, in GBs, to allocate to a server.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
flavor_id	URI	String	The ID of the flavor of interest to you.

{
    "flavor": {
        "name": "flavortest",
        "ram": 1024,
        "vcpus": 2,
        "disk": 10,
        "id": "100",
        "swap": 5
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<flavor xmlns="http://docs.openstack.org/compute/api/v1.1"
    xmlns:OS-FLV-EXT-DATA="http://docs.openstack.org/compute/ext/flavor_extra_data/api/v1.1"
    name="flavortest"
    ram="1024"
    vcpus="2"
    disk="10"
    id="100"
    swap="5" />

{
    "flavor": {
        "disk": 10,
        "id": "100",
        "links": [
            {
                "href": "http://openstack.example.com/v2/openstack/flavors/100",
                "rel": "self"
            },
            {
                "href": "http://openstack.example.com/openstack/flavors/100",
                "rel": "bookmark"
            }
        ],
        "name": "flavortest",
        "ram": 1024,
        "swap": 5,
        "vcpus": 2
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<flavor xmlns:atom="http://www.w3.org/2005/Atom" xmlns="http://docs.openstack.org/compute/api/v1.1" disk="10" vcpus="2" ram="1024" name="flavortest" id="100" swap="5">
  <atom:link href="http://openstack.example.com/v2/openstack/flavors/100" rel="self"/>
  <atom:link href="http://openstack.example.com/openstack/flavors/100" rel="bookmark"/>
</flavor>

Images with size attribute (images)

Lists details for available images and gets details for a specified image. Includes the OS-EXT-IMG-SIZE:size extended attribute, which shows the image size.

GET

/v2/{tenant_id}/images/detail

List details for images

Lists details for available images. Includes the image size.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.

{
    "images": [
        {
            "OS-EXT-IMG-SIZE:size": "74185822",
            "created": "2011-01-01T01:02:03Z",
            "id": "70a599e0-31e7-49b7-b260-868f441e862b",
            "links": [
                {
                    "href": "http://openstack.example.com/v2/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b",
                    "rel": "self"
                },
                {
                    "href": "http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b",
                    "rel": "bookmark"
                },
                {
                    "href": "http://glance.openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b",
                    "rel": "alternate",
                    "type": "application/vnd.openstack.image"
                }
            ],
            "metadata": {
                "architecture": "x86_64",
                "auto_disk_config": "True",
                "kernel_id": "nokernel",
                "ramdisk_id": "nokernel"
            },
            "minDisk": 0,
            "minRam": 0,
            "name": "fakeimage7",
            "progress": 100,
            "status": "ACTIVE",
            "updated": "2011-01-01T01:02:03Z"
        },
        {
            "OS-EXT-IMG-SIZE:size": "25165824",
            "created": "2011-01-01T01:02:03Z",
            "id": "155d900f-4e14-4e4c-a73d-069cbf4541e6",
            "links": [
                {
                    "href": "http://openstack.example.com/v2/openstack/images/155d900f-4e14-4e4c-a73d-069cbf4541e6",
                    "rel": "self"
                },
                {
                    "href": "http://openstack.example.com/openstack/images/155d900f-4e14-4e4c-a73d-069cbf4541e6",
                    "rel": "bookmark"
                },
                {
                    "href": "http://glance.openstack.example.com/openstack/images/155d900f-4e14-4e4c-a73d-069cbf4541e6",
                    "rel": "alternate",
                    "type": "application/vnd.openstack.image"
                }
            ],
            "metadata": {
                "architecture": "x86_64",
                "kernel_id": "nokernel",
                "ramdisk_id": "nokernel"
            },
            "minDisk": 0,
            "minRam": 0,
            "name": "fakeimage123456",
            "progress": 100,
            "status": "ACTIVE",
            "updated": "2011-01-01T01:02:03Z"
        },
        {
            "OS-EXT-IMG-SIZE:size": "58145823",
            "created": "2011-01-01T01:02:03Z",
            "id": "a2459075-d96c-40d5-893e-577ff92e721c",
            "links": [
                {
                    "href": "http://openstack.example.com/v2/openstack/images/a2459075-d96c-40d5-893e-577ff92e721c",
                    "rel": "self"
                },
                {
                    "href": "http://openstack.example.com/openstack/images/a2459075-d96c-40d5-893e-577ff92e721c",
                    "rel": "bookmark"
                },
                {
                    "href": "http://glance.openstack.example.com/openstack/images/a2459075-d96c-40d5-893e-577ff92e721c",
                    "rel": "alternate",
                    "type": "application/vnd.openstack.image"
                }
            ],
            "metadata": {
                "kernel_id": "nokernel",
                "ramdisk_id": "nokernel"
            },
            "minDisk": 0,
            "minRam": 0,
            "name": "fakeimage123456",
            "progress": 100,
            "status": "ACTIVE",
            "updated": "2011-01-01T01:02:03Z"
        },
        {
            "OS-EXT-IMG-SIZE:size": "49163826",
            "created": "2011-01-01T01:02:03Z",
            "id": "a440c04b-79fa-479c-bed1-0b816eaec379",
            "links": [
                {
                    "href": "http://openstack.example.com/v2/openstack/images/a440c04b-79fa-479c-bed1-0b816eaec379",
                    "rel": "self"
                },
                {
                    "href": "http://openstack.example.com/openstack/images/a440c04b-79fa-479c-bed1-0b816eaec379",
                    "rel": "bookmark"
                },
                {
                    "href": "http://glance.openstack.example.com/openstack/images/a440c04b-79fa-479c-bed1-0b816eaec379",
                    "rel": "alternate",
                    "type": "application/vnd.openstack.image"
                }
            ],
            "metadata": {
                "architecture": "x86_64",
                "auto_disk_config": "False",
                "kernel_id": "nokernel",
                "ramdisk_id": "nokernel"
            },
            "minDisk": 0,
            "minRam": 0,
            "name": "fakeimage6",
            "progress": 100,
            "status": "ACTIVE",
            "updated": "2011-01-01T01:02:03Z"
        },
        {
            "OS-EXT-IMG-SIZE:size": "26360814",
            "created": "2011-01-01T01:02:03Z",
            "id": "c905cedb-7281-47e4-8a62-f26bc5fc4c77",
            "links": [
                {
                    "href": "http://openstack.example.com/v2/openstack/images/c905cedb-7281-47e4-8a62-f26bc5fc4c77",
                    "rel": "self"
                },
                {
                    "href": "http://openstack.example.com/openstack/images/c905cedb-7281-47e4-8a62-f26bc5fc4c77",
                    "rel": "bookmark"
                },
                {
                    "href": "http://glance.openstack.example.com/openstack/images/c905cedb-7281-47e4-8a62-f26bc5fc4c77",
                    "rel": "alternate",
                    "type": "application/vnd.openstack.image"
                }
            ],
            "metadata": {
                "kernel_id": "155d900f-4e14-4e4c-a73d-069cbf4541e6",
                "ramdisk_id": null
            },
            "minDisk": 0,
            "minRam": 0,
            "name": "fakeimage123456",
            "progress": 100,
            "status": "ACTIVE",
            "updated": "2011-01-01T01:02:03Z"
        },
        {
            "OS-EXT-IMG-SIZE:size": "84035174",
            "created": "2011-01-01T01:02:03Z",
            "id": "cedef40a-ed67-4d10-800e-17455edce175",
            "links": [
                {
                    "href": "http://openstack.example.com/v2/openstack/images/cedef40a-ed67-4d10-800e-17455edce175",
                    "rel": "self"
                },
                {
                    "href": "http://openstack.example.com/openstack/images/cedef40a-ed67-4d10-800e-17455edce175",
                    "rel": "bookmark"
                },
                {
                    "href": "http://glance.openstack.example.com/openstack/images/cedef40a-ed67-4d10-800e-17455edce175",
                    "rel": "alternate",
                    "type": "application/vnd.openstack.image"
                }
            ],
            "metadata": {
                "kernel_id": "nokernel",
                "ramdisk_id": "nokernel"
            },
            "minDisk": 0,
            "minRam": 0,
            "name": "fakeimage123456",
            "progress": 100,
            "status": "ACTIVE",
            "updated": "2011-01-01T01:02:03Z"
        },
        {
            "OS-EXT-IMG-SIZE:size": "83594576",
            "created": "2011-01-01T01:02:03Z",
            "id": "76fa36fc-c930-4bf3-8c8a-ea2a2420deb6",
            "links": [
                {
                    "href": "http://openstack.example.com/v2/openstack/images/76fa36fc-c930-4bf3-8c8a-ea2a2420deb6",
                    "rel": "self"
                },
                {
                    "href": "http://openstack.example.com/openstack/images/76fa36fc-c930-4bf3-8c8a-ea2a2420deb6",
                    "rel": "bookmark"
                },
                {
                    "href": "http://glance.openstack.example.com/openstack/images/76fa36fc-c930-4bf3-8c8a-ea2a2420deb6",
                    "rel": "alternate",
                    "type": "application/vnd.openstack.image"
                }
            ],
            "metadata": {
                "kernel_id": "nokernel",
                "ramdisk_id": "nokernel"
            },
            "minDisk": 0,
            "minRam": 0,
            "name": "fakeimage123456",
            "progress": 100,
            "status": "ACTIVE",
            "updated": "2011-01-01T01:02:03Z"
        }
    ]
}

<?xml version='1.0' encoding='UTF-8'?>
<images xmlns:OS-EXT-IMG-SIZE="http://docs.openstack.org/compute/ext/image_size/api/v1.1" xmlns:atom="http://www.w3.org/2005/Atom" xmlns="http://docs.openstack.org/compute/api/v1.1">
  <image status="ACTIVE" updated="2011-01-01T01:02:03Z" name="fakeimage7" created="2011-01-01T01:02:03Z" minDisk="0" progress="100" minRam="0" id="70a599e0-31e7-49b7-b260-868f441e862b" OS-EXT-IMG-SIZE:size="74185822">
    <metadata>
      <meta key="kernel_id">nokernel</meta>
      <meta key="auto_disk_config">True</meta>
      <meta key="ramdisk_id">nokernel</meta>
      <meta key="architecture">x86_64</meta>
    </metadata>
    <atom:link href="http://openstack.example.com/v2/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b" rel="self"/>
    <atom:link href="http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b" rel="bookmark"/>
    <atom:link href="http://glance.openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b" type="application/vnd.openstack.image" rel="alternate"/>
  </image>
  <image status="ACTIVE" updated="2011-01-01T01:02:03Z" name="fakeimage123456" created="2011-01-01T01:02:03Z" minDisk="0" progress="100" minRam="0" id="155d900f-4e14-4e4c-a73d-069cbf4541e6" OS-EXT-IMG-SIZE:size="25165824">
    <metadata>
      <meta key="kernel_id">nokernel</meta>
      <meta key="ramdisk_id">nokernel</meta>
      <meta key="architecture">x86_64</meta>
    </metadata>
    <atom:link href="http://openstack.example.com/v2/openstack/images/155d900f-4e14-4e4c-a73d-069cbf4541e6" rel="self"/>
    <atom:link href="http://openstack.example.com/openstack/images/155d900f-4e14-4e4c-a73d-069cbf4541e6" rel="bookmark"/>
    <atom:link href="http://glance.openstack.example.com/openstack/images/155d900f-4e14-4e4c-a73d-069cbf4541e6" type="application/vnd.openstack.image" rel="alternate"/>
  </image>
  <image status="ACTIVE" updated="2011-01-01T01:02:03Z" name="fakeimage123456" created="2011-01-01T01:02:03Z" minDisk="0" progress="100" minRam="0" id="a2459075-d96c-40d5-893e-577ff92e721c" OS-EXT-IMG-SIZE:size="58145823">
    <metadata>
      <meta key="kernel_id">nokernel</meta>
      <meta key="ramdisk_id">nokernel</meta>
    </metadata>
    <atom:link href="http://openstack.example.com/v2/openstack/images/a2459075-d96c-40d5-893e-577ff92e721c" rel="self"/>
    <atom:link href="http://openstack.example.com/openstack/images/a2459075-d96c-40d5-893e-577ff92e721c" rel="bookmark"/>
    <atom:link href="http://glance.openstack.example.com/openstack/images/a2459075-d96c-40d5-893e-577ff92e721c" type="application/vnd.openstack.image" rel="alternate"/>
  </image>
  <image status="ACTIVE" updated="2011-01-01T01:02:03Z" name="fakeimage6" created="2011-01-01T01:02:03Z" minDisk="0" progress="100" minRam="0" id="a440c04b-79fa-479c-bed1-0b816eaec379" OS-EXT-IMG-SIZE:size="49163826">
    <metadata>
      <meta key="kernel_id">nokernel</meta>
      <meta key="auto_disk_config">False</meta>
      <meta key="ramdisk_id">nokernel</meta>
      <meta key="architecture">x86_64</meta>
    </metadata>
    <atom:link href="http://openstack.example.com/v2/openstack/images/a440c04b-79fa-479c-bed1-0b816eaec379" rel="self"/>
    <atom:link href="http://openstack.example.com/openstack/images/a440c04b-79fa-479c-bed1-0b816eaec379" rel="bookmark"/>
    <atom:link href="http://glance.openstack.example.com/openstack/images/a440c04b-79fa-479c-bed1-0b816eaec379" type="application/vnd.openstack.image" rel="alternate"/>
  </image>
  <image status="ACTIVE" updated="2011-01-01T01:02:03Z" name="fakeimage123456" created="2011-01-01T01:02:03Z" minDisk="0" progress="100" minRam="0" id="c905cedb-7281-47e4-8a62-f26bc5fc4c77" OS-EXT-IMG-SIZE:size="26360814">
    <metadata>
      <meta key="kernel_id">155d900f-4e14-4e4c-a73d-069cbf4541e6</meta>
      <meta key="ramdisk_id">None</meta>
    </metadata>
    <atom:link href="http://openstack.example.com/v2/openstack/images/c905cedb-7281-47e4-8a62-f26bc5fc4c77" rel="self"/>
    <atom:link href="http://openstack.example.com/openstack/images/c905cedb-7281-47e4-8a62-f26bc5fc4c77" rel="bookmark"/>
    <atom:link href="http://glance.openstack.example.com/openstack/images/c905cedb-7281-47e4-8a62-f26bc5fc4c77" type="application/vnd.openstack.image" rel="alternate"/>
  </image>
  <image status="ACTIVE" updated="2011-01-01T01:02:03Z" name="fakeimage123456" created="2011-01-01T01:02:03Z" minDisk="0" progress="100" minRam="0" id="cedef40a-ed67-4d10-800e-17455edce175" OS-EXT-IMG-SIZE:size="84035174">
    <metadata>
      <meta key="kernel_id">nokernel</meta>
      <meta key="ramdisk_id">nokernel</meta>
    </metadata>
    <atom:link href="http://openstack.example.com/v2/openstack/images/cedef40a-ed67-4d10-800e-17455edce175" rel="self"/>
    <atom:link href="http://openstack.example.com/openstack/images/cedef40a-ed67-4d10-800e-17455edce175" rel="bookmark"/>
    <atom:link href="http://glance.openstack.example.com/openstack/images/cedef40a-ed67-4d10-800e-17455edce175" type="application/vnd.openstack.image" rel="alternate"/>
  </image>
  <image status="ACTIVE" updated="2011-01-01T01:02:03Z" name="fakeimage123456" created="2011-01-01T01:02:03Z" minDisk="0" progress="100" minRam="0" id="76fa36fc-c930-4bf3-8c8a-ea2a2420deb6" OS-EXT-IMG-SIZE:size="83594576">
    <metadata>
      <meta key="kernel_id">nokernel</meta>
      <meta key="ramdisk_id">nokernel</meta>
    </metadata>
    <atom:link href="http://openstack.example.com/v2/openstack/images/76fa36fc-c930-4bf3-8c8a-ea2a2420deb6" rel="self"/>
    <atom:link href="http://openstack.example.com/openstack/images/76fa36fc-c930-4bf3-8c8a-ea2a2420deb6" rel="bookmark"/>
    <atom:link href="http://glance.openstack.example.com/openstack/images/76fa36fc-c930-4bf3-8c8a-ea2a2420deb6" type="application/vnd.openstack.image" rel="alternate"/>
  </image>
</images>

This operation does not accept a request body.

GET

/v2/{tenant_id}/images/{image_id}

Get image details

Gets details for a specified image. Includes the image size.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
image_id	URI	xsd:string	Image ID stored through the image API. Typically a UUID.

{
    "image": {
        "OS-EXT-IMG-SIZE:size": "74185822",
        "created": "2011-01-01T01:02:03Z",
        "id": "70a599e0-31e7-49b7-b260-868f441e862b",
        "links": [
            {
                "href": "http://openstack.example.com/v2/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b",
                "rel": "self"
            },
            {
                "href": "http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b",
                "rel": "bookmark"
            },
            {
                "href": "http://glance.openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b",
                "rel": "alternate",
                "type": "application/vnd.openstack.image"
            }
        ],
        "metadata": {
            "architecture": "x86_64",
            "auto_disk_config": "True",
            "kernel_id": "nokernel",
            "ramdisk_id": "nokernel"
        },
        "minDisk": 0,
        "minRam": 0,
        "name": "fakeimage7",
        "progress": 100,
        "status": "ACTIVE",
        "updated": "2011-01-01T01:02:03Z"
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<image xmlns:OS-EXT-IMG-SIZE="http://docs.openstack.org/compute/ext/image_size/api/v1.1" xmlns:atom="http://www.w3.org/2005/Atom" xmlns="http://docs.openstack.org/compute/api/v1.1" status="ACTIVE" updated="2011-01-01T01:02:03Z" name="fakeimage7" created="2011-01-01T01:02:03Z" minDisk="0" progress="100" minRam="0" id="70a599e0-31e7-49b7-b260-868f441e862b" OS-EXT-IMG-SIZE:size="74185822">
  <metadata>
    <meta key="kernel_id">nokernel</meta>
    <meta key="auto_disk_config">True</meta>
    <meta key="ramdisk_id">nokernel</meta>
    <meta key="architecture">x86_64</meta>
  </metadata>
  <atom:link href="http://openstack.example.com/v2/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b" rel="self"/>
  <atom:link href="http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b" rel="bookmark"/>
  <atom:link href="http://glance.openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b" type="application/vnd.openstack.image" rel="alternate"/>
</image>

This operation does not accept a request body.

Limits with project usage (limits)

Extends limits to show the project usage. Shows information such as RAM and instance quotas usage.

GET

/v2/{tenant_id}/limits

Get limits

Gets absolute and rate limit information, including information on currently used absolute limits.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.

Response parameters

Parameter	Style	Type	Description
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.
totalCoresUsed	plain	xsd:int	Total cores used.
totalInstancesUsed	plain	xsd:int	Total instances used.
totalRAMUsed	plain	xsd:int	Total RAM, in MB, used for all servers at any one time.
totalSecurityGroupsUsed	plain	xsd:int	Total security groups used.
totalCoresUsed	plain	xsd:int	Total cores used.
totalFloatingIpsUsed	plain	xsd:int	Total floating IP addresses used.
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,
            "totalCoresUsed": 0,
            "totalInstancesUsed": 0,
            "totalRAMUsed": 0,
            "totalSecurityGroupsUsed": 0,
            "totalFloatingIpsUsed": 0
        },
        "rate": [
            {
                "limit": [
                    {
                        "next-available": "2012-11-27T17:24:52Z",
                        "remaining": 120,
                        "unit": "MINUTE",
                        "value": 120,
                        "verb": "POST"
                    },
                    {
                        "next-available": "2012-11-27T17:24:52Z",
                        "remaining": 120,
                        "unit": "MINUTE",
                        "value": 120,
                        "verb": "PUT"
                    },
                    {
                        "next-available": "2012-11-27T17:24:52Z",
                        "remaining": 120,
                        "unit": "MINUTE",
                        "value": 120,
                        "verb": "DELETE"
                    }
                ],
                "regex": ".*",
                "uri": "*"
            },
            {
                "limit": [
                    {
                        "next-available": "2012-11-27T17:24:52Z",
                        "remaining": 120,
                        "unit": "MINUTE",
                        "value": 120,
                        "verb": "POST"
                    }
                ],
                "regex": "^/servers",
                "uri": "*/servers"
            },
            {
                "limit": [
                    {
                        "next-available": "2012-11-27T17:24:52Z",
                        "remaining": 120,
                        "unit": "MINUTE",
                        "value": 120,
                        "verb": "GET"
                    }
                ],
                "regex": ".*changes-since.*",
                "uri": "*changes-since*"
            },
            {
                "limit": [
                    {
                        "next-available": "2012-11-27T17:24:52Z",
                        "remaining": 12,
                        "unit": "MINUTE",
                        "value": 12,
                        "verb": "GET"
                    }
                ],
                "regex": "^/os-fping",
                "uri": "*/os-fping"
            }
        ]
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<limits xmlns:os-used-limits="http://docs.openstack.org/compute/ext/used_limits/api/v1.1" xmlns:atom="http://www.w3.org/2005/Atom" xmlns="http://docs.openstack.org/common/api/v1.0">
  <rates>
    <rate regex=".*" uri="*">
      <limit next-available="2012-11-27T17:24:53Z" unit="MINUTE" verb="POST" remaining="120" value="120"/>
      <limit next-available="2012-11-27T17:24:53Z" unit="MINUTE" verb="PUT" remaining="120" value="120"/>
      <limit next-available="2012-11-27T17:24:53Z" unit="MINUTE" verb="DELETE" remaining="120" value="120"/>
    </rate>
    <rate regex="^/servers" uri="*/servers">
      <limit next-available="2012-11-27T17:24:53Z" unit="MINUTE" verb="POST" remaining="120" value="120"/>
    </rate>
    <rate regex=".*changes-since.*" uri="*changes-since*">
      <limit next-available="2012-11-27T17:24:53Z" unit="MINUTE" verb="GET" remaining="120" value="120"/>
    </rate>
    <rate regex="^/os-fping" uri="*/os-fping">
      <limit next-available="2012-11-27T17:24:53Z" 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="totalRAMUsed" value="0"/>
    <limit name="totalInstancesUsed" value="0"/>
    <limit name="maxSecurityGroups" value="10"/>
    <limit name="totalFloatingIpsUsed" value="0"/>
    <limit name="maxTotalCores" value="20"/>
    <limit name="totalSecurityGroupsUsed" value="0"/>
    <limit name="maxTotalFloatingIps" value="10"/>
    <limit name="maxTotalInstances" value="10"/>
    <limit name="totalCoresUsed" value="0"/>
    <limit name="maxTotalRAMSize" value="51200"/>
  </absolute>
</limits>

This operation does not accept a request body.

Limits with project usage for administrators (limits)

Extends limits to enable administrators to show the project usage for a specified customer project ID. Shows information such as RAM and instance quotas usage.

GET

/v2/{tenant_id}/limits{tenant_id}

Get customer limits

Enables administrators to get absolute and rate limit information, including information about currently used absolute limits, for a specified customer tenant ID.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
tenant_id	URI	String	The ID for the tenant for which an administrator wants to get quota information. Specify the customer tenant ID in the URI as `?tenant_id={tenant_id}`.

Response parameters

Parameter	Style	Type	Description
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.
totalCoresUsed	plain	xsd:int	Total cores used.
totalInstancesUsed	plain	xsd:int	Total instances used.
totalRAMUsed	plain	xsd:int	Total RAM, in MB, used for all servers at any one time.
totalSecurityGroupsUsed	plain	xsd:int	Total security groups used.
totalCoresUsed	plain	xsd:int	Total cores used.
totalFloatingIpsUsed	plain	xsd:int	Total floating IP addresses used.
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,
            "totalCoresUsed": 0,
            "totalInstancesUsed": 0,
            "totalRAMUsed": 0,
            "totalSecurityGroupsUsed": 0,
            "totalFloatingIpsUsed": 0
        },
        "rate": [
            {
                "limit": [
                    {
                        "next-available": "2012-11-27T17:24:52Z",
                        "remaining": 120,
                        "unit": "MINUTE",
                        "value": 120,
                        "verb": "POST"
                    },
                    {
                        "next-available": "2012-11-27T17:24:52Z",
                        "remaining": 120,
                        "unit": "MINUTE",
                        "value": 120,
                        "verb": "PUT"
                    },
                    {
                        "next-available": "2012-11-27T17:24:52Z",
                        "remaining": 120,
                        "unit": "MINUTE",
                        "value": 120,
                        "verb": "DELETE"
                    }
                ],
                "regex": ".*",
                "uri": "*"
            },
            {
                "limit": [
                    {
                        "next-available": "2012-11-27T17:24:52Z",
                        "remaining": 120,
                        "unit": "MINUTE",
                        "value": 120,
                        "verb": "POST"
                    }
                ],
                "regex": "^/servers",
                "uri": "*/servers"
            },
            {
                "limit": [
                    {
                        "next-available": "2012-11-27T17:24:52Z",
                        "remaining": 120,
                        "unit": "MINUTE",
                        "value": 120,
                        "verb": "GET"
                    }
                ],
                "regex": ".*changes-since.*",
                "uri": "*changes-since*"
            },
            {
                "limit": [
                    {
                        "next-available": "2012-11-27T17:24:52Z",
                        "remaining": 12,
                        "unit": "MINUTE",
                        "value": 12,
                        "verb": "GET"
                    }
                ],
                "regex": "^/os-fping",
                "uri": "*/os-fping"
            }
        ]
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<limits xmlns:os-used-limits="http://docs.openstack.org/compute/ext/used_limits/api/v1.1" xmlns:atom="http://www.w3.org/2005/Atom" xmlns="http://docs.openstack.org/common/api/v1.0">
  <rates>
    <rate regex=".*" uri="*">
      <limit next-available="2012-11-27T17:24:53Z" unit="MINUTE" verb="POST" remaining="120" value="120"/>
      <limit next-available="2012-11-27T17:24:53Z" unit="MINUTE" verb="PUT" remaining="120" value="120"/>
      <limit next-available="2012-11-27T17:24:53Z" unit="MINUTE" verb="DELETE" remaining="120" value="120"/>
    </rate>
    <rate regex="^/servers" uri="*/servers">
      <limit next-available="2012-11-27T17:24:53Z" unit="MINUTE" verb="POST" remaining="120" value="120"/>
    </rate>
    <rate regex=".*changes-since.*" uri="*changes-since*">
      <limit next-available="2012-11-27T17:24:53Z" unit="MINUTE" verb="GET" remaining="120" value="120"/>
    </rate>
    <rate regex="^/os-fping" uri="*/os-fping">
      <limit next-available="2012-11-27T17:24:53Z" 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="totalRAMUsed" value="0"/>
    <limit name="totalInstancesUsed" value="0"/>
    <limit name="maxSecurityGroups" value="10"/>
    <limit name="totalFloatingIpsUsed" value="0"/>
    <limit name="maxTotalCores" value="20"/>
    <limit name="totalSecurityGroupsUsed" value="0"/>
    <limit name="maxTotalFloatingIps" value="10"/>
    <limit name="maxTotalInstances" value="10"/>
    <limit name="totalCoresUsed" value="0"/>
    <limit name="maxTotalRAMSize" value="51200"/>
  </absolute>
</limits>

This operation does not accept a request body.

Guest agents (os-agents)

Creates, updates, and deletes guest agents.

Use guest agents to access files on the disk, configure networking, and run other applications and scripts in the guest while it runs. This hypervisor-specific extension is not currently enabled for KVM. Use of guest agents is possible only if the underlying service provider uses the Xen driver.

GET

/v2/{tenant_id}/os-agents

List agents

Lists all agent builds.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The unique ID of the tenant or account.

{
    "agents": [
        {
            "agent_id": "1",
            "architecture": "x86",
            "hypervisor": "hypervisor",
            "md5hash": "add6bb58e139be103324d04d82d8f545",
            "os": "os",
            "url": "http://www.example.com",
            "version": "8.0"
        }
    ]
}

<?xml version='1.0' encoding='UTF-8'?>
<agents>
  <agent url="http://www.example.com"
   hypervisor="hypervisor"
   md5hash="add6bb58e139be103324d04d82d8f545"
   version="8.0"
   architecture="x86"
   os="os"
   agent_id="1"/>
</agents>

This operation does not accept a request body.

POST

/v2/{tenant_id}/os-agents

Create agent

Creates an agent build.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The unique ID of the tenant or account.

{
    "agent": {
        "hypervisor": "hypervisor",
        "os": "os",
        "architecture": "x86",
        "version": "8.0",
        "md5hash": "add6bb58e139be103324d04d82d8f545",
        "url": "http://www.example.com"
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<agent>
  <hypervisor>hypervisor</hypervisor>
  <os>os</os>
  <architecture>x86</architecture>
  <version>8.0</version>
  <md5hash>add6bb58e139be103324d04d82d8f545</md5hash>
  <url>http://www.example.com</url>
</agent>

{
    "agent": {
        "agent_id": "1",
        "architecture": "x86",
        "hypervisor": "hypervisor",
        "md5hash": "add6bb58e139be103324d04d82d8f545",
        "os": "os",
        "url": "http://www.example.com",
        "version": "8.0"
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<agent>
  <url>http://www.example.com</url>
  <hypervisor>hypervisor</hypervisor>
  <md5hash>add6bb58e139be103324d04d82d8f545</md5hash>
  <version>8.0</version>
  <architecture>x86</architecture>
  <os>os</os>
  <agent_id>1</agent_id>
</agent>

DELETE

/v2/{tenant_id}/os-agents

Delete agent

Deletes an existing agent build.

Normal response codes

202

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The unique ID of the tenant or account.

This operation does not accept a request body and does not return a response body.

PUT

/v2/{tenant_id}/os-agents/{id}

Update agent

Updates an agent build.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The unique ID of the tenant or account.
id	URI	csapi:UUID	The unique ID associated with the agent.

{
    "para": {
        "url": "http://www.example.com",
        "md5hash": "add6bb58e139be103324d04d82d8f545",
        "version": "7.0"
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<para>
  <version>7.0</version>
  <url>http://www.example.com</url>
  <md5hash>add6bb58e139be103324d04d82d8f545</md5hash>
</para>

{
    "agent": {
        "agent_id": "1",
        "md5hash": "add6bb58e139be103324d04d82d8f545",
        "url": "http://www.example.com",
        "version": "7.0"
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<agent>
  <url>http://www.example.com</url>
  <version>7.0</version>
  <agent_id>1</agent_id>
  <md5hash>add6bb58e139be103324d04d82d8f545</md5hash>
</agent>

Host aggregates (os-aggregates)

Creates and manages host aggregates. An aggregate assigns metadata to groups of compute nodes. Aggregates are only visible to the cloud provider.

GET

/v2/{tenant_id}/os-aggregates

List aggregates

Lists all aggregates.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.

{
    "aggregates": [
        {
            "availability_zone": "nova",
            "created_at": "2012-11-16T06:22:23.361359",
            "deleted": false,
            "deleted_at": null,
            "hosts": [],
            "id": 1,
            "metadata": {
                "availability_zone": "nova"
            },
            "name": "name",
            "updated_at": null
        }
    ]
}

<?xml version='1.0' encoding='UTF-8'?>
<aggregates>
  <aggregate>
    <name>name</name>
    <availability_zone>nova</availability_zone>
    <deleted>False</deleted>
    <created_at>2012-11-16 06:22:25.935099</created_at>
    <updated_at>None</updated_at>
    <hosts/>
    <deleted_at>None</deleted_at>
    <id>1</id>
    <metadata>
      <availability_zone>nova</availability_zone>
    </metadata>
  </aggregate>
</aggregates>

This operation does not accept a request body.

POST

/v2/{tenant_id}/os-aggregates

Create aggregate

Creates an aggregate.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
name	plain	csapi:string	Name of aggregate
availability_zone	plain	csapi:string	Availability zone of aggregate

{
    "aggregate": {
        "name": "name",
        "availability_zone": "nova"
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<aggregate name="name" availability_zone="nova" />

{
    "aggregate": {
        "availability_zone": "nova",
        "created_at": "2012-10-01T18:50:27.781065",
        "deleted": false,
        "deleted_at": null,
        "id": 1,
        "name": "name",
        "updated_at": null
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<aggregate>
  <name>name</name>
  <availability_zone>nova</availability_zone>
  <deleted>False</deleted>
  <created_at>2012-10-01 18:50:35.506667</created_at>
  <updated_at>None</updated_at>
  <deleted_at>None</deleted_at>
  <id>1</id>
</aggregate>

DELETE

/v2/{tenant_id}/os-aggregates/{aggregate_id}

Delete aggregate

Deletes an aggregate.

Normal response codes

204

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
aggregate_id	URI	csapi:UUID	The ID associated with an aggregate.

This operation does not return a response body.

GET

/v2/{tenant_id}/os-aggregates/{aggregate_id}

Get aggregate details

Gets details about a specified aggregate.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
aggregate_id	URI	csapi:UUID	The ID associated with an aggregate.

{
    "aggregate": {
        "availability_zone": "nova",
        "created_at": "2012-11-16T06:22:23.032493",
        "deleted": false,
        "deleted_at": null,
        "hosts": [],
        "id": 1,
        "metadata": {
            "availability_zone": "nova"
        },
        "name": "name",
        "updated_at": null
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<aggregate>
  <name>name</name>
  <availability_zone>nova</availability_zone>
  <deleted>False</deleted>
  <created_at>2012-11-16 06:22:25.587739</created_at>
  <updated_at>None</updated_at>
  <hosts/>
  <deleted_at>None</deleted_at>
  <id>1</id>
  <metadata>
    <availability_zone>nova</availability_zone>
  </metadata>
</aggregate>

PUT

/v2/{tenant_id}/os-aggregates/{aggregate_id}

Update aggregate

Updates the name, and optionally the availability zone, for a specified aggregate.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
aggregate_id	URI	csapi:UUID	The ID associated with an aggregate.
name	plain	csapi:string	Name of aggregate.
availability_zone	plain	csapi:string	Availability zone of aggregate.

{
    "aggregate": {
        "name": "newname",
        "availability_zone": "nova2"
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<aggregate name="newname" availability_zone="nova2" />

{
    "aggregate": {
        "name": "newname",
        "availability_zone": "nova2"
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<aggregate>
  <name>newname</name>
  <availability_zone>nova2</availability_zone>
  <deleted>False</deleted>
  <created_at>2012-12-04 12:04:30.245284</created_at>
  <updated_at>2012-12-04 12:04:30.357795</updated_at>
  <hosts/>
  <deleted_at>None</deleted_at>
  <id>1</id>
  <metadata>
    <availability_zone>nova2</availability_zone>
  </metadata>
</aggregate>

POST

/v2/{tenant_id}/os-aggregates/{aggregate_id}/action

Set aggregate metadata

Sets metadata for an aggregate.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
aggregate_id	URI	csapi:UUID	The ID associated with an aggregate.
metadata	plain	csapi:string	Metadata value to be set.

{
    "set_metadata": {
        "metadata": {
            "key": "value"
        }
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<set_metadata>
    <metadata>
        <key>value</key>
    </metadata>
</set_metadata>

{
    "aggregate": {
        "availability_zone": "nova",
        "created_at": "2012-11-16T06:22:22.342791",
        "deleted": false,
        "deleted_at": null,
        "hosts": [],
        "id": 1,
        "metadata": {
            "availability_zone": "nova",
            "key": "value"
        },
        "name": "name",
        "updated_at": null
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<aggregate>
  <name>name</name>
  <availability_zone>nova</availability_zone>
  <deleted>False</deleted>
  <created_at>2012-11-16 06:22:24.864471</created_at>
  <updated_at>None</updated_at>
  <hosts/>
  <deleted_at>None</deleted_at>
  <id>1</id>
  <metadata>
    <key>value</key>
    <availability_zone>nova</availability_zone>
  </metadata>
</aggregate>

POST

/v2/{tenant_id}/os-aggregates/{aggregate_id}/action

Add host to aggregate

Adds a host to an aggregate.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
aggregate_id	URI	csapi:UUID	The ID associated with an aggregate.
host	plain	csapi:UUID	Host ID to add to an aggregate, which is a collection of multiple groups of hosts that share common resources like storage and network.

{
    "add_host": {
        "host": "581d29b9e3504d8a895caddb13839b15"
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<add_host host="7c9e00dbca5e4fb88538b021c0f933a5" />

{
    "aggregate": {
        "availability_zone": "nova",
        "created_at": "2012-12-04T12:04:24.399784",
        "deleted": false,
        "deleted_at": null,
        "hosts": [
            "0438c6a4e8d841ad823b801d681f4680"
        ],
        "id": 1,
        "metadata": {
            "availability_zone": "nova"
        },
        "name": "name",
        "updated_at": null
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<aggregate>
  <name>name</name>
  <availability_zone>nova</availability_zone>
  <deleted>False</deleted>
  <created_at>2012-12-04 12:04:27.574038</created_at>
  <updated_at>None</updated_at>
  <hosts>
    <host>392adba19dd449179804eaff16ff4a97</host>
  </hosts>
  <deleted_at>None</deleted_at>
  <id>1</id>
  <metadata>
    <availability_zone>nova</availability_zone>
  </metadata>
</aggregate>

POST

/v2/{tenant_id}/os-aggregates/{aggregate_id}/action

Remove host from aggregate

Removes a host from an aggregate.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
aggregate_id	URI	csapi:UUID	The ID associated with an aggregate.
host	plain	csapi:UUID	Host ID to add to an aggregate.

{
    "remove_host": {
        "host": "581d29b9e3504d8a895caddb13839b15"
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<remove_host host="7c9e00dbca5e4fb88538b021c0f933a5" />

{
    "aggregate": {
        "availability_zone": "nova",
        "created_at": "2012-11-16T06:22:22.342791",
        "deleted": false,
        "deleted_at": null,
        "hosts": [],
        "id": 1,
        "metadata": {
            "availability_zone": "nova",
            "key": "value"
        },
        "name": "name",
        "updated_at": null
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<aggregate>
  <name>name</name>
  <availability_zone>nova</availability_zone>
  <deleted>False</deleted>
  <created_at>2012-12-04 12:04:29.722109</created_at>
  <updated_at>None</updated_at>
  <hosts/>
  <deleted_at>None</deleted_at>
  <id>1</id>
  <metadata>
    <availability_zone>nova</availability_zone>
  </metadata>
</aggregate>

Bare metal nodes (os-baremetal-nodes)

Bare metal nodes.

POST

/v2/{tenant_id}/servers/{server_id}/os-baremetal-nodes

Add bare metal node

Adds a bare metal node to a specified server.

Preconditions

You can add a bare metal node to a server with an ACTIVE, PAUSED, SHUTOFF, VERIFY_RESIZE, or SOFT_DELETED status.
You can add a bare metal node to a server with a status that is not locked.

Normal response codes

202

Error response codes

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
server_id	URI	csapi:UUID	The UUID for the server of interest to you.

{
    "node": {
        "service_host": "host",
        "cpus": 8,
        "memory_mb": 8192,
        "local_gb": 128,
        "pm_address": "10.1.2.3",
        "pm_user": "pm_user",
        "pm_password": "pm_pass",
        "terminal_port": 8000
    }
}

{
    "node": {
        "service_host": "host",
        "cpus": 8,
        "memory_mb": 8192,
        "local_gb": 128,
        "pm_address": "10.1.2.3",
        "pm_user": "pm_user",
        "pm_password": "pm_pass",
        "prov_mac_address": "12:34:56:78:90:ab",
        "terminal_port": 8000
    }
}

{
    "node": {
        "cpus": 8,
        "id": 1,
        "instance_uuid": null,
        "interfaces": [],
        "local_gb": 128,
        "memory_mb": 8192,
        "pm_address": "10.1.2.3",
        "pm_user": "pm_user",
        "pxe_config_path": null,
        "service_host": "host",
        "task_state": null,
        "terminal_port": 8000,
        "updated_at": null,
        "uuid": "73d35253-b6fb-4c83-b8eb-0229336e79b6"
    }
}

{
    "node": {
        "cpus": 8,
        "id": 1,
        "instance_uuid": null,
        "interfaces": [
            {
                "address": "12:34:56:78:90:ab",
                "datapath_id": null,
                "id": 1,
                "port_no": null
            }
        ],
        "local_gb": 128,
        "memory_mb": 8192,
        "pm_address": "10.1.2.3",
        "pm_user": "pm_user",
        "pxe_config_path": null,
        "service_host": "host",
        "task_state": null,
        "terminal_port": 8000,
        "updated_at": null,
        "uuid": "0a130464-bccc-4e36-b9d3-9a8c98e636ae"
    }
}

GET

/v2/{tenant_id}/servers/{server_id}/os-baremetal-nodes

List bare metal nodes

Lists the bare metal nodes that are associated with a specified server.

Normal response codes

202

Error response codes

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
server_id	URI	csapi:UUID	The UUID for the server of interest to you.

{
    "nodes": [
        {
            "cpus": 8,
            "id": 1,
            "instance_uuid": null,
            "interfaces": [
                {
                    "address": "aa:aa:aa:aa:aa:aa",
                    "datapath_id": null,
                    "id": 1,
                    "port_no": null
                }
            ],
            "local_gb": 128,
            "memory_mb": 8192,
            "pm_address": "10.1.2.3",
            "pm_user": "pm_user",
            "pxe_config_path": null,
            "service_host": "host",
            "task_state": null,
            "terminal_port": 8000,
            "updated_at": null,
            "uuid": "6fae68da-108b-4a9d-87c4-88831ee1241b"
        }
    ]
}

This operation does not accept a request body.

POST

/v2/{tenant_id}/servers/{server_id}/os-baremetal-nodes/action

Add interface to bare metal node

Adds an interface to a bare metal node that is associated with a specified server.

Normal response codes

202

Error response codes

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
server_id	URI	csapi:UUID	The UUID for the server of interest to you.

{
    "add_interface": {
        "address": "aa:aa:aa:aa:aa:aa"
    }
}

{
    "interface": {
        "address": "aa:aa:aa:aa:aa:aa",
        "datapath_id": null,
        "id": 1,
        "port_no": null
    }
}

POST

/v2/{tenant_id}/servers/{server_id}/os-baremetal-nodes/action

Delete interface from bare metal node

Deletes an interface from a bare metal node that is associated with a specified server.

Error response codes

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
server_id	URI	csapi:UUID	The UUID for the server of interest to you.

{
    "remove_interface": {
        "address": "aa:aa:aa:aa:aa:aa"
    }
}

This operation does not return a response body.

GET

/v2/{tenant_id}/servers/{server_id}/os-baremetal-nodes/{node_id}

Show bare metal node details

Shows details for a specified bare metal node.

Preconditions

The specified bare metal node must be associated with the server.

Normal response codes

202

Error response codes

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
server_id	URI	csapi:UUID	The UUID for the server of interest to you.
node_id	URI	xsd:string	Node ID.

{
    "node": {
        "cpus": 8,
        "id": 1,
        "instance_uuid": null,
        "interfaces": [
            {
                "address": "aa:aa:aa:aa:aa:aa",
                "datapath_id": null,
                "id": 1,
                "port_no": null
            }
        ],
        "local_gb": 128,
        "memory_mb": 8192,
        "pm_address": "10.1.2.3",
        "pm_user": "pm_user",
        "pxe_config_path": null,
        "service_host": "host",
        "task_state": null,
        "terminal_port": 8000,
        "updated_at": null,
        "uuid": "c862b836-c7c1-4f7f-8081-6766fa9cf38b"
    }
}

This operation does not accept a request body.

Root certificates (os-certificates)

Creates and shows details for a root certificate.

POST

/v2/{tenant_id}/os-certificates

Create root certificate

Creates a root certificate.

Normal response codes

202

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.

{
    "certificate": {
        "data": "Certificate:\n    Data:\n        Version: 1 (0x0)\n        Serial Number: 23 (0x17)\n        Signature Algorithm: md5WithRSAEncryption\n        Issuer: O=NOVA ROOT, L=Mountain View, ST=California, C=US\n        Validity\n            Not Before: Oct  2 19:31:45 2012 GMT\n            Not After : Oct  2 19:31:45 2013 GMT\n        Subject: C=US, ST=California, O=OpenStack, OU=NovaDev, CN=openstack-fake-2012-10-02T19:31:45Z\n        Subject Public Key Info:\n            Public Key Algorithm: rsaEncryption\n            RSA Public Key: (1024 bit)\n                Modulus (1024 bit):\n                    00:b8:87:67:7a:de:28:ed:f6:5d:1f:20:14:58:df:\n                    b0:f7:62:3d:85:61:a8:c2:31:49:5f:b5:2a:07:34:\n                    0e:25:13:0d:2e:4d:79:c7:26:36:dd:d2:3e:c7:36:\n                    54:80:0d:67:80:32:e6:a8:48:33:69:ec:22:2c:5c:\n                    cb:7a:88:0f:c0:48:de:67:14:54:d9:94:b4:6a:23:\n                    36:28:23:44:47:8a:24:89:8e:f4:86:77:59:f8:62:\n                    b6:ab:d5:e0:bc:b4:ad:d1:95:dd:59:a3:aa:e3:ea:\n                    d3:ae:23:17:c5:54:96:a3:25:56:72:90:20:07:8c:\n                    63:4d:be:e9:60:7e:10:57:17\n                Exponent: 65537 (0x10001)\n    Signature Algorithm: md5WithRSAEncryption\n        32:82:ff:8b:92:0e:8d:9c:6b:ce:7e:fe:34:16:2a:4c:47:4f:\n        c7:28:a2:33:1e:48:56:2e:4b:e8:e8:e3:48:b1:3d:a3:43:21:\n        ef:83:e7:df:e2:10:91:7e:9a:c0:4d:1e:96:68:2b:b9:f7:84:\n        7f:ec:84:8a:bf:bc:5e:50:05:d9:ce:4a:1a:bf:d2:bf:0c:d1:\n        7e:ec:64:c3:a5:37:78:a3:a6:2b:a1:b7:1c:cc:c8:b9:78:61:\n        98:50:3c:e6:28:34:f1:0e:62:bb:b5:d7:a1:dd:1f:38:c6:0d:\n        58:9f:81:67:ff:9c:32:fc:52:7e:6d:8c:91:43:49:fe:e3:48:\n        bb:40\n-----BEGIN CERTIFICATE-----\nMIICMzCCAZwCARcwDQYJKoZIhvcNAQEEBQAwTjESMBAGA1UEChMJTk9WQSBST09U\nMRYwFAYDVQQHEw1Nb3VudGFpbiBWaWV3MRMwEQYDVQQIEwpDYWxpZm9ybmlhMQsw\nCQYDVQQGEwJVUzAeFw0xMjEwMDIxOTMxNDVaFw0xMzEwMDIxOTMxNDVaMHYxCzAJ\nBgNVBAYTAlVTMRMwEQYDVQQIEwpDYWxpZm9ybmlhMRIwEAYDVQQKEwlPcGVuU3Rh\nY2sxEDAOBgNVBAsTB05vdmFEZXYxLDAqBgNVBAMTI29wZW5zdGFjay1mYWtlLTIw\nMTItMTAtMDJUMTk6MzE6NDVaMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC4\nh2d63ijt9l0fIBRY37D3Yj2FYajCMUlftSoHNA4lEw0uTXnHJjbd0j7HNlSADWeA\nMuaoSDNp7CIsXMt6iA/ASN5nFFTZlLRqIzYoI0RHiiSJjvSGd1n4Yrar1eC8tK3R\nld1Zo6rj6tOuIxfFVJajJVZykCAHjGNNvulgfhBXFwIDAQABMA0GCSqGSIb3DQEB\nBAUAA4GBADKC/4uSDo2ca85+/jQWKkxHT8coojMeSFYuS+jo40ixPaNDIe+D59/i\nEJF+msBNHpZoK7n3hH/shIq/vF5QBdnOShq/0r8M0X7sZMOlN3ijpiuhtxzMyLl4\nYZhQPOYoNPEOYru116HdHzjGDVifgWf/nDL8Un5tjJFDSf7jSLtA\n-----END CERTIFICATE-----\n",
        "private_key": "-----BEGIN RSA PRIVATE KEY-----\nMIICXAIBAAKBgQC4h2d63ijt9l0fIBRY37D3Yj2FYajCMUlftSoHNA4lEw0uTXnH\nJjbd0j7HNlSADWeAMuaoSDNp7CIsXMt6iA/ASN5nFFTZlLRqIzYoI0RHiiSJjvSG\nd1n4Yrar1eC8tK3Rld1Zo6rj6tOuIxfFVJajJVZykCAHjGNNvulgfhBXFwIDAQAB\nAoGBAIjfxx4YU/vO1lwUC4OwyS92q3OYcPk6XdakJryZHDTb4NcLmNzjt6bqIK7b\n2enyB2fMWdNRWvGiueZ2HmiRLDyOGsAVdEsHvL4qbr9EZGTqC8Qxx+zTevWWf6pB\nF1zxzbXNQDFZDf9kVsSLCkbMHITnW1k4MrM++9gfCO3WrfehAkEA4nd8TyCCZazq\nKMOQwFLTNaiVLeTXCtvGopl4ZNiKYZ1qI3KDXb2wbAyArFuERlotxFlylXpwtlMo\nSlI/C/sYqwJBANCX1sdfRJq8DpdP44ThWqOkWFLB9rBiwyyBt8746fX8amwr8eyz\nH44/z5GT/Vyp8qFsjkuDzeP93eeDnr2qE0UCP1zipRnPO6x4P5J4o+Y+EmLvwkAQ\nnCLYAaCvUbILHrbq2Z2wWjEYnEO03RHUd2xjkGH4TgcBMTmW4e+ZzEIduwJACnIw\nLVfWBbG5QVac3EC021EVoz9XbUnk4Eu2usS4Yrs7USN6QBJQWD1V1cKFg6h3ICJh\nleKJ4wsJm9h5kKH9yQJBAN8CaX223MlTSuBOVuIOwNA+09iLfx4UCLiH1fGMKDpe\nxVcmkM3qCnTqNxrAPSFdT9IyB3IXiaLWbvzl7MfiOwQ=\n-----END RSA PRIVATE KEY-----\n"
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<certificate private_key="-----BEGIN RSA PRIVATE KEY-----&#10;MIICXAIBAAKBgQC4h2d63ijt9l0fIBRY37D3Yj2FYajCMUlftSoHNA4lEw0uTXnH&#10;Jjbd0j7HNlSADWeAMuaoSDNp7CIsXMt6iA/ASN5nFFTZlLRqIzYoI0RHiiSJjvSG&#10;d1n4Yrar1eC8tK3Rld1Zo6rj6tOuIxfFVJajJVZykCAHjGNNvulgfhBXFwIDAQAB&#10;AoGBAIjfxx4YU/vO1lwUC4OwyS92q3OYcPk6XdakJryZHDTb4NcLmNzjt6bqIK7b&#10;2enyB2fMWdNRWvGiueZ2HmiRLDyOGsAVdEsHvL4qbr9EZGTqC8Qxx+zTevWWf6pB&#10;F1zxzbXNQDFZDf9kVsSLCkbMHITnW1k4MrM++9gfCO3WrfehAkEA4nd8TyCCZazq&#10;KMOQwFLTNaiVLeTXCtvGopl4ZNiKYZ1qI3KDXb2wbAyArFuERlotxFlylXpwtlMo&#10;SlI/C/sYqwJBANCX1sdfRJq8DpdP44ThWqOkWFLB9rBiwyyBt8746fX8amwr8eyz&#10;H44/z5GT/Vyp8qFsjkuDzeP93eeDnr2qE0UCP1zipRnPO6x4P5J4o+Y+EmLvwkAQ&#10;nCLYAaCvUbILHrbq2Z2wWjEYnEO03RHUd2xjkGH4TgcBMTmW4e+ZzEIduwJACnIw&#10;LVfWBbG5QVac3EC021EVoz9XbUnk4Eu2usS4Yrs7USN6QBJQWD1V1cKFg6h3ICJh&#10;leKJ4wsJm9h5kKH9yQJBAN8CaX223MlTSuBOVuIOwNA+09iLfx4UCLiH1fGMKDpe&#10;xVcmkM3qCnTqNxrAPSFdT9IyB3IXiaLWbvzl7MfiOwQ=&#10;-----END RSA PRIVATE KEY-----&#10;" data="Certificate:&#10;    Data:&#10;        Version: 1 (0x0)&#10;        Serial Number: 23 (0x17)&#10;        Signature Algorithm: md5WithRSAEncryption&#10;        Issuer: O=NOVA ROOT, L=Mountain View, ST=California, C=US&#10;        Validity&#10;            Not Before: Oct  2 19:31:45 2012 GMT&#10;            Not After : Oct  2 19:31:45 2013 GMT&#10;        Subject: C=US, ST=California, O=OpenStack, OU=NovaDev, CN=openstack-fake-2012-10-02T19:31:45Z&#10;        Subject Public Key Info:&#10;            Public Key Algorithm: rsaEncryption&#10;            RSA Public Key: (1024 bit)&#10;                Modulus (1024 bit):&#10;                    00:b8:87:67:7a:de:28:ed:f6:5d:1f:20:14:58:df:&#10;                    b0:f7:62:3d:85:61:a8:c2:31:49:5f:b5:2a:07:34:&#10;                    0e:25:13:0d:2e:4d:79:c7:26:36:dd:d2:3e:c7:36:&#10;                    54:80:0d:67:80:32:e6:a8:48:33:69:ec:22:2c:5c:&#10;                    cb:7a:88:0f:c0:48:de:67:14:54:d9:94:b4:6a:23:&#10;                    36:28:23:44:47:8a:24:89:8e:f4:86:77:59:f8:62:&#10;                    b6:ab:d5:e0:bc:b4:ad:d1:95:dd:59:a3:aa:e3:ea:&#10;                    d3:ae:23:17:c5:54:96:a3:25:56:72:90:20:07:8c:&#10;                    63:4d:be:e9:60:7e:10:57:17&#10;                Exponent: 65537 (0x10001)&#10;    Signature Algorithm: md5WithRSAEncryption&#10;        32:82:ff:8b:92:0e:8d:9c:6b:ce:7e:fe:34:16:2a:4c:47:4f:&#10;        c7:28:a2:33:1e:48:56:2e:4b:e8:e8:e3:48:b1:3d:a3:43:21:&#10;        ef:83:e7:df:e2:10:91:7e:9a:c0:4d:1e:96:68:2b:b9:f7:84:&#10;        7f:ec:84:8a:bf:bc:5e:50:05:d9:ce:4a:1a:bf:d2:bf:0c:d1:&#10;        7e:ec:64:c3:a5:37:78:a3:a6:2b:a1:b7:1c:cc:c8:b9:78:61:&#10;        98:50:3c:e6:28:34:f1:0e:62:bb:b5:d7:a1:dd:1f:38:c6:0d:&#10;        58:9f:81:67:ff:9c:32:fc:52:7e:6d:8c:91:43:49:fe:e3:48:&#10;        bb:40&#10;-----BEGIN CERTIFICATE-----&#10;MIICMzCCAZwCARcwDQYJKoZIhvcNAQEEBQAwTjESMBAGA1UEChMJTk9WQSBST09U&#10;MRYwFAYDVQQHEw1Nb3VudGFpbiBWaWV3MRMwEQYDVQQIEwpDYWxpZm9ybmlhMQsw&#10;CQYDVQQGEwJVUzAeFw0xMjEwMDIxOTMxNDVaFw0xMzEwMDIxOTMxNDVaMHYxCzAJ&#10;BgNVBAYTAlVTMRMwEQYDVQQIEwpDYWxpZm9ybmlhMRIwEAYDVQQKEwlPcGVuU3Rh&#10;Y2sxEDAOBgNVBAsTB05vdmFEZXYxLDAqBgNVBAMTI29wZW5zdGFjay1mYWtlLTIw&#10;MTItMTAtMDJUMTk6MzE6NDVaMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC4&#10;h2d63ijt9l0fIBRY37D3Yj2FYajCMUlftSoHNA4lEw0uTXnHJjbd0j7HNlSADWeA&#10;MuaoSDNp7CIsXMt6iA/ASN5nFFTZlLRqIzYoI0RHiiSJjvSGd1n4Yrar1eC8tK3R&#10;ld1Zo6rj6tOuIxfFVJajJVZykCAHjGNNvulgfhBXFwIDAQABMA0GCSqGSIb3DQEB&#10;BAUAA4GBADKC/4uSDo2ca85+/jQWKkxHT8coojMeSFYuS+jo40ixPaNDIe+D59/i&#10;EJF+msBNHpZoK7n3hH/shIq/vF5QBdnOShq/0r8M0X7sZMOlN3ijpiuhtxzMyLl4&#10;YZhQPOYoNPEOYru116HdHzjGDVifgWf/nDL8Un5tjJFDSf7jSLtA&#10;-----END CERTIFICATE-----&#10;"/>

This operation does not accept a request body.

GET

/v2/{tenant_id}/os-certificates

Show root certificate details

Shows details for a root certificate owned by a specified tenant ID.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.

{
    "certificate": {
        "data": "-----BEGIN CERTIFICATE-----\nMIICyzCCAjSgAwIBAgIJAIJ/UoFWKoOUMA0GCSqGSIb3DQEBBAUAME4xEjAQBgNV\nBAoTCU5PVkEgUk9PVDEWMBQGA1UEBxMNTW91bnRhaW4gVmlldzETMBEGA1UECBMK\nQ2FsaWZvcm5pYTELMAkGA1UEBhMCVVMwHhcNMTIxMDAyMTg1NzQ1WhcNMTMxMDAy\nMTg1NzQ1WjBOMRIwEAYDVQQKEwlOT1ZBIFJPT1QxFjAUBgNVBAcTDU1vdW50YWlu\nIFZpZXcxEzARBgNVBAgTCkNhbGlmb3JuaWExCzAJBgNVBAYTAlVTMIGfMA0GCSqG\nSIb3DQEBAQUAA4GNADCBiQKBgQCg0Bn8WSqbJF3QNTZUxo1TzmFBxuqvhjZLKbnQ\nIiShdVIWUK7RC8frq8FJI7dgJNmvkIBn9njABWDoZmurQRCzD65yCSbUc4R2ea5H\nIK4wQIui0CJykvMBNjAe3bzztVVs8/ccDTsjtqq3F/KeQkKzQVfSWBrJSmYtG5tO\nG+dOSwIDAQABo4GwMIGtMAwGA1UdEwQFMAMBAf8wHQYDVR0OBBYEFCljRfaNOsA/\n9mHuq0io7Lt83FtaMH4GA1UdIwR3MHWAFCljRfaNOsA/9mHuq0io7Lt83FtaoVKk\nUDBOMRIwEAYDVQQKEwlOT1ZBIFJPT1QxFjAUBgNVBAcTDU1vdW50YWluIFZpZXcx\nEzARBgNVBAgTCkNhbGlmb3JuaWExCzAJBgNVBAYTAlVTggkAgn9SgVYqg5QwDQYJ\nKoZIhvcNAQEEBQADgYEAEbpJOOlpKCh5omwfAwAfFg1ml4h/FJiCH3PETmOCc+3l\nCtWTBd4MG8AoH7A3PU2JKAGVQ5XWo6+ihpW1RgfQpCnloI6vIeGcws+rSLnlzULt\nIvfCJpRg7iQdR3jZGt3295behtP1GsCqipJEulOkOaEIs8iLlXgSOG94Mkwlb4Q=\n-----END CERTIFICATE-----\n",
        "private_key": null
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<certificate private_key="None" data="-----BEGIN CERTIFICATE-----&#10;MIICyzCCAjSgAwIBAgIJAIJ/UoFWKoOUMA0GCSqGSIb3DQEBBAUAME4xEjAQBgNV&#10;BAoTCU5PVkEgUk9PVDEWMBQGA1UEBxMNTW91bnRhaW4gVmlldzETMBEGA1UECBMK&#10;Q2FsaWZvcm5pYTELMAkGA1UEBhMCVVMwHhcNMTIxMDAyMTg1NzQ1WhcNMTMxMDAy&#10;MTg1NzQ1WjBOMRIwEAYDVQQKEwlOT1ZBIFJPT1QxFjAUBgNVBAcTDU1vdW50YWlu&#10;IFZpZXcxEzARBgNVBAgTCkNhbGlmb3JuaWExCzAJBgNVBAYTAlVTMIGfMA0GCSqG&#10;SIb3DQEBAQUAA4GNADCBiQKBgQCg0Bn8WSqbJF3QNTZUxo1TzmFBxuqvhjZLKbnQ&#10;IiShdVIWUK7RC8frq8FJI7dgJNmvkIBn9njABWDoZmurQRCzD65yCSbUc4R2ea5H&#10;IK4wQIui0CJykvMBNjAe3bzztVVs8/ccDTsjtqq3F/KeQkKzQVfSWBrJSmYtG5tO&#10;G+dOSwIDAQABo4GwMIGtMAwGA1UdEwQFMAMBAf8wHQYDVR0OBBYEFCljRfaNOsA/&#10;9mHuq0io7Lt83FtaMH4GA1UdIwR3MHWAFCljRfaNOsA/9mHuq0io7Lt83FtaoVKk&#10;UDBOMRIwEAYDVQQKEwlOT1ZBIFJPT1QxFjAUBgNVBAcTDU1vdW50YWluIFZpZXcx&#10;EzARBgNVBAgTCkNhbGlmb3JuaWExCzAJBgNVBAYTAlVTggkAgn9SgVYqg5QwDQYJ&#10;KoZIhvcNAQEEBQADgYEAEbpJOOlpKCh5omwfAwAfFg1ml4h/FJiCH3PETmOCc+3l&#10;CtWTBd4MG8AoH7A3PU2JKAGVQ5XWo6+ihpW1RgfQpCnloI6vIeGcws+rSLnlzULt&#10;IvfCJpRg7iQdR3jZGt3295behtP1GsCqipJEulOkOaEIs8iLlXgSOG94Mkwlb4Q=&#10;-----END CERTIFICATE-----&#10;"/>

This operation does not accept a request body.

Cloudpipe (os-cloudpipe)

Manages virtual VPNs for projects.

GET

/v2/{tenant_id}/os-cloudpipe

List cloudpipes

Lists cloudpipes.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.

{
    "cloudpipes": [
        {
            "created_at": "2012-11-27T17:18:01Z",
            "instance_id": "27deecdb-baa3-4a26-9c82-32994b815b01",
            "internal_ip": "192.168.0.3",
            "project_id": "cloudpipe-fa1765bd-a352-49c7-a6b7-8ee108a3cb0c",
            "public_ip": "127.0.0.1",
            "public_port": 22,
            "state": "down"
        }
    ]
}

<?xml version='1.0' encoding='UTF-8'?>
<cloudpipes>
  <cloudpipe>
    <public_ip>127.0.0.1</public_ip>
    <created_at>2012-09-25T18:18:49Z</created_at>
    <public_port>22</public_port>
    <state>down</state>
    <instance_id>1a17f615-343b-430f-976a-457c029eddb7</instance_id>
    <internal_ip>192.168.0.3</internal_ip>
    <project_id>cloudpipe-6405f2ca-caf9-493b-a1f6-e55f595d75ab</project_id>
  </cloudpipe>
</cloudpipes>

This operation does not accept a request body.

POST

/v2/{tenant_id}/os-cloudpipe

Create cloudpipe

Creates a cloudpipe.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
project_id (Optional)	query	xsd:string	Creates the cloudpipe for the specified project ID. If omitted, the project ID defaults to the calling tenant.

{
    "cloudpipe": {
        "project_id": "cloudpipe-059f21e3-c20e-4efc-9e7a-eba2ab3c6f9a"
    }
}

<cloudpipe
    project_id="cloudpipe-6405f2ca-caf9-493b-a1f6-e55f595d75ab"
/>

{
    "instance_id": "1e9b8425-34af-488e-b969-4d46f4a6382e"
}

<?xml version='1.0' encoding='UTF-8'?>
<cloudpipe>
  <instance_id>1a17f615-343b-430f-976a-457c029eddb7</instance_id>
</cloudpipe>

POST

/v2/{tenant_id}/os-cloudpipe/configure-project

Update cloudpipe

Updates the virtual private network (VPN) IP address and port for a specified cloudpipe instance.

Normal response codes

202

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
vpn_ip	header	xsd:string	The VPN IP address.
vpn_port	header	xsd:string	The VPN port.

{
    "configure_project": {
        "vpn_ip": "192.168.1.1",
        "vpn_port": "2000"
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<configure_project>
  <vpn_ip>192.168.1.1</vpn_ip>
  <vpn_port>2000</vpn_port>
</configure_project>

This operation does not return a response body.

Coverage reports (os-coverage)

Shows coverage reports.

POST

/v2/{tenant_id}/os-coverage/action

Get coverage report

Generates a coverage report.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
file	plain	csapi:string	The file name for the report.
xml (Optional)	plain	csapi:bool	Set to true to generate the report in XML format.
html (Optional)	plain	csapi:bool	Set to true to generate the report in HTML format.

Response parameters

Parameter	Style	Type	Description
path	plain	xsd:string	The path to the report file.

{
    "report": {
        "xml": true,
        "file": "report"
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<report>
    <file>report</file>
    <xml>True</xml>
</report>

{
    "path": "/tmp/tmp6kdYaa/nova-coverage_TOTUbz/report"
}

<?xml version='1.0' encoding='UTF-8'?>
<path>/tmp/tmp4j87bp/nova-coverage_7ViTA7/report</path>

POST

/v2/{tenant_id}/os-coverage/action

Start coverage report

Starts Nova coverage reporting.

Normal response codes

202

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
start	plain	csapi:string	Specify `start` in the request body.

{
    "start": {}
}

<?xml version="1.0" encoding="UTF-8"?>
<start></start>

This operation does not return a response body.

POST

/v2/{tenant_id}/os-coverage/action

Start combined coverage report

Starts coverage reporting for all services.

All reports are combined into a single report.

Normal response codes

200

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
start	plain	csapi:string	Specify `start` in the request body.
combine	plain	csapi:bool	Set to true to generate a combined report for all services.

{
    "start": {
        "combine": true
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<start>
    <combine>True</combine>
</start>

This operation does not return a response body.

POST

/v2/{tenant_id}/os-coverage/action

Stop coverage report

Stops coverage reporting.

Normal response codes

202

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
stop	plain	csapi:string	Specify `stop` in the request body.

{
    "stop": {}
}

<?xml version="1.0" encoding="UTF-8"?>
<stop></stop>

{
    "path": "/tmp/tmpua9HvB/nova-coverage_rs2CaS"
}

<?xml version='1.0' encoding='UTF-8'?>
<path>/tmp/tmpCLve38/nova-coverage_GJ4BZ_</path>

Network extended attributes (os-extended-networks)

Creates, shows details for, and lists networks with extended attributes.

POST

/v2/{tenant_id}

Create network

Creates a network with extended attributes.

Normal response codes

202

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The unique identifier of the tenant or account.
network	plain	csapi:dict	A dictionary representation of a network.
bridge (Optional)	plain	xsd:string	VIFs on this network are connected to this bridge.
bridge_interface (Optional)	plain	xsd:string	The bridge is connected to this interface.
broadcast (Optional)	plain	xsd:string	The broadcast address.
cidr (Optional)	plain	xsd:string	IPv4 subnet.
cidr_v6 (Optional)	plain	xsd:string	IPv6 subnet.
created_at (Optional)	plain	xsd:string	Created-at timestamp in ISO 8601 format.
deleted (Optional)	plain	xsd:bool	Deleted flag.
deleted_at (Optional)	plain	xsd:string	Deleted-at timestamp in ISO 8601 format.
dhcp_start (Optional)	plain	xsd:string	DHCP starting address.
dns1 (Optional)	plain	xsd:string	First DNS.
dns2 (Optional)	plain	xsd:string	Second DNS.
gateway (Optional)	plain	xsd:string	IPv4 gateway.
gateway_v6 (Optional)	plain	xsd:string	IPv6 gateway.
host (Optional)	plain	xsd:string	Network host.
id (Optional)	plain	csapi:uuid	The network ID.
injected (Optional)	plain	xsd:bool	Injected flag.
label	plain	xsd:string	Network label.
multi_host (Optional)	plain	xsd:string	Multi host.
netmask (Optional)	plain	xsd:string	The net mask.
netmask_v6 (Optional)	plain	xsd:string	The IPv6 net mask.
priority (Optional)	plain	xsd:int	Network priority.
project_id (Optional)	plain	xsd:string	Project ID.
rxtx_base (Optional)	plain	xsd:string	RXTX base factor value for the network.
updated_at (Optional)	plain	xsd:string	Updated-at timestamp in ISO 8601 format.
vlan (Optional)	plain	csapi:UUID	VLAN ID.
vpn_private_address (Optional)	plain	csapi:UUID	VPN private address.
vpn_public_address (Optional)	plain	csapi:UUID	VPN public address.
vpn_public_port (Optional)	plain	csapi:UUID	VPN public port.
allowed_start (Optional)	plain	xsd:ip	If set, reserves all IP addresses before the `allowed_start` value.
allowed_end (Optional)	plain	xsd:ip	If set, reserves all IP addresses after the `allowed_end` value.
dhcp_server (Optional)	plain	xsd:ip	If you set this parameter to a value other than your default gateway IP address, Compute assumes that your default gateway IP address is external. Default is the default gateway IP address.
enable_dhcp (Optional)	plain	xsd:bool	Enables or disables DHCP on the network. Default is `true`, which enables DHCP. Set to `false` to disable DHCP.
mtu (Optional)	plain	xsd:int	Enables you to set the `network_device_mtu` attribute on each network. This attribute sets the maximum transmission unit (MTU) on a network. Default is enabled.
share_address (Optional)	plain	xsd:bool	If set to `true`, network has the same DHCP IP address on every host, which enables you to set the `share_dhcp_address` flag on each network. Default is `true`.

Response parameters

Parameter	Style	Type	Description
network	plain	csapi:dict	A dictionary representation of a network.
bridge	plain	xsd:string	VIFs on this network are connected to this bridge.
bridge_interface	plain	xsd:string	The bridge is connected to this interface.
broadcast (Optional)	plain	xsd:string	The broadcast address.
cidr	plain	xsd:string	IPv4 subnet.
cidr_v6	plain	xsd:string	IPv6 subnet.
created_at	plain	xsd:string	Created-at timestamp in ISO 8601 format.
deleted	plain	xsd:bool	Deleted flag.
deleted_at	plain	xsd:string	Deleted-at timestamp in ISO 8601 format.
dhcp_start	plain	xsd:string	DHCP starting address.
dns1	plain	xsd:string	First DNS.
dns2	plain	xsd:string	Second DNS.
gateway	plain	xsd:string	IPv4 gateway.
gateway_v6	plain	xsd:string	IPv6 gateway.
host	plain	xsd:string	Network host.
id	plain	csapi:uuid	The network ID.
injected	plain	xsd:bool	Injected flag.
label	plain	xsd:string	Network label.
multi_host	plain	xsd:string	Multi host.
netmask	plain	xsd:string	The net mask.
netmask_v6	plain	xsd:string	The IPv6 net mask.
priority	plain	xsd:int	Network priority.
project_id	plain	xsd:string	Project id.
rxtx_base	plain	xsd:string	RXTX base factor value for the network.
updated_at	plain	xsd:string	Updated-at timestamp in ISO 8601 format.
vlan	plain	csapi:UUID	VLAN ID.
vpn_private_address	plain	csapi:UUID	VPN private address.
vpn_public_address	plain	csapi:UUID	VPN public address.
vpn_public_port	plain	csapi:UUID	VPN public port.
dhcp_server	plain	xsd:ip	If set to a value other than your default gateway IP address, Compute assumes that your default gateway IP address is external.
enable_dhcp	plain	xsd:bool	If set to `true`, DHCP is enabled. If set to `false`, DHCP is disabled.
mtu	plain	xsd:int	If set to `true`, you can set the `network_device_mtu` attribute on each network. This attribute sets the maximum transmission unit (MTU) on a network.
share_address	plain	xsd:bool	If set to `true`, network has the same DHCP IP address on every host. You can set the `share_dhcp_address` flag on each network.

{
    "network": {
        "label": "new net 111",
        "cidr": "10.20.105.0/24",
        "mtu": 9000,
        "dhcp_server": "10.20.105.2",
        "enable_dhcp": false,
        "share_address": true,
        "allowed_start": "10.20.105.10",
        "allowed_end": "10.20.105.200"
    }
}

{
    "network": {
        "bridge": null,
        "bridge_interface": null,
        "broadcast": "10.20.105.255",
        "cidr": "10.20.105.0/24",
        "cidr_v6": null,
        "created_at": null,
        "deleted": null,
        "deleted_at": null,
        "dhcp_server": "10.20.105.2",
        "dhcp_start": "10.20.105.2",
        "dns1": null,
        "dns2": null,
        "enable_dhcp": false,
        "gateway": "10.20.105.1",
        "gateway_v6": null,
        "host": null,
        "id": "d7a17c0c-457e-4ab4-a99c-4fa1762f5359",
        "injected": null,
        "label": "new net 111",
        "mtu": 9000,
        "multi_host": null,
        "netmask": "255.255.255.0",
        "netmask_v6": null,
        "priority": null,
        "project_id": null,
        "rxtx_base": null,
        "share_address": true,
        "updated_at": null,
        "vlan": null,
        "vpn_private_address": null,
        "vpn_public_address": null,
        "vpn_public_port": null
    }
}

GET

/v2/{tenant_id}/os-extended-networks

List networks

Lists networks that are available to the tenant. The information in the network list includes extended network attributes.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The unique identifier of the tenant or account.

Response parameters

Parameter	Style	Type	Description
network	plain	csapi:dict	A dictionary representation of a network.
bridge	plain	xsd:string	VIFs on this network are connected to this bridge.
bridge_interface	plain	xsd:string	The bridge is connected to this interface.
broadcast (Optional)	plain	xsd:string	The broadcast address.
cidr	plain	xsd:string	IPv4 subnet.
cidr_v6	plain	xsd:string	IPv6 subnet.
created_at	plain	xsd:string	Created-at timestamp in ISO 8601 format.
deleted	plain	xsd:bool	Deleted flag.
deleted_at	plain	xsd:string	Deleted-at timestamp in ISO 8601 format.
dhcp_start	plain	xsd:string	DHCP starting address.
dns1	plain	xsd:string	First DNS.
dns2	plain	xsd:string	Second DNS.
gateway	plain	xsd:string	IPv4 gateway.
gateway_v6	plain	xsd:string	IPv6 gateway.
host	plain	xsd:string	Network host.
id	plain	csapi:uuid	The network ID.
injected	plain	xsd:bool	Injected flag.
label	plain	xsd:string	Network label.
multi_host	plain	xsd:string	Multi host.
netmask	plain	xsd:string	The net mask.
netmask_v6	plain	xsd:string	The IPv6 net mask.
priority	plain	xsd:int	Network priority.
project_id	plain	xsd:string	Project id.
rxtx_base	plain	xsd:string	RXTX base factor value for the network.
updated_at	plain	xsd:string	Updated-at timestamp in ISO 8601 format.
vlan	plain	csapi:UUID	VLAN ID.
vpn_private_address	plain	csapi:UUID	VPN private address.
vpn_public_address	plain	csapi:UUID	VPN public address.
vpn_public_port	plain	csapi:UUID	VPN public port.
dhcp_server	plain	xsd:ip	If set to a value other than your default gateway IP address, Compute assumes that your default gateway IP address is external.
enable_dhcp	plain	xsd:bool	If set to `true`, DHCP is enabled. If set to `false`, DHCP is disabled.
mtu	plain	xsd:int	If set to `true`, you can set the `network_device_mtu` attribute on each network. This attribute sets the maximum transmission unit (MTU) on a network.
share_address	plain	xsd:bool	If set to `true`, network has the same DHCP IP address on every host. You can set the `share_dhcp_address` flag on each network.

{
    "networks": [
        {
            "bridge": "br100",
            "bridge_interface": "eth0",
            "broadcast": "10.0.0.7",
            "cidr": "10.0.0.0/29",
            "cidr_v6": null,
            "created_at": "2011-08-15T06:19:19.387525",
            "deleted": false,
            "deleted_at": null,
            "dhcp_server": "10.0.0.1",
            "dhcp_start": "10.0.0.3",
            "dns1": null,
            "dns2": null,
            "enable_dhcp": true,
            "gateway": "10.0.0.1",
            "gateway_v6": null,
            "host": "nsokolov-desktop",
            "id": "20c8acc0-f747-4d71-a389-46d078ebf047",
            "injected": false,
            "label": "mynet_0",
            "mtu": null,
            "multi_host": false,
            "netmask": "255.255.255.248",
            "netmask_v6": null,
            "priority": null,
            "project_id": "1234",
            "rxtx_base": null,
            "share_address": false,
            "updated_at": "2011-08-16T09:26:13.048257",
            "vlan": 100,
            "vpn_private_address": "10.0.0.2",
            "vpn_public_address": "127.0.0.1",
            "vpn_public_port": 1000
        },
        {
            "bridge": "br101",
            "bridge_interface": "eth0",
            "broadcast": "10.0.0.15",
            "cidr": "10.0.0.10/29",
            "cidr_v6": null,
            "created_at": "2011-08-15T06:19:19.885495",
            "deleted": false,
            "deleted_at": null,
            "dhcp_server": "10.0.0.9",
            "dhcp_start": "10.0.0.11",
            "dns1": null,
            "dns2": null,
            "enable_dhcp": true,
            "gateway": "10.0.0.9",
            "gateway_v6": null,
            "host": null,
            "id": "20c8acc0-f747-4d71-a389-46d078ebf000",
            "injected": false,
            "label": "mynet_1",
            "mtu": null,
            "multi_host": false,
            "netmask": "255.255.255.248",
            "netmask_v6": null,
            "priority": null,
            "project_id": null,
            "rxtx_base": null,
            "share_address": false,
            "updated_at": null,
            "vlan": 101,
            "vpn_private_address": "10.0.0.10",
            "vpn_public_address": null,
            "vpn_public_port": 1001
        }
    ]
}

This operation does not accept a request body.

GET

/v2/{tenant_id}/os-extended-networks/{id}

Show network information

Shows information including extended attributes for a specified network.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The unique identifier of the tenant or account.
id	URI	csapi:UUID	The unique identifier associated with the network.

Response parameters

Parameter	Style	Type	Description
network	plain	csapi:dict	A dictionary representation of a network.
bridge	plain	xsd:string	VIFs on this network are connected to this bridge.
bridge_interface	plain	xsd:string	The bridge is connected to this interface.
broadcast (Optional)	plain	xsd:string	The broadcast address.
cidr	plain	xsd:string	IPv4 subnet.
cidr_v6	plain	xsd:string	IPv6 subnet.
created_at	plain	xsd:string	Created-at timestamp in ISO 8601 format.
deleted	plain	xsd:bool	Deleted flag.
deleted_at	plain	xsd:string	Deleted-at timestamp in ISO 8601 format.
dhcp_start	plain	xsd:string	DHCP starting address.
dns1	plain	xsd:string	First DNS.
dns2	plain	xsd:string	Second DNS.
gateway	plain	xsd:string	IPv4 gateway.
gateway_v6	plain	xsd:string	IPv6 gateway.
host	plain	xsd:string	Network host.
id	plain	csapi:uuid	The network ID.
injected	plain	xsd:bool	Injected flag.
label	plain	xsd:string	Network label.
multi_host	plain	xsd:string	Multi host.
netmask	plain	xsd:string	The net mask.
netmask_v6	plain	xsd:string	The IPv6 net mask.
priority	plain	xsd:int	Network priority.
project_id	plain	xsd:string	Project id.
rxtx_base	plain	xsd:string	RXTX base factor value for the network.
updated_at	plain	xsd:string	Updated-at timestamp in ISO 8601 format.
vlan	plain	csapi:UUID	VLAN ID.
vpn_private_address	plain	csapi:UUID	VPN private address.
vpn_public_address	plain	csapi:UUID	VPN public address.
vpn_public_port	plain	csapi:UUID	VPN public port.
dhcp_server	plain	xsd:ip	If set to a value other than your default gateway IP address, Compute assumes that your default gateway IP address is external.
enable_dhcp	plain	xsd:bool	If set to `true`, DHCP is enabled. If set to `false`, DHCP is disabled.
mtu	plain	xsd:int	If set to `true`, you can set the `network_device_mtu` attribute on each network. This attribute sets the maximum transmission unit (MTU) on a network.
share_address	plain	xsd:bool	If set to `true`, network has the same DHCP IP address on every host. You can set the `share_dhcp_address` flag on each network.

{
    "network": {
        "bridge": "br100",
        "bridge_interface": "eth0",
        "broadcast": "10.0.0.7",
        "cidr": "10.0.0.0/29",
        "cidr_v6": null,
        "created_at": "2011-08-15T06:19:19.387525",
        "deleted": false,
        "deleted_at": null,
        "dhcp_server": "10.0.0.1",
        "dhcp_start": "10.0.0.3",
        "dns1": null,
        "dns2": null,
        "enable_dhcp": true,
        "gateway": "10.0.0.1",
        "gateway_v6": null,
        "host": "nsokolov-desktop",
        "id": "20c8acc0-f747-4d71-a389-46d078ebf047",
        "injected": false,
        "label": "mynet_0",
        "mtu": null,
        "multi_host": false,
        "netmask": "255.255.255.248",
        "netmask_v6": null,
        "priority": null,
        "project_id": "1234",
        "rxtx_base": null,
        "share_address": false,
        "updated_at": "2011-08-16T09:26:13.048257",
        "vlan": 100,
        "vpn_private_address": "10.0.0.2",
        "vpn_public_address": "127.0.0.1",
        "vpn_public_port": 1000
    }
}

This operation does not accept a request body.

Fixed IPs (os-fixed-ips)

Shows data for a specified fixed IP, such as host name, CIDR, and address. Also, reserves and frees a fixed IP address.

GET

/v2/{tenant_id}/os-fixed-ips/{fixed_ip}

Show fixed IP information

Shows information for a specified fixed IP address.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
fixed_ip	URI	xsd:string	The fixed IP of interest to you.

{
    "fixed_ip": {
        "address": "192.168.1.1",
        "cidr": "192.168.1.0/24",
        "host": "host",
        "hostname": "openstack"
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<fixed_ip>
  <cidr>192.168.1.0/24</cidr>
  <hostname>openstack</hostname>
  <host>host</host>
  <address>192.168.1.1</address>
</fixed_ip>

This operation does not accept a request body.

POST

/v2/{tenant_id}/os-fixed-ips/{fixed_ip}/action

Reserve or release a fixed IP

Reserves or releases a fixed IP.

To reserve a fixed IP address, specify reserve in the request body. To release a fixed IP address, specify unreserve in the request body.

Normal response codes

202

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
fixed_ip	URI	xsd:string	The fixed IP of interest to you.

{
    "reserve": "None"
}

<?xml version="1.0" encoding="UTF-8"?>
<reserve>None</reserve>

This operation does not return a response body.

Floating IP DNS records (os-floating-ip-dns)

Manages DNS records that are associated with IP addresses that are allocated by the floating IPs extension. Requests are dispatched to a DNS driver selected at startup.

GET

/v2/{tenant_id}/os-floating-ip-dns

List DNS domains

Lists registered DNS domains published by the DNS drivers.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The unique identifier of the tenant or account.

{
    "domain_entries": [
        {
            "availability_zone": null,
            "domain": "domain1.example.org",
            "project": "project1",
            "scope": "public"
        }
    ]
}

<?xml version='1.0' encoding='UTF-8'?>
<domain_entries>
  <domain_entry project="project1" scope="public" domain="domain1.example.org" availability_zone="None"/>
</domain_entries>

This operation does not accept a request body.

PUT

/v2/{tenant_id}/os-floating-ip-dns/{domain}

Create or update DNS domain

Creates or updates a DNS domain.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The unique identifier of the tenant or account.
domain	URI	xsd:string	Registered DNS domain published by the DNS drivers.

{
    "domain_entry": {
        "domain": "domain1.example.org",
        "scope": "public",
        "project": "project1"
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<domain_entry>
  <domain>domain1.example.org</domain>
  <scope>public</scope>
  <project>project1</project>
</domain_entry>

{
    "domain_entry": {
        "availability_zone": null,
        "domain": "domain1.example.org",
        "project": "project1",
        "scope": "public"
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<domain_entry project="project1" scope="public" domain="domain1.example.org" availability_zone="None"/>

DELETE

/v2/{tenant_id}/os-floating-ip-dns/{domain}

Delete DNS domain

Deletes a DNS domain and all associated host entries.

Normal response codes

200

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The unique identifier of the tenant or account.
domain	URI	xsd:string	Registered DNS domain published by the DNS drivers.

This operation does not accept a request body and does not return a response body.

PUT

/v2/{tenant_id}/os-floating-ip-dns/{domain}/entries/{name}

Create or update DNS entry

Creates or updates a DNS entry.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The unique identifier of the tenant or account.
domain	URI	xsd:string	Registered DNS domain published by the DNS drivers.
name	URI	xsd:string	DNS entry name assigned under a domain.

{
    "dns_entry": {
        "ip": "192.168.53.11",
        "dns_type": "A"
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<dns_entry>
  <ip>192.168.53.11</ip>
  <dns_type>A</dns_type>
</dns_entry>

{
    "dns_entry": {
        "domain": "domain1.example.org",
        "id": null,
        "ip": "192.168.1.1",
        "name": "instance1",
        "type": "A"
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<dns_entry ip="192.168.1.1" domain="domain1.example.org" type="A" id="None" name="instance1"/>

GET

/v2/{tenant_id}/os-floating-ip-dns/{domain}/entries/{name}

Find unique DNS entry

Finds a unique DNS entry for a specified domain and name.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The unique identifier of the tenant or account.
domain	URI	xsd:string	Registered DNS domain published by the DNS drivers.
name	URI	xsd:string	DNS entry name assigned under a domain.

{
    "dns_entry": {
        "domain": "domain1.example.org",
        "id": null,
        "ip": "192.168.1.1",
        "name": "instance1",
        "type": null
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<dns_entry ip="192.168.1.1" domain="domain1.example.org" type="None" id="None" name="instance1"/>

This operation does not accept a request body.

DELETE

/v2/{tenant_id}/os-floating-ip-dns/{domain}/entries/{name}

Delete DNS entry

Deletes a specified DNS entry.

Normal response codes

204

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The unique identifier of the tenant or account.
domain	URI	xsd:string	Registered DNS domain published by the DNS drivers.
name	URI	xsd:string	DNS entry name assigned under a domain.

This operation does not accept a request body and does not return a response body.

GET

/v2/{tenant_id}/os-floating-ip-dns/{domain}/entries/{ip}

List DNS entries

Lists DNS entries for a specified domain and IP.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The unique identifier of the tenant or account.
domain	URI	xsd:string	Registered DNS domain published by the DNS drivers.

{
    "dns_entries": [
        {
            "domain": "domain1.example.org",
            "id": null,
            "ip": "192.168.1.1",
            "name": "instance1",
            "type": null
        }
    ]
}

<?xml version='1.0' encoding='UTF-8'?>
<dns_entries>
  <dns_entry ip="192.168.1.1" domain="domain1.example.org" type="None" id="None" name="instance1"/>
</dns_entries>

This operation does not accept a request body.

Floating IP pools (os-floating-ip-pools)

Manages groups of floating IPs.

GET

/v2/{tenant_id}/os-floating-ip-pools

List floating IP pools

Lists floating IP pools.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The unique identifier of the tenant or account.

{
    "floating_ip_pools": [
        {
            "name": "pool1"
        },
        {
            "name": "pool2"
        }
    ]
}

<?xml version='1.0' encoding='UTF-8'?>
<floating_ip_pools>
  <floating_ip_pool name="pool1"/>
  <floating_ip_pool name="pool2"/>
</floating_ip_pools>

This operation does not accept a request body.

Floating IPs (os-floating-ips)

Assigns and allocates floating IP addresses to instances that run in an OpenStack cloud.

GET

/v2/{tenant_id}/os-floating-ips

List floating IPs

Lists floating IP addresses associated with the tenant or account.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The unique identifier of the tenant or account.

{
    "floating_ips": [
        {
            "fixed_ip": null,
            "id": 1,
            "instance_id": null,
            "ip": "10.10.10.1",
            "pool": "nova"
        },
        {
            "fixed_ip": null,
            "id": 2,
            "instance_id": null,
            "ip": "10.10.10.2",
            "pool": "nova"
        }
    ]
}

<?xml version='1.0' encoding='UTF-8'?>
<floating_ips>
  <floating_ip instance_id="None" ip="10.10.10.1" fixed_ip="None" id="1" pool="nova"/>
  <floating_ip instance_id="None" ip="10.10.10.2" fixed_ip="None" id="2" pool="nova"/>
</floating_ips>

This operation does not accept a request body.

POST

/v2/{tenant_id}/os-floating-ips

Allocate floating IP

Allocates a new floating IP address to a tenant or account.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The unique identifier of the tenant or account.
pool (Optional)	plain	String	Pool to allocate IP address from. Will use default pool if not specified.

{
    "pool": "nova"
}

<?xml version='1.0' encoding='UTF-8'?>
<pool>nova</pool>

{
    "floating_ip": {
        "fixed_ip": null,
        "id": 1,
        "instance_id": null,
        "ip": "10.10.10.1",
        "pool": "nova"
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<floating_ip instance_id="None" ip="10.10.10.1" fixed_ip="None" id="1" pool="nova"/>

GET

/v2/{tenant_id}/os-floating-ips/{id}

Show floating IP information

Shows information for a specified floating IP address.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The unique identifier of the tenant or account.
id	URI	String	The unique identifier associated with allocated floating IP address.

{
    "floating_ip": {
        "fixed_ip": null,
        "id": 1,
        "instance_id": null,
        "ip": "10.10.10.1",
        "pool": "nova"
    }
}

<floating_ip instance_id="None" ip="10.10.10.1" fixed_ip="None" id="1" pool="nova"/>

This operation does not accept a request body.

DELETE

/v2/{tenant_id}/os-floating-ips/{id}

Deallocate floating IP

Deallocates the floating IP address associated with floating_IP_address_ID.

Only manually-allocated floating IP addresses are deallocated and deleted by this call. Auto-allocated floating IP addresses must first be manually deallocated before they can be deleted.

Normal response codes

202

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The unique identifier of the tenant or account.
id	URI	String	The unique identifier associated with allocated floating IP address.

This operation does not accept a request body and does not return a response body.

POST

/v2/{tenant_id}/servers/{server_id}/action

Add floating IP

Adds a floating IP address to an instance.

Normal response codes

202

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The unique identifier of the tenant or account.
server_id	URI	csapi:UUID	The UUID for the server of interest to you.
pool	plain	xsd:string	The pool to which to add the floating IP address.

{
    "addFloatingIp": {
        "address": "10.10.10.1"
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<addFloatingIp>
    <address>10.10.10.1</address>
</addFloatingIp>

This operation does not return a response body.

POST

/v2/{tenant_id}/servers/{server_id}/action

Remove floating IP

Removes a floating IP from an instance.

Normal response codes

202

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The unique identifier of the tenant or account.
server_id	URI	csapi:UUID	The UUID for the server of interest to you.
removeFloatingIp	plain	xsd:string	Specify the `removeFloatingIp` action in the request body.
address	plain	xsd:string	The floating IP address that you want to remove.

{
    "removeFloatingIp": {
        "address": "10.10.10.1"
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<removeFloatingIp>
    <address>10.10.10.1</address>
</removeFloatingIp>

This operation does not return a response body.

Floating IPs bulk (os-floating-ips-bulk)

Bulk-creates, deletes, and lists floating IPs. By default, the pool is named nova. Use the os-floating-ip-pools extension to view available pools.

GET

/v2/{tenant_id}/os-floating-ips-bulk

List floating IPs

Lists all floating IPs.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The unique identifier of the tenant or account.

{
    "floating_ip_info": [
        {
            "address": "10.10.10.1",
            "instance_uuid": null,
            "interface": "eth0",
            "pool": "nova",
            "project_id": null
        },
        {
            "address": "10.10.10.2",
            "instance_uuid": null,
            "interface": "eth0",
            "pool": "nova",
            "project_id": null
        },
        {
            "address": "10.10.10.3",
            "instance_uuid": null,
            "interface": "eth0",
            "pool": "nova",
            "project_id": null
        }
    ]
}

<?xml version='1.0' encoding='UTF-8'?>
<floating_ip_info>
  <item>
    <interface>eth0</interface>
    <instance_uuid>None</instance_uuid>
    <project_id>None</project_id>
    <pool>nova</pool>
    <address>10.10.10.1</address>
  </item>
  <item>
    <interface>eth0</interface>
    <instance_uuid>None</instance_uuid>
    <project_id>None</project_id>
    <pool>nova</pool>
    <address>10.10.10.2</address>
  </item>
  <item>
    <interface>eth0</interface>
    <instance_uuid>None</instance_uuid>
    <project_id>None</project_id>
    <pool>nova</pool>
    <address>10.10.10.3</address>
  </item>
</floating_ip_info>

This operation does not accept a request body.

POST

/v2/{tenant_id}/os-floating-ips-bulk

Create floating IPs

Bulk-creates floating IPs.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The unique identifier of the tenant or account.
ip_range	plain	xsd:int	The range of IP addresses to use for creating floating IPs.

{
    "floating_ips_bulk_create": {
        "ip_range": "192.168.1.0/24",
        "pool": "nova",
        "interface": "eth0"
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<floating_ips_bulk_create>
<ip_range>192.168.1.0/24</ip_range>
<pool>nova</pool>
<interface>eth0</interface>
</floating_ips_bulk_create>

{
    "floating_ips_bulk_create": {
        "interface": "eth0",
        "ip_range": "192.168.1.0/24",
        "pool": "nova"
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<floating_ips_bulk_create>
  <interface>eth0</interface>
  <ip_range>192.168.1.0/24</ip_range>
  <pool>nova</pool>
</floating_ips_bulk_create>

POST

/v2/{tenant_id}/os-floating-ips-bulk/delete

Bulk-delete floating IPs

Bulk-deletes floating IPs.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The unique identifier of the tenant or account.
ip_range	plain	xsd:int	The range of IP addresses from which to bulk-delete floating IPs.

{
    "ip_range": "192.168.1.0/24"
}

<?xml version='1.0' encoding='UTF-8'?>
<ip_range>192.168.1.0/24</ip_range>

{
    "floating_ips_bulk_delete": "192.168.1.0/24"
}

<?xml version='1.0' encoding='UTF-8'?>
<floating_ips_bulk_delete>192.168.1.0/24</floating_ips_bulk_delete>

GET

/v2/{tenant_id}/os-floating-ips-bulk/{host_name}

List floating IPs by host

Lists all floating IPs for a specified host.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The unique identifier of the tenant or account.
host_name	URI	xsd:string	The name of the host of interest to you.

{
    "floating_ip_info": [
        {
            "address": "10.10.10.3",
            "instance_uuid": null,
            "interface": "eth0",
            "pool": "nova",
            "project_id": null
        }
    ]
}

<?xml version='1.0' encoding='UTF-8'?>
<floating_ip_info>
  <item>
    <interface>eth0</interface>
    <instance_uuid>None</instance_uuid>
    <project_id>None</project_id>
    <pool>nova</pool>
    <address>10.10.10.3</address>
  </item>
</floating_ip_info>

This operation does not accept a request body.

Hosts (os-hosts)

Manages physical hosts.

GET

/v2/{tenant_id}/os-hosts

List hosts

Lists hosts.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
service (Optional)	query	xsd:string	The service name. To filter the returned list by service name, specify `?service={service}` in the URI.
zone (Optional)	query	xsd:string	The zone. To filter the returned list by zone, specify `?zone={zone}` in the URI.

{
    "hosts": [
        {
            "host_name": "787f4f6dda1b409bb8b2f9082349690e",
            "service": "compute",
            "zone": "nova"
        },
        {
            "host_name": "a98b433151084aee8b1a986e28823b36",
            "service": "cert",
            "zone": "internal"
        },
        {
            "host_name": "c56158d13a884a87abf9171efb7de9d8",
            "service": "network",
            "zone": "internal"
        },
        {
            "host_name": "81d5cdcda0014918b3ebd3503a2e5c9a",
            "service": "scheduler",
            "zone": "internal"
        },
        {
            "host_name": "6e48bfe1a3304b7b86154326328750ae",
            "service": "conductor",
            "zone": "internal"
        },
        {
            "host_name": "39f55087a1024d1380755951c945ca69",
            "service": "cells",
            "zone": "internal"
        },
        {
            "host_name": "7a9a6cb4701f4dee9048fe0bc25d0ee5",
            "service": "consoleauth",
            "zone": "internal"
        }
    ]
}

<?xml version='1.0' encoding='UTF-8'?>
<hosts>
  <host zone="internal" host_name="02ff30050a0d4ce486e60e946a97d28f" service="conductor"/>
  <host zone="nova" host_name="69dd365b9eae459883a50d1fe7b3c40b" service="compute"/>
  <host zone="internal" host_name="059ca4da76cf49e8a3d08d2303542157" service="cert"/>
  <host zone="internal" host_name="ea70b9f0c530497fba8571deb4835ab0" service="network"/>
  <host zone="internal" host_name="7d52ad3988504fb18b0cdfd94dbd267b" service="scheduler"/>
  <host zone="internal" host_name="dc36bce962cc49c2ab916287bcf6c9d3" service="cells"/>
  <host zone="internal" host_name="4bd7bbcc80064d21a5fd0bd53318c6fa" service="consoleauth"/>
</hosts>

GET

/v2/{tenant_id}/os-hosts/{host_name}

Show host information

Shows information for a specified host.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
host_name	URI	xsd:string	The name of the host of interest to you.

{
    "host": [
        {
            "resource": {
                "cpu": 1,
                "disk_gb": 1028,
                "host": "5ca60c6792a1442f9471ff575443f94d",
                "memory_mb": 8192,
                "project": "(total)"
            }
        },
        {
            "resource": {
                "cpu": 0,
                "disk_gb": 0,
                "host": "5ca60c6792a1442f9471ff575443f94d",
                "memory_mb": 512,
                "project": "(used_now)"
            }
        },
        {
            "resource": {
                "cpu": 0,
                "disk_gb": 0,
                "host": "5ca60c6792a1442f9471ff575443f94d",
                "memory_mb": 0,
                "project": "(used_max)"
            }
        }
    ]
}

<?xml version='1.0' encoding='UTF-8'?>
<host>
  <resource>
    <project>(total)</project>
    <memory_mb>8192</memory_mb>
    <host>ecf3458ac6bf4a299cc2e0efa740f426</host>
    <cpu>1</cpu>
    <disk_gb>1028</disk_gb>
  </resource>
  <resource>
    <project>(used_now)</project>
    <memory_mb>512</memory_mb>
    <host>ecf3458ac6bf4a299cc2e0efa740f426</host>
    <cpu>0</cpu>
    <disk_gb>0</disk_gb>
  </resource>
  <resource>
    <project>(used_max)</project>
    <memory_mb>0</memory_mb>
    <host>ecf3458ac6bf4a299cc2e0efa740f426</host>
    <cpu>0</cpu>
    <disk_gb>0</disk_gb>
  </resource>
</host>

This operation does not accept a request body.

PUT

/v2/{tenant_id}/os-hosts/{host_name}

Update host

Enables a host or puts it in maintenance mode.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
host_name	URI	xsd:string	The name of the host of interest to you.
status	plain	xsd:string	Valid values are enable or disable.
maintenance_mode	plain	xsd:string	Valid values are enable or disable.

{
    "status": "enable",
    "maintenance_mode": "disable"
}

<?xml version="1.0" encoding="UTF-8" ?>
<updates>
    <status>enable</status>
    <maintenance_mode>disable</maintenance_mode>
</updates>

{
    "host": "0738dca90a8c43fdadd0be28715520e2",
    "maintenance_mode": "off_maintenance",
    "status": "enabled"
}

<?xml version='1.0' encoding='UTF-8'?>
<host status="enabled" maintenance_mode="off_maintenance" host="d85f05519b57457c83da18c39fa8e00d"/>

GET

/v2/{tenant_id}/os-hosts/{host_name}/startup

Start host

Starts a host.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
host_name	URI	xsd:string	The name of the host of interest to you.

{
    "host": "57f5de2fa5b44f14974a4f50b9ffcbf8",
    "power_action": "startup"
}

<?xml version='1.0' encoding='UTF-8'?>
<host host="7fae168ed18140d5a785ade2ac1bd420" power_action="startup"/>

This operation does not accept a request body.

GET

/v2/{tenant_id}/os-hosts/{host_name}/shutdown

Shut down host

Shuts down a host.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
host_name	URI	xsd:string	The name of the host of interest to you.

{
    "host": "d2576862a2144ee6ad37d9e1938460a2",
    "power_action": "shutdown"
}

<?xml version='1.0' encoding='UTF-8'?>
<host host="c82ca6da579440ac930ddee0e6530176" power_action="shutdown"/>

This operation does not accept a request body.

GET

/v2/{tenant_id}/os-hosts/{host_name}/reboot

Reboot host

Reboots a host.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
host_name	URI	xsd:string	The name of the host of interest to you.

{
    "host": "066bf157ab50481d8c607cfe584b2230",
    "power_action": "reboot"
}

<?xml version='1.0' encoding='UTF-8'?>
<host host="ce8c5f8cde4a46ffb01dec0788ad4dfc" power_action="reboot"/>

This operation does not accept a request body.

Hypervisors (os-hypervisors)

Displays extra statistical information from the machine that hosts the hypervisor through the API for the hypervisor (XenAPI or KVM/libvirt).

GET

/v2/{tenant_id}/os-hypervisors

List hypervisors

Lists hypervisors information for each server obtained through the hypervisor-specific API, such as libvirt or XenAPI.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.

Response parameters

Parameter	Style	Type	Description
hypervisor_hostname	plain	xsd:string	Hypervisor host name, retrieved from the per-server listing.
id	plain	xsd:string	Hypervisor ID.

{
    "hypervisors": [
        {
            "hypervisor_hostname": "fake-mini",
            "id": 1
        }
    ]
}

<?xml version='1.0' encoding='UTF-8'?>
<hypervisors>
  <hypervisor id="1" hypervisor_hostname="fake-mini"/>
</hypervisors>

This operation does not accept a request body.

GET

/v2/{tenant_id}/os-hypervisors/detail

Show hypervisor information

Shows information for a specified hypervisor. Typically configured as an admin-only extension by using policy.json settings.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.

{
    "hypervisors": [
        {
            "cpu_info": "?",
            "current_workload": 0,
            "disk_available_least": null,
            "free_disk_gb": 1028,
            "free_ram_mb": 7680,
            "hypervisor_hostname": "fake-mini",
            "hypervisor_type": "fake",
            "hypervisor_version": 1,
            "id": 1,
            "local_gb": 1028,
            "local_gb_used": 0,
            "memory_mb": 8192,
            "memory_mb_used": 512,
            "running_vms": 0,
            "service": {
                "host": "1e0d7892083548cfb347e782d3b20342",
                "id": 2
            },
            "vcpus": 1,
            "vcpus_used": 0
        }
    ]
}

<?xml version='1.0' encoding='UTF-8'?>
<hypervisors>
  <hypervisor vcpus_used="0" hypervisor_type="fake" local_gb_used="0" hypervisor_hostname="fake-mini" memory_mb_used="512" memory_mb="8192" current_workload="0" vcpus="1" cpu_info="?" running_vms="0" free_disk_gb="1028" hypervisor_version="1" disk_available_least="None" local_gb="1028" free_ram_mb="7680" id="1">
    <service host="4400f556a66d44ce95dfa61e75a23aaf" id="2"/>
  </hypervisor>
</hypervisors>

This operation does not accept a request body.

GET

/v2/{tenant_id}/os-hypervisors/statistics

Show statistics for hypervisors

Shows hypervisor statistics over all compute nodes.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.

{
    "hypervisor_statistics": {
        "count": 1,
        "current_workload": 0,
        "disk_available_least": 0,
        "free_disk_gb": 1028,
        "free_ram_mb": 7680,
        "local_gb": 1028,
        "local_gb_used": 0,
        "memory_mb": 8192,
        "memory_mb_used": 512,
        "running_vms": 0,
        "vcpus": 1,
        "vcpus_used": 0
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<hypervisor_statistics count="1" vcpus_used="0" local_gb_used="0" memory_mb="8192" current_workload="0" vcpus="1" running_vms="0" free_disk_gb="1028" disk_available_least="0" local_gb="1028" free_ram_mb="7680" memory_mb_used="512"/>

This operation does not accept a request body.

GET

/v2/{tenant_id}/os-hypervisors/{hypervisor_hostname}

Show hypervisor up time

Shows the up time for a specified hypervisor.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
hypervisor_hostname	URI	xsd:string	The name of the host that runs the hypervisor.

{
    "hypervisor": {
        "hypervisor_hostname": "fake-mini",
        "id": 1,
        "uptime": " 08:32:11 up 93 days, 18:25, 12 users,  load average: 0.20, 0.12, 0.14"
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<hypervisor uptime=" 08:32:11 up 93 days, 18:25, 12 users,  load average: 0.20, 0.12, 0.14" id="1" hypervisor_hostname="fake-mini"/>

This operation does not accept a request body.

GET

/v2/{tenant_id}/os-hypervisors/{hypervisor_hostname}/servers

List instances for hypervisors

Lists instances that belong to specific hypervisors.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
hypervisor_hostname	URI	xsd:string	The name of the host that runs the hypervisor.

{
    "hypervisors": [
        {
            "hypervisor_hostname": "fake-mini",
            "id": 1
        }
    ]
}

<?xml version='1.0' encoding='UTF-8'?>
<hypervisors>
  <hypervisor id="1" hypervisor_hostname="fake-mini">
    <servers/>
  </hypervisor>
</hypervisors>

This operation does not accept a request body.

Hypervisor with status (os-hypervisor-status)

Displays extra statistical information including status from the machine that hosts the hypervisor through the API for the hypervisor (XenAPI or KVM/libvirt).

GET

/v2/{tenant_id}/os-hypervisor-status/detail

Show hypervisor information

Shows information for a specified hypervisor. Includes the hypervisor status.

Typically configured as an admin-only extension by using policy.json settings.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.

{
    "hypervisor": {
        "cpu_info": "{\"arch\": \"x86_64\", \"model\": \"Nehalem\", \"vendor\": \"Intel\", \"features\": [\"pge\", \"clflush\"], \"topology\": {\"cores\": 1, \"threads\": 1, \"sockets\": 4}}",
        "current_workload": 0,
        "disk_available_least": 0,
        "free_disk_gb": 1028,
        "free_ram_mb": 7680,
        "hypervisor_hostname": "fake-mini",
        "hypervisor_type": "fake",
        "hypervisor_version": 1000,
        "id": 1,
        "status": "enabled",
        "state": "up",
        "local_gb": 1028,
        "local_gb_used": 0,
        "memory_mb": 8192,
        "memory_mb_used": 512,
        "running_vms": 0,
        "service": {
            "host": "5641188ab2964f88a21042b493585ff8",
            "id": 2,
            "disabled_reason": null
        },
        "vcpus": 1,
        "vcpus_used": 0
    }
}

This operation does not accept a request body.

Attach interfaces (os-interface)

Creates, lists, gets details for, and deletes port interfaces.

POST

/v2/{tenant_id}/servers/{server_id}/os-interface

Create interface

Creates and uses a port interface to attach the port to a server instance.

Normal response codes

202

Error response codes

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
server_id	URI	csapi:UUID	The UUID for the server of interest to you.
interfaceAttachment	plain	xsd:string	Specify the `interfaceAttachment` action in the request body.
port_id (Optional)	plain	csapi:uuid	The ID of the port for which you want to create an interface. The `net_id` and `port_id` parameters are mutually exclusive. If you do not specify the `port_id` parameter, the OpenStack Networking API v2.0 allocates a port on the specified network.
net_id (Optional)	plain	csapi:uuid	The ID of the network for which you want to create an interface. The `net_id` and `port_id` parameters are mutually exclusive. If you do not specify the `net_id` parameter, the OpenStack Networking API v2.0 uses the network information cache that is associated with the instance.
fixed_ips (Optional)	plain	xsd:string	Fixed IP addresses with subnet IDs. If you request a specific fixed IP address without a `net_id`, the request returns a `400 BadRequest` error code.

Response parameters

Parameter	Style	Type	Description
fixed_ips	plain	xsd:string	Fixed IP addresses with subnet IDs.
mac_addr	plain	xsd:string	The MAC address.
net_id	plain	csapi:uuid	The network ID.
port_id	plain	csapi:uuid	The port ID.
port_state	plain	xsd:string	The port state.

{
    "interfaceAttachment": {
        "port_id": "ce531f90-199f-48c0-816c-13e38010b442"
    }
}

{
    "interfaceAttachment": {
        "fixed_ips": [
            {
                "ip_address": "192.168.1.1",
                "subnet_id": "f8a6e8f8-c2ec-497c-9f23-da9616de54ef"
            }
        ],
        "mac_addr": "fa:16:3e:4c:2c:30",
        "net_id": "3cb9bc59-5699-4588-a4b1-b87f96708bc6",
        "port_id": "ce531f90-199f-48c0-816c-13e38010b442",
        "port_state": "ACTIVE"
    }
}

GET

/v2/{tenant_id}/servers/{server_id}/os-interface

List interfaces

Lists port interfaces.

Normal response codes

200

Error response codes

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
server_id	URI	csapi:UUID	The UUID for the server of interest to you.

Response parameters

Parameter	Style	Type	Description
port_state	plain	xsd:string	The port state.
fixed_ips	plain	xsd:string	Fixed IP addresses with subnet IDs.
mac_addr	plain	xsd:string	The MAC address.
net_id	plain	csapi:uuid	The network ID.
port_id	plain	csapi:uuid	The port ID.

{
    "interfaceAttachments": [
        {
            "port_state": "ACTIVE",
            "fixed_ips": [
                {
                    "subnet_id": "f8a6e8f8-c2ec-497c-9f23-da9616de54ef",
                    "ip_address": "192.168.1.3"
                }
            ],
            "net_id": "3cb9bc59-5699-4588-a4b1-b87f96708bc6",
            "port_id": "ce531f90-199f-48c0-816c-13e38010b442",
            "mac_addr": "fa:16:3e:4c:2c:30"
        }
    ]
}

This operation does not accept a request body.

GET

/v2/{tenant_id}/servers/{server_id}/os-interface/{attachment_id}

Show attached interface information

Shows information about a specified port interface.

Normal response codes

202

Error response codes

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
server_id	URI	csapi:UUID	The UUID for the server of interest to you.
attachment_id	URI	csapi:UUID	The interface ID.

{
    "interfaceAttachment": {
        "port_state": "ACTIVE",
        "fixed_ips": [
            {
                "subnet_id": "f8a6e8f8-c2ec-497c-9f23-da9616de54ef",
                "ip_address": "192.168.1.3"
            }
        ],
        "net_id": "3cb9bc59-5699-4588-a4b1-b87f96708bc6",
        "port_id": "ce531f90-199f-48c0-816c-13e38010b442",
        "mac_addr": "fa:16:3e:4c:2c:30"
    }
}

This operation does not accept a request body.

DELETE

/v2/{tenant_id}/servers/{server_id}/os-interface/{attachment_id}

Detach interface

Detaches a specified port interface.

Normal response codes

202

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
server_id	URI	csapi:UUID	The UUID for the server of interest to you.
attachment_id	URI	csapi:UUID	The interface ID.

This operation does not accept a request body and does not return a response body.

Keypairs (os-keypairs)

Generates, imports, and deletes SSH keys.

To add a keypair to a server, specify the key_name parameter in the request body in a create server request.

GET

/v2/{tenant_id}/os-keypairs

List keypairs

Lists keypairs that are associated with the account.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.

{
    "keypairs": [
        {
            "keypair": {
                "fingerprint": "15:b0:f8:b3:f9:48:63:71:cf:7b:5b:38:6d:44:2d:4a",
                "name": "keypair-601a2305-4f25-41ed-89c6-2a966fc8027a",
                "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQC+Eo/RZRngaGTkFs7I62ZjsIlO79KklKbMXi8F+KITD4bVQHHn+kV+4gRgkgCRbdoDqoGfpaDFs877DYX9n4z6FrAIZ4PES8TNKhatifpn9NdQYWA+IkU8CuvlEKGuFpKRi/k7JLos/gHi2hy7QUwgtRvcefvD/vgQZOVw/mGR9Q== Generated-by-Nova\n"
            }
        }
    ]
}

<?xml version='1.0' encoding='UTF-8'?>
<keypairs>
  <keypair>
    <public_key>ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQCWdUoGD7qz9kjbLoY2L0S5CdhUS8RvQ1g62OTgvmWE/bEKDLwaTIFEEpN/0huGk/nxvVZ6VOhv1eSKC3o9dZ2NDk0C4sBsrvJ41uWd1hbq72sDGzVEkJ+925CraioSAbMpRK5Ea7UPWbR8laqrY1TsKtcuxiGJ936bOPIXW12h6Q== Generated-by-Nova
</public_key>
    <name>keypair-a4c7d228-218b-4c4c-9d99-62e7878ebb1b</name>
    <fingerprint>62:32:23:67:56:ee:6f:51:4c:03:ce:b8:00:f9:41:ff</fingerprint>
  </keypair>
</keypairs>

This operation does not accept a request body.

POST

/v2/{tenant_id}/os-keypairs

Create or import keypair

Generates or imports a keypair.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
name	plain	xsd:string	The name to associate with the keypair.
public_key (Optional)	plain	xsd:string	The public ssh key to import. If not provided, a key is generated.

{
    "keypair": {
        "name": "keypair-dab428fe-6186-4a14-b3de-92131f76cd39",
        "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQDx8nkQv/zgGgB4rMYmIf+6A4l6Rr+o/6lHBQdW5aYd44bd8JttDCE/F/pNRr0lRE+PiqSPO8nDPHw0010JeMH9gYgnnFlyY3/OcJ02RhIPyyxYpv9FhY+2YiUkpwFOcLImyrxEsYXpD/0d3ac30bNH6Sw9JD9UZHYcpSxsIbECHw== Generated-by-Nova"
    }
}

<keypair>
    <name>keypair-96bbe50e-05e1-4d59-9115-4779a3ebcc2e</name>
    <public_key>ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQDx8nkQv/zgGgB4rMYmIf+6A4l6Rr+o/6lHBQdW5aYd44bd8JttDCE/F/pNRr0lRE+PiqSPO8nDPHw0010JeMH9gYgnnFlyY3/OcJ02RhIPyyxYpv9FhY+2YiUkpwFOcLImyrxEsYXpD/0d3ac30bNH6Sw9JD9UZHYcpSxsIbECHw== Generated-by-Nova</public_key>
</keypair>

{
    "keypair": {
        "fingerprint": "1e:2c:9b:56:79:4b:45:77:f9:ca:7a:98:2c:b0:d5:3c",
        "name": "keypair-dab428fe-6186-4a14-b3de-92131f76cd39",
        "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQDx8nkQv/zgGgB4rMYmIf+6A4l6Rr+o/6lHBQdW5aYd44bd8JttDCE/F/pNRr0lRE+PiqSPO8nDPHw0010JeMH9gYgnnFlyY3/OcJ02RhIPyyxYpv9FhY+2YiUkpwFOcLImyrxEsYXpD/0d3ac30bNH6Sw9JD9UZHYcpSxsIbECHw== Generated-by-Nova",
        "user_id": "fake"
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<keypair>
  <public_key>ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQDx8nkQv/zgGgB4rMYmIf+6A4l6Rr+o/6lHBQdW5aYd44bd8JttDCE/F/pNRr0lRE+PiqSPO8nDPHw0010JeMH9gYgnnFlyY3/OcJ02RhIPyyxYpv9FhY+2YiUkpwFOcLImyrxEsYXpD/0d3ac30bNH6Sw9JD9UZHYcpSxsIbECHw== Generated-by-Nova</public_key>
  <user_id>fake</user_id>
  <name>keypair-96bbe50e-05e1-4d59-9115-4779a3ebcc2e</name>
  <fingerprint>1e:2c:9b:56:79:4b:45:77:f9:ca:7a:98:2c:b0:d5:3c</fingerprint>
</keypair>

DELETE

/v2/{tenant_id}/os-keypairs/{keypair_name}

Delete keypair

Deletes a keypair.

Normal response codes

202

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
keypair_name	URI	xsd:string	The name associated with a keypair.

This operation does not accept a request body and does not return a response body.

GET

/v2/{tenant_id}/os-keypairs/{keypair_name}

Show keypair information

Shows a keypair associated with the account.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
keypair_name	URI	xsd:string	The name associated with a keypair.

{
    "keypair": {
        "created_at": "2014-05-07T12:06:13.681238",
        "deleted": false,
        "deleted_at": null,
        "fingerprint": "9d:00:f4:d7:26:6e:52:06:4c:c1:d3:1d:fd:06:66:01",
        "id": 1,
        "name": "keypair-3582d8b7-e588-4aad-b7f7-f4e76f0e4314",
        "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDYJrTVpcMwFqQy/oMvtUSRofZdSRHEwrsX8AYkRvn2ZnCXM+b6+GZ2NQuuWj+ocznlnwiGFQDsL/yeE+/kurqcPJFKKp60mToXIMyzioFxW88fJtwEWawHKAclbHWpR1t4fQ4DS+/sIbX/Yd9btlVQ2tpQjodGDbM9Tr9/+/3i6rcR+EoLqmbgCgAiGiVV6VbM2Zx79yUwd+GnQejHX8BlYZoOjCnt3NREsITcmWE9FVFy6TnLmahs3FkEO/QGgWGkaohAJlsgaVvSWGgDn2AujKYwyDokK3dXyeX3m2Vmc3ejiqPa/C4nRrCOlko5nSgV/9IXRx1ERImsqZnE9usB Generated-by-Nova\n",
        "updated_at": null,
        "user_id": "fake"
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<keypair>
   <public_key>ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDTWIBcXl7SSxGWOmzryHuYFYFQajo7uZXACg2juI92lRnQt1yy8aJ1710QZWaBlfluJYaOqBMccYXGxAR1vmZTONuW+lpBjRMqYgNG6ZC46p6z+Akp7Okbf1w1aqZ2rF2kq9OsjpU1x1SuB+xwC9stDv5MXEW2Gt/VPVcl3fVQLgvIoANhQPA5UJU5fRoeWgq0F/GCQtEGo7cQOQO3PC6IOshUPWAI/vRHt1dFGKnJjKJTkTbAuQkH2AnkMEWn6DvFFy8frBl3PwCYWnrResmOuPLvL5MG+Q5c1IrXpQm9ifTpEAstMalLJfHA0h5amQvIeWsj2y2yWyttcHoHg9K5 Generated-by-Nova</public_key>
   <user_id>fake</user_id>
   <name>keypair-8cabfb98-b13f-48cb-af1a-068b585eaaf5</name>
   <deleted>False</deleted>
   <created_at>2014-05-07 12:06:00.402696+00:00</created_at>
   <updated_at>None</updated_at>
   <fingerprint>ee:f5:79:02:69:af:ee:07:0f:ce:79:37:fd:5d:94:25</fingerprint>
   <deleted_at>None</deleted_at>
   <id>1</id>
</keypair>

This operation does not accept a request body.

Migrations (os-migrations)

Administrators only. Gets in-progress migrations for a region or specified cell in a region.

GET

/v2/{tenant_id}/os-migrations

Get migrations

Enables an administrative user to fetch in-progress migrations for a region or specified cell in a region.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
host (Optional)	query	xsd:string	Filters the response by host name. Include the host name in the URI as follows: `host={host}`.
status (Optional)	query	xsd:string	Filters the response by status. Include the status in the URI as follows: `status={status}`.
cell_name (Optional)	query	xsd:string	Filters the response by cell name. Include the cell name in the URI as follows: `cell_name={cell}`.

Response parameters

Parameter	Style	Type	Description
created_at	plain	xsd:string	The created at time stamp.
dest_compute	plain	xsd:string	The destination compute node.
dest_host	plain	xsd:string	The destination host.
id	plain	xsd:string	The migration ID.
instance_uuid	plain	csapi:uuid	The ID of the instance being migrated.
new_instance_type_id	plain	xsd:string	The ID of the new instance type.
old_instance_type_id	plain	xsd:string	The ID of the old instance type.
source_compute	plain	xsd:string	The source compute node.
source_node	plain	xsd:string	The source node.
status	plain	xsd:string	The migration status.
updated_at	plain	xsd:string	The updated at time stamp.

{
    "migrations": [
        {
            "created_at": "2012-10-29T13:42:02.000000",
            "dest_compute": "compute2",
            "dest_host": "1.2.3.4",
            "dest_node": "node2",
            "id": 1234,
            "instance_uuid": "instance_id_123",
            "new_instance_type_id": 2,
            "old_instance_type_id": 1,
            "source_compute": "compute1",
            "source_node": "node1",
            "status": "Done",
            "updated_at": "2012-10-29T13:42:02.000000"
        },
        {
            "created_at": "2013-10-22T13:42:02.000000",
            "dest_compute": "compute20",
            "dest_host": "5.6.7.8",
            "dest_node": "node20",
            "id": 5678,
            "instance_uuid": "instance_id_456",
            "new_instance_type_id": 6,
            "old_instance_type_id": 5,
            "source_compute": "compute10",
            "source_node": "node10",
            "status": "Done",
            "updated_at": "2013-10-22T13:42:02.000000"
        }
    ]
}

<?xml version='1.0' encoding='UTF-8'?>
<migrations>
  <migration dest_host="1.2.3.4" status="Done" old_instance_type_id="1" updated_at="2012-10-29 13:42:02" dest_compute="compute2" created_at="2012-10-29 13:42:02" source_node="node1" instance_uuid="instance_id_123" dest_node="node2" id="1234" new_instance_type_id="2" source_compute="compute1"/>
  <migration dest_host="5.6.7.8" status="Done" old_instance_type_id="5" updated_at="2013-10-22 13:42:02" dest_compute="compute20" created_at="2013-10-22 13:42:02" source_node="node10" instance_uuid="instance_id_456" dest_node="node20" id="5678" new_instance_type_id="6" source_compute="compute10"/>
</migrations>

This operation does not accept a request body.

Networks (os-networks)

Shows network information for and deletes networks. Also, disassociates a network from a project in VLAN mode.

POST

/v2/{tenant_id}

Create network

Creates a network.

Normal response codes

202

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The unique identifier of the tenant or account.
network	plain	csapi:dict	A dictionary representation of a network.
bridge (Optional)	plain	xsd:string	VIFs on this network are connected to this bridge.
bridge_interface (Optional)	plain	xsd:string	The bridge is connected to this interface.
broadcast (Optional)	plain	xsd:string	The broadcast address.
cidr (Optional)	plain	xsd:string	IPv4 subnet.
cidr_v6 (Optional)	plain	xsd:string	IPv6 subnet.
created_at (Optional)	plain	xsd:string	Created-at timestamp in ISO 8601 format.
deleted (Optional)	plain	xsd:bool	Deleted flag.
deleted_at (Optional)	plain	xsd:string	Deleted-at timestamp in ISO 8601 format.
dhcp_start (Optional)	plain	xsd:string	DHCP starting address.
dns1 (Optional)	plain	xsd:string	First DNS.
dns2 (Optional)	plain	xsd:string	Second DNS.
gateway (Optional)	plain	xsd:string	IPv4 gateway.
gateway_v6 (Optional)	plain	xsd:string	IPv6 gateway.
host (Optional)	plain	xsd:string	Network host.
id (Optional)	plain	csapi:uuid	The network ID.
injected (Optional)	plain	xsd:bool	Injected flag.
label	plain	xsd:string	Network label.
multi_host (Optional)	plain	xsd:string	Multi host.
netmask (Optional)	plain	xsd:string	The net mask.
netmask_v6 (Optional)	plain	xsd:string	The IPv6 net mask.
priority (Optional)	plain	xsd:int	Network priority.
project_id (Optional)	plain	xsd:string	Project ID.
rxtx_base (Optional)	plain	xsd:string	RXTX base factor value for the network.
updated_at (Optional)	plain	xsd:string	Updated-at timestamp in ISO 8601 format.
vlan (Optional)	plain	csapi:UUID	VLAN ID.
vpn_private_address (Optional)	plain	csapi:UUID	VPN private address.
vpn_public_address (Optional)	plain	csapi:UUID	VPN public address.
vpn_public_port (Optional)	plain	csapi:UUID	VPN public port.

Response parameters

Parameter	Style	Type	Description
network	plain	csapi:dict	A dictionary representation of a network.
bridge	plain	xsd:string	VIFs on this network are connected to this bridge.
bridge_interface	plain	xsd:string	The bridge is connected to this interface.
broadcast (Optional)	plain	xsd:string	The broadcast address.
cidr	plain	xsd:string	IPv4 subnet.
cidr_v6	plain	xsd:string	IPv6 subnet.
created_at	plain	xsd:string	Created-at timestamp in ISO 8601 format.
deleted	plain	xsd:bool	Deleted flag.
deleted_at	plain	xsd:string	Deleted-at timestamp in ISO 8601 format.
dhcp_start	plain	xsd:string	DHCP starting address.
dns1	plain	xsd:string	First DNS.
dns2	plain	xsd:string	Second DNS.
gateway	plain	xsd:string	IPv4 gateway.
gateway_v6	plain	xsd:string	IPv6 gateway.
host	plain	xsd:string	Network host.
id	plain	csapi:uuid	The network ID.
injected	plain	xsd:bool	Injected flag.
label	plain	xsd:string	Network label.
multi_host	plain	xsd:string	Multi host.
netmask	plain	xsd:string	The net mask.
netmask_v6	plain	xsd:string	The IPv6 net mask.
priority	plain	xsd:int	Network priority.
project_id	plain	xsd:string	Project id.
rxtx_base	plain	xsd:string	RXTX base factor value for the network.
updated_at	plain	xsd:string	Updated-at timestamp in ISO 8601 format.
vlan	plain	csapi:UUID	VLAN ID.
vpn_private_address	plain	csapi:UUID	VPN private address.
vpn_public_address	plain	csapi:UUID	VPN public address.
vpn_public_port	plain	csapi:UUID	VPN public port.

{
    "network": {
        "label": "new net 111",
        "cidr": "10.20.105.0/24"
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<network>
    <label>new net 111</label>
    <cidr>10.20.105.0/24</cidr>
</network>

{
    "network": {
        "bridge": null,
        "bridge_interface": null,
        "broadcast": "10.20.105.255",
        "cidr": "10.20.105.0/24",
        "cidr_v6": null,
        "created_at": null,
        "deleted": null,
        "deleted_at": null,
        "dhcp_start": "10.20.105.2",
        "dns1": null,
        "dns2": null,
        "gateway": "10.20.105.1",
        "gateway_v6": null,
        "host": null,
        "id": "668687f9-d724-4976-a6f4-a6fd3ad83da3",
        "injected": null,
        "label": "new net 111",
        "multi_host": null,
        "netmask": "255.255.255.0",
        "netmask_v6": null,
        "priority": null,
        "project_id": null,
        "rxtx_base": null,
        "updated_at": null,
        "vlan": null,
        "vpn_private_address": null,
        "vpn_public_address": null,
        "vpn_public_port": null
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<network>
  <bridge>None</bridge>
  <vpn_public_port>None</vpn_public_port>
  <dhcp_start>10.20.105.2</dhcp_start>
  <bridge_interface>None</bridge_interface>
  <updated_at>None</updated_at>
  <id>1bbbed2b-0daa-47a1-b869-1981c29150b1</id>
  <cidr_v6>None</cidr_v6>
  <deleted_at>None</deleted_at>
  <gateway>10.20.105.1</gateway>
  <rxtx_base>None</rxtx_base>
  <label>new net 111</label>
  <priority>None</priority>
  <project_id>None</project_id>
  <vpn_private_address>None</vpn_private_address>
  <deleted>False</deleted>
  <vlan>None</vlan>
  <broadcast>10.20.105.255</broadcast>
  <netmask>255.255.255.0</netmask>
  <injected>None</injected>
  <cidr>10.20.105.0/24</cidr>
  <vpn_public_address>None</vpn_public_address>
  <multi_host>None</multi_host>
  <dns2>None</dns2>
  <created_at>None</created_at>
  <host>None</host>
  <gateway_v6>None</gateway_v6>
  <netmask_v6>None</netmask_v6>
  <dns1>None</dns1>
</network>

GET

/v2/{tenant_id}/os-networks

List networks

Lists networks that are available to the tenant.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The unique identifier of the tenant or account.

Response parameters

Parameter	Style	Type	Description
network	plain	csapi:dict	A dictionary representation of a network.
bridge	plain	xsd:string	VIFs on this network are connected to this bridge.
bridge_interface	plain	xsd:string	The bridge is connected to this interface.
broadcast (Optional)	plain	xsd:string	The broadcast address.
cidr	plain	xsd:string	IPv4 subnet.
cidr_v6	plain	xsd:string	IPv6 subnet.
created_at	plain	xsd:string	Created-at timestamp in ISO 8601 format.
deleted	plain	xsd:bool	Deleted flag.
deleted_at	plain	xsd:string	Deleted-at timestamp in ISO 8601 format.
dhcp_start	plain	xsd:string	DHCP starting address.
dns1	plain	xsd:string	First DNS.
dns2	plain	xsd:string	Second DNS.
gateway	plain	xsd:string	IPv4 gateway.
gateway_v6	plain	xsd:string	IPv6 gateway.
host	plain	xsd:string	Network host.
id	plain	csapi:uuid	The network ID.
injected	plain	xsd:bool	Injected flag.
label	plain	xsd:string	Network label.
multi_host	plain	xsd:string	Multi host.
netmask	plain	xsd:string	The net mask.
netmask_v6	plain	xsd:string	The IPv6 net mask.
priority	plain	xsd:int	Network priority.
project_id	plain	xsd:string	Project id.
rxtx_base	plain	xsd:string	RXTX base factor value for the network.
updated_at	plain	xsd:string	Updated-at timestamp in ISO 8601 format.
vlan	plain	csapi:UUID	VLAN ID.
vpn_private_address	plain	csapi:UUID	VPN private address.
vpn_public_address	plain	csapi:UUID	VPN public address.
vpn_public_port	plain	csapi:UUID	VPN public port.

{
    "networks": [
        {
            "bridge": "br100",
            "bridge_interface": "eth0",
            "broadcast": "10.0.0.7",
            "cidr": "10.0.0.0/29",
            "cidr_v6": null,
            "created_at": "2011-08-15T06:19:19.387525",
            "deleted": false,
            "deleted_at": null,
            "dhcp_start": "10.0.0.3",
            "dns1": null,
            "dns2": null,
            "gateway": "10.0.0.1",
            "gateway_v6": null,
            "host": "nsokolov-desktop",
            "id": "20c8acc0-f747-4d71-a389-46d078ebf047",
            "injected": false,
            "label": "mynet_0",
            "multi_host": false,
            "netmask": "255.255.255.248",
            "netmask_v6": null,
            "priority": null,
            "project_id": "1234",
            "rxtx_base": null,
            "updated_at": "2011-08-16T09:26:13.048257",
            "vlan": 100,
            "vpn_private_address": "10.0.0.2",
            "vpn_public_address": "127.0.0.1",
            "vpn_public_port": 1000
        },
        {
            "bridge": "br101",
            "bridge_interface": "eth0",
            "broadcast": "10.0.0.15",
            "cidr": "10.0.0.10/29",
            "cidr_v6": null,
            "created_at": "2011-08-15T06:19:19.885495",
            "deleted": false,
            "deleted_at": null,
            "dhcp_start": "10.0.0.11",
            "dns1": null,
            "dns2": null,
            "gateway": "10.0.0.9",
            "gateway_v6": null,
            "host": null,
            "id": "20c8acc0-f747-4d71-a389-46d078ebf000",
            "injected": false,
            "label": "mynet_1",
            "multi_host": false,
            "netmask": "255.255.255.248",
            "netmask_v6": null,
            "priority": null,
            "project_id": null,
            "rxtx_base": null,
            "updated_at": null,
            "vlan": 101,
            "vpn_private_address": "10.0.0.10",
            "vpn_public_address": null,
            "vpn_public_port": 1001
        }
    ]
}

<?xml version='1.0' encoding='UTF-8'?>
<networks>
  <network>
    <bridge>br100</bridge>
    <vpn_public_port>1000</vpn_public_port>
    <dhcp_start>10.0.0.3</dhcp_start>
    <bridge_interface>eth0</bridge_interface>
    <updated_at>2011-08-16 09:26:13.048257</updated_at>
    <id>20c8acc0-f747-4d71-a389-46d078ebf047</id>
    <cidr_v6>None</cidr_v6>
    <deleted_at>None</deleted_at>
    <gateway>10.0.0.1</gateway>
    <rxtx_base>None</rxtx_base>
    <label>mynet_0</label>
    <priority>None</priority>
    <project_id>1234</project_id>
    <vpn_private_address>10.0.0.2</vpn_private_address>
    <deleted>False</deleted>
    <vlan>100</vlan>
    <broadcast>10.0.0.7</broadcast>
    <netmask>255.255.255.248</netmask>
    <injected>False</injected>
    <cidr>10.0.0.0/29</cidr>
    <vpn_public_address>127.0.0.1</vpn_public_address>
    <multi_host>False</multi_host>
    <dns2>None</dns2>
    <created_at>2011-08-15 06:19:19.387525</created_at>
    <host>nsokolov-desktop</host>
    <gateway_v6>None</gateway_v6>
    <netmask_v6>None</netmask_v6>
    <dns1>None</dns1>
  </network>
  <network>
    <bridge>br101</bridge>
    <vpn_public_port>1001</vpn_public_port>
    <dhcp_start>10.0.0.11</dhcp_start>
    <bridge_interface>eth0</bridge_interface>
    <updated_at>None</updated_at>
    <id>20c8acc0-f747-4d71-a389-46d078ebf000</id>
    <cidr_v6>None</cidr_v6>
    <deleted_at>None</deleted_at>
    <gateway>10.0.0.9</gateway>
    <rxtx_base>None</rxtx_base>
    <label>mynet_1</label>
    <priority>None</priority>
    <project_id>None</project_id>
    <vpn_private_address>10.0.0.10</vpn_private_address>
    <deleted>False</deleted>
    <vlan>101</vlan>
    <broadcast>10.0.0.15</broadcast>
    <netmask>255.255.255.248</netmask>
    <injected>False</injected>
    <cidr>10.0.0.10/29</cidr>
    <vpn_public_address>None</vpn_public_address>
    <multi_host>False</multi_host>
    <dns2>None</dns2>
    <created_at>2011-08-15 06:19:19.885495</created_at>
    <host>None</host>
    <gateway_v6>None</gateway_v6>
    <netmask_v6>None</netmask_v6>
    <dns1>None</dns1>
  </network>
</networks>

This operation does not accept a request body.

POST

/v2/{tenant_id}/os-networks/add

Add network

Adds a specified network to a project.

Normal response codes

202

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The unique identifier of the tenant or account.
id	URI	csapi:uuid	The UUID of the network to add to the project. Specify `None` to choose a random available network.

{
    "id": "1"
}

<?xml version='1.0' encoding='UTF-8'?>
<id>1</id>

This operation does not return a response body.

GET

/v2/{tenant_id}/os-networks/{id}

Show network information

Shows information for a specified network.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The unique identifier of the tenant or account.
id	URI	csapi:UUID	The unique identifier associated with the network.

Response parameters

Parameter	Style	Type	Description
network	plain	csapi:dict	A dictionary representation of a network.
bridge	plain	xsd:string	VIFs on this network are connected to this bridge.
bridge_interface	plain	xsd:string	The bridge is connected to this interface.
broadcast (Optional)	plain	xsd:string	The broadcast address.
cidr	plain	xsd:string	IPv4 subnet.
cidr_v6	plain	xsd:string	IPv6 subnet.
created_at	plain	xsd:string	Created-at timestamp in ISO 8601 format.
deleted	plain	xsd:bool	Deleted flag.
deleted_at	plain	xsd:string	Deleted-at timestamp in ISO 8601 format.
dhcp_start	plain	xsd:string	DHCP starting address.
dns1	plain	xsd:string	First DNS.
dns2	plain	xsd:string	Second DNS.
gateway	plain	xsd:string	IPv4 gateway.
gateway_v6	plain	xsd:string	IPv6 gateway.
host	plain	xsd:string	Network host.
id	plain	csapi:uuid	The network ID.
injected	plain	xsd:bool	Injected flag.
label	plain	xsd:string	Network label.
multi_host	plain	xsd:string	Multi host.
netmask	plain	xsd:string	The net mask.
netmask_v6	plain	xsd:string	The IPv6 net mask.
priority	plain	xsd:int	Network priority.
project_id	plain	xsd:string	Project id.
rxtx_base	plain	xsd:string	RXTX base factor value for the network.
updated_at	plain	xsd:string	Updated-at timestamp in ISO 8601 format.
vlan	plain	csapi:UUID	VLAN ID.
vpn_private_address	plain	csapi:UUID	VPN private address.
vpn_public_address	plain	csapi:UUID	VPN public address.
vpn_public_port	plain	csapi:UUID	VPN public port.

{
    "network": {
        "bridge": "br100",
        "bridge_interface": "eth0",
        "broadcast": "10.0.0.7",
        "cidr": "10.0.0.0/29",
        "cidr_v6": null,
        "created_at": "2011-08-15T06:19:19.387525",
        "deleted": false,
        "deleted_at": null,
        "dhcp_start": "10.0.0.3",
        "dns1": null,
        "dns2": null,
        "gateway": "10.0.0.1",
        "gateway_v6": null,
        "host": "nsokolov-desktop",
        "id": "20c8acc0-f747-4d71-a389-46d078ebf047",
        "injected": false,
        "label": "mynet_0",
        "multi_host": false,
        "netmask": "255.255.255.248",
        "netmask_v6": null,
        "priority": null,
        "project_id": "1234",
        "rxtx_base": null,
        "updated_at": "2011-08-16T09:26:13.048257",
        "vlan": 100,
        "vpn_private_address": "10.0.0.2",
        "vpn_public_address": "127.0.0.1",
        "vpn_public_port": 1000
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<network>
  <bridge>br100</bridge>
  <vpn_public_port>1000</vpn_public_port>
  <dhcp_start>10.0.0.3</dhcp_start>
  <bridge_interface>eth0</bridge_interface>
  <updated_at>2011-08-16 09:26:13.048257</updated_at>
  <id>20c8acc0-f747-4d71-a389-46d078ebf047</id>
  <cidr_v6>None</cidr_v6>
  <deleted_at>None</deleted_at>
  <gateway>10.0.0.1</gateway>
  <rxtx_base>None</rxtx_base>
  <label>mynet_0</label>
  <priority>None</priority>
  <project_id>1234</project_id>
  <vpn_private_address>10.0.0.2</vpn_private_address>
  <deleted>False</deleted>
  <vlan>100</vlan>
  <broadcast>10.0.0.7</broadcast>
  <netmask>255.255.255.248</netmask>
  <injected>False</injected>
  <cidr>10.0.0.0/29</cidr>
  <vpn_public_address>127.0.0.1</vpn_public_address>
  <multi_host>False</multi_host>
  <dns2>None</dns2>
  <created_at>2011-08-15 06:19:19.387525</created_at>
  <host>nsokolov-desktop</host>
  <gateway_v6>None</gateway_v6>
  <netmask_v6>None</netmask_v6>
  <dns1>None</dns1>
</network>

This operation does not accept a request body.

DELETE

/v2/{tenant_id}/os-networks/{id}

Delete network

Deletes a specified network.

Normal response codes

202

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The unique identifier of the tenant or account.
id	URI	csapi:UUID	The unique identifier associated with the network.

This operation does not accept a request body and does not return a response body.

POST

/v2/{tenant_id}/os-networks/{id}/action

Associate host

Associates a specified network with a host.

Normal response codes

202

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The unique identifier of the tenant or account.
id	URI	csapi:UUID	The unique identifier associated with the network.

{
    "associate_host": "testHost"
}

<?xml version='1.0' encoding='UTF-8'?>
<associate_host>testHost</associate_host>

This operation does not return a response body.

POST

/v2/{tenant_id}/os-networks/{id}/action

Disassociate host

Disassociates the host from a specified network.

Normal response codes

202

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The unique identifier of the tenant or account.
id	URI	csapi:UUID	The unique identifier associated with the network.

{
    "disassociate_host": null
}

<disassociate_host/>

This operation does not return a response body.

POST

/v2/{tenant_id}/os-networks/{id}/action

Disassociate network

Disassociates a specified network from a project so that the network can be reused.

Normal response codes

202

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The unique identifier of the tenant or account.
id	URI	csapi:UUID	The unique identifier associated with the network.

{
    "disassociate": null
}

<disassociate/>

This operation does not return a response body.

POST

/v2/{tenant_id}/os-networks/{id}/action

Disassociate project

Disassociates the project from a specified network.

Normal response codes

202

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The unique identifier of the tenant or account.
id	URI	csapi:UUID	The unique identifier associated with the network.

{
    "disassociate_project": null
}

<disassociate_project/>

This operation does not return a response body.

Quota class (os-quota-class-sets)

Provides quota classes management support.

GET

/v2/os-quota-class-sets/{class_id}

Show quota

Shows the quota for a specified class.

Normal response codes

200

Error response codes

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

{
    "quota_class_set": {
        "cores": 20,
        "fixed_ips": -1,
        "floating_ips": 10,
        "id": "test_class",
        "injected_file_content_bytes": 10240,
        "injected_file_path_bytes": 255,
        "injected_files": 5,
        "instances": 10,
        "key_pairs": 100,
        "metadata_items": 128,
        "ram": 51200,
        "security_group_rules": 20,
        "security_groups": 10,
        "server_group_members": 10,
        "server_groups": 10
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<quota_class_set id="test_class">
  <cores>20</cores>
  <fixed_ips>-1</fixed_ips>
  <floating_ips>10</floating_ips>
  <injected_file_content_bytes>10240</injected_file_content_bytes>
  <injected_file_path_bytes>255</injected_file_path_bytes>
  <injected_files>5</injected_files>
  <instances>10</instances>
  <key_pairs>100</key_pairs>
  <metadata_items>128</metadata_items>
  <ram>51200</ram>
  <security_group_rules>20</security_group_rules>
  <security_groups>10</security_groups>
  <server_groups>10</server_groups>
  <server_group_members>10</server_group_members>
</quota_class_set>

PUT

/v2/os-quota-class-sets/{class_id}

Update quota

Updates quota for a specified class.

Normal response codes

200

Error response codes

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

{
    "quota_class_set": {
        "instances": 50,
        "cores": 50,
        "ram": 51200,
        "floating_ips": 10,
        "metadata_items": 128,
        "injected_files": 5,
        "injected_file_content_bytes": 10240,
        "injected_file_path_bytes": 255,
        "security_groups": 10,
        "security_group_rules": 20,
        "key_pairs": 100,
        "server_groups": 10,
        "server_group_members": 10
    }
}

<?xml version="1.0" encoding="UTF-8" ?>
<quota_class_set>
  <cores>50</cores>
  <floating_ips>10</floating_ips>
  <injected_file_content_bytes>10240</injected_file_content_bytes>
  <injected_file_path_bytes>255</injected_file_path_bytes>
  <injected_files>5</injected_files>
  <instances>50</instances>
  <key_pairs>100</key_pairs>
  <metadata_items>128</metadata_items>
  <ram>51200</ram>
  <security_group_rules>20</security_group_rules>
  <security_groups>10</security_groups>
  <server_groups>10</server_groups>
  <server_group_members>10</server_group_members>
</quota_class_set>

{
    "quota_class_set": {
        "cores": 50,
        "fixed_ips": -1,
        "floating_ips": 10,
        "injected_file_content_bytes": 10240,
        "injected_file_path_bytes": 255,
        "injected_files": 5,
        "instances": 50,
        "key_pairs": 100,
        "metadata_items": 128,
        "ram": 51200,
        "security_group_rules": 20,
        "security_groups": 10,
        "server_groups": 10,
        "server_group_members": 10
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<quota_class_set>
  <cores>50</cores>
  <fixed_ips>-1</fixed_ips>
  <floating_ips>10</floating_ips>
  <injected_file_content_bytes>10240</injected_file_content_bytes>
  <injected_file_path_bytes>255</injected_file_path_bytes>
  <injected_files>5</injected_files>
  <instances>50</instances>
  <key_pairs>100</key_pairs>
  <metadata_items>128</metadata_items>
  <ram>51200</ram>
  <security_group_rules>20</security_group_rules>
  <security_groups>10</security_groups>
  <server_groups>10</server_groups>
  <server_group_members>10</server_group_members>
</quota_class_set>

Quota sets (os-quota-sets)

Administrators only, depending on policy settings.

Shows quotas for a tenant and shows and updates default quotas.

GET

/v2/{tenant_id}/os-quota-sets/{tenant_id}

Show quotas

Shows quotas for a tenant.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or project in a multi-tenancy cloud.
tenant_id	URI	xsd:string	The ID for the tenant for which you want to show, update, or delete quotas. This ID is different from the first tenant ID that you specify in the URI: That ID is for the admin tenant.

Response parameters

Parameter	Style	Type	Description
quota_set	plain	xsd:string	A quota_set object.
cores	plain	xsd:int	The number of instance cores allowed for each tenant.
fixed_ips	plain	xsd:int	The number of fixed IP addresses allowed for each tenant. Must be equal to or greater than the number of allowed instances.
floating_ips	plain	xsd:int	The number of floating IP addresses allowed for each tenant.
id	plain	xsd:int	The ID for the quota set.
injected_file_content_bytes	plain	xsd:int	The number of bytes of content allowed for each injected file.
injected_file_path_bytes	plain	xsd:int	The number of bytes allowed for each injected file path.
injected_files	plain	xsd:int	The number of injected files allowed for each tenant.
instances	plain	xsd:int	The number of instances allowed for each tenant.
key_pairs	plain	xsd:int	The number of key pairs allowed for each user.
metadata_items	plain	xsd:int	The number of metadata items allowed for each instance.
ram	plain	xsd:int	The amount of instance RAM in megabytes allowed for each tenant.
security_group_rules (Optional)	plain	xsd:int	The number of rules allowed for each security group.
security_groups	plain	xsd:int	The number of security groups allowed for each tenant.
server_groups	plain	xsd:int	The number of server groups allowed for each tenant.
server_group_members	plain	xsd:int	The number of members allowed for each server group.

{
    "quota_set": {
        "cores": 20,
        "fixed_ips": -1,
        "floating_ips": 10,
        "id": "fake_tenant",
        "injected_file_content_bytes": 10240,
        "injected_file_path_bytes": 255,
        "injected_files": 5,
        "instances": 10,
        "key_pairs": 100,
        "metadata_items": 128,
        "ram": 51200,
        "security_group_rules": 20,
        "security_groups": 10,
        "server_group_members": 10,
        "server_groups": 10
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<quota_set id="fake_tenant">
  <cores>20</cores>
  <fixed_ips>-1</fixed_ips>
  <floating_ips>10</floating_ips>
  <injected_file_content_bytes>10240</injected_file_content_bytes>
  <injected_file_path_bytes>255</injected_file_path_bytes>
  <injected_files>5</injected_files>
  <instances>10</instances>
  <key_pairs>100</key_pairs>
  <metadata_items>128</metadata_items>
  <ram>51200</ram>
  <security_group_rules>20</security_group_rules>
  <security_groups>10</security_groups>
  <server_groups>10</server_groups>
  <server_group_members>10</server_group_members>
</quota_set>

This operation does not accept a request body.

PUT

/v2/{tenant_id}/os-quota-sets/{tenant_id}

Update quotas

Updates quotas for a tenant.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or project in a multi-tenancy cloud.
tenant_id	URI	xsd:string	The ID for the tenant for which you want to show, update, or delete quotas. This ID is different from the first tenant ID that you specify in the URI: That ID is for the admin tenant.
quota_set	plain	xsd:string	A quota_set object.
cores (Optional)	plain	xsd:int	The number of instance cores allowed for each tenant.
fixed_ips (Optional)	plain	xsd:int	The number of fixed IP addresses allowed for each tenant. Must be equal to or greater than the number of allowed instances.
floating_ips (Optional)	plain	xsd:int	The number of floating IP addresses allowed for each tenant.
id (Optional)	plain	xsd:int	The ID for the quota set.
injected_file_content_bytes (Optional)	plain	xsd:int	The number of bytes of content allowed for each injected file.
injected_file_path_bytes (Optional)	plain	xsd:int	The number of bytes allowed for each injected file path.
injected_files (Optional)	plain	xsd:int	The number of injected files allowed for each tenant.
instances (Optional)	plain	xsd:int	The number of instances allowed for each tenant.
key_pairs (Optional)	plain	xsd:int	The number of key pairs allowed for each user.
metadata_items (Optional)	plain	xsd:int	The number of metadata items allowed for each instance.
ram (Optional)	plain	xsd:int	The amount of instance RAM in megabytes allowed for each tenant.
security_group_rules (Optional)	plain	xsd:int	The number of rules allowed for each security group.
security_groups (Optional)	plain	xsd:int	The number of security groups allowed for each tenant.
server_groups (Optional)	plain	xsd:int	The number of server groups allowed for each tenant.
server_group_members (Optional)	plain	xsd:int	The number of members allowed for each server group.

Response parameters

Parameter	Style	Type	Description
quota_set	plain	xsd:string	A quota_set object.
cores	plain	xsd:int	The number of instance cores allowed for each tenant.
fixed_ips	plain	xsd:int	The number of fixed IP addresses allowed for each tenant. Must be equal to or greater than the number of allowed instances.
floating_ips	plain	xsd:int	The number of floating IP addresses allowed for each tenant.
id	plain	xsd:int	The ID for the quota set.
injected_file_content_bytes	plain	xsd:int	The number of bytes of content allowed for each injected file.
injected_file_path_bytes	plain	xsd:int	The number of bytes allowed for each injected file path.
injected_files	plain	xsd:int	The number of injected files allowed for each tenant.
instances	plain	xsd:int	The number of instances allowed for each tenant.
key_pairs	plain	xsd:int	The number of key pairs allowed for each user.
metadata_items	plain	xsd:int	The number of metadata items allowed for each instance.
ram	plain	xsd:int	The amount of instance RAM in megabytes allowed for each tenant.
security_group_rules (Optional)	plain	xsd:int	The number of rules allowed for each security group.
security_groups	plain	xsd:int	The number of security groups allowed for each tenant.
server_groups	plain	xsd:int	The number of server groups allowed for each tenant.
server_group_members	plain	xsd:int	The number of members allowed for each server group.

{
    "quota_set": {
        "security_groups": 45
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<quota_set id="fake_tenant">
  <security_groups>45</security_groups>
</quota_set>

{
    "quota_set": {
        "cores": 20,
        "fixed_ips": -1,
        "floating_ips": 10,
        "injected_file_content_bytes": 10240,
        "injected_file_path_bytes": 255,
        "injected_files": 5,
        "instances": 10,
        "key_pairs": 100,
        "metadata_items": 128,
        "ram": 51200,
        "security_group_rules": 20,
        "security_groups": 45,
        "server_group_members": 10,
        "server_groups": 10
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<quota_set>
  <cores>20</cores>
  <fixed_ips>-1</fixed_ips>
  <floating_ips>10</floating_ips>
  <injected_file_content_bytes>10240</injected_file_content_bytes>
  <injected_file_path_bytes>255</injected_file_path_bytes>
  <injected_files>5</injected_files>
  <instances>10</instances>
  <key_pairs>100</key_pairs>
  <metadata_items>128</metadata_items>
  <ram>51200</ram>
  <security_group_rules>20</security_group_rules>
  <security_groups>45</security_groups>
  <server_groups>10</server_groups>
  <server_group_members>10</server_group_members>
</quota_set>

DELETE

/v2/{tenant_id}/os-quota-sets/{tenant_id}

Delete quotas

Deletes quotas for a tenant so the quotas revert to default values.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or project in a multi-tenancy cloud.
tenant_id	URI	xsd:string	The ID for the tenant for which you want to show, update, or delete quotas. This ID is different from the first tenant ID that you specify in the URI: That ID is for the admin tenant.

This operation does not accept a request body and does not return a response body.

GET

/v2/{tenant_id}/os-quota-sets/{tenant_id}/defaults

Get default quotas

Gets default quotas for a tenant.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or project in a multi-tenancy cloud.
tenant_id	URI	xsd:string	The ID for the tenant for which you want to show, update, or delete quotas. This ID is different from the first tenant ID that you specify in the URI: That ID is for the admin tenant.

Response parameters

Parameter	Style	Type	Description
quota_set	plain	xsd:string	A quota_set object.
cores	plain	xsd:int	The number of instance cores allowed for each tenant.
fixed_ips	plain	xsd:int	The number of fixed IP addresses allowed for each tenant. Must be equal to or greater than the number of allowed instances.
floating_ips	plain	xsd:int	The number of floating IP addresses allowed for each tenant.
id	plain	xsd:int	The ID for the quota set.
injected_file_content_bytes	plain	xsd:int	The number of bytes of content allowed for each injected file.
injected_file_path_bytes	plain	xsd:int	The number of bytes allowed for each injected file path.
injected_files	plain	xsd:int	The number of injected files allowed for each tenant.
instances	plain	xsd:int	The number of instances allowed for each tenant.
key_pairs	plain	xsd:int	The number of key pairs allowed for each user.
metadata_items	plain	xsd:int	The number of metadata items allowed for each instance.
ram	plain	xsd:int	The amount of instance RAM in megabytes allowed for each tenant.
security_group_rules (Optional)	plain	xsd:int	The number of rules allowed for each security group.
security_groups	plain	xsd:int	The number of security groups allowed for each tenant.
server_groups	plain	xsd:int	The number of server groups allowed for each tenant.
server_group_members	plain	xsd:int	The number of members allowed for each server group.

{
    "quota_set": {
        "cores": 20,
        "fixed_ips": -1,
        "floating_ips": 10,
        "id": "fake_tenant",
        "injected_file_content_bytes": 10240,
        "injected_file_path_bytes": 255,
        "injected_files": 5,
        "instances": 10,
        "key_pairs": 100,
        "metadata_items": 128,
        "ram": 51200,
        "security_group_rules": 20,
        "security_groups": 10,
        "server_group_members": 10,
        "server_groups": 10
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<quota_set id="fake_tenant">
  <cores>20</cores>
  <fixed_ips>-1</fixed_ips>
  <floating_ips>10</floating_ips>
  <injected_file_content_bytes>10240</injected_file_content_bytes>
  <injected_file_path_bytes>255</injected_file_path_bytes>
  <injected_files>5</injected_files>
  <instances>10</instances>
  <key_pairs>100</key_pairs>
  <metadata_items>128</metadata_items>
  <ram>51200</ram>
  <security_group_rules>20</security_group_rules>
  <security_groups>10</security_groups>
  <server_groups>10</server_groups>
  <server_group_members>10</server_group_members>
</quota_set>

This operation does not accept a request body.

GET

/v2/{tenant_id}/os-quota-sets/{tenant_id}/{user_id}

Show quotas for user

Enables an admin user to show quotas for a specified tenant and user.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or project in a multi-tenancy cloud.
tenant_id	URI	xsd:string	The ID for the tenant for which you want to show, update, or delete quotas. This ID is different from the first tenant ID that you specify in the URI: That ID is for the admin tenant.
user_id	URI	xsd:string	The user ID. Specify in the URI as a query string: `user_id={user_id}`.

Response parameters

Parameter	Style	Type	Description
quota_set	plain	xsd:string	A quota_set object.
cores	plain	xsd:int	The number of instance cores allowed for each tenant.
fixed_ips	plain	xsd:int	The number of fixed IP addresses allowed for each tenant. Must be equal to or greater than the number of allowed instances.
floating_ips	plain	xsd:int	The number of floating IP addresses allowed for each tenant.
id	plain	xsd:int	The ID for the quota set.
injected_file_content_bytes	plain	xsd:int	The number of bytes of content allowed for each injected file.
injected_file_path_bytes	plain	xsd:int	The number of bytes allowed for each injected file path.
injected_files	plain	xsd:int	The number of injected files allowed for each tenant.
instances	plain	xsd:int	The number of instances allowed for each tenant.
key_pairs	plain	xsd:int	The number of key pairs allowed for each user.
metadata_items	plain	xsd:int	The number of metadata items allowed for each instance.
ram	plain	xsd:int	The amount of instance RAM in megabytes allowed for each tenant.
security_group_rules (Optional)	plain	xsd:int	The number of rules allowed for each security group.
security_groups	plain	xsd:int	The number of security groups allowed for each tenant.
server_groups	plain	xsd:int	The number of server groups allowed for each tenant.
server_group_members	plain	xsd:int	The number of members allowed for each server group.

{
    "quota_set": {
        "cores": 20,
        "fixed_ips": -1,
        "floating_ips": 10,
        "id": "fake_tenant",
        "injected_file_content_bytes": 10240,
        "injected_file_path_bytes": 255,
        "injected_files": 5,
        "instances": 10,
        "key_pairs": 100,
        "metadata_items": 128,
        "ram": 51200,
        "security_group_rules": 20,
        "security_groups": 10
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<quota_set id="fake_tenant">
  <cores>20</cores>
  <fixed_ips>-1</fixed_ips>
  <floating_ips>10</floating_ips>
  <injected_file_content_bytes>10240</injected_file_content_bytes>
  <injected_file_path_bytes>255</injected_file_path_bytes>
  <injected_files>5</injected_files>
  <instances>10</instances>
  <key_pairs>100</key_pairs>
  <metadata_items>128</metadata_items>
  <ram>51200</ram>
  <security_group_rules>20</security_group_rules>
  <security_groups>10</security_groups>
</quota_set>

This operation does not accept a request body.

POST

/v2/{tenant_id}/os-quota-sets/{tenant_id}/{user_id}

Update quotas for user

Updates quotas for a specified tenant/project and user.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or project in a multi-tenancy cloud.
tenant_id	URI	xsd:string	The ID for the tenant for which you want to show, update, or delete quotas. This ID is different from the first tenant ID that you specify in the URI: That ID is for the admin tenant.
user_id	URI	xsd:string	The user ID. Specify in the URI as a query string: `user_id={user_id}`.
quota_set	plain	xsd:string	A quota_set object.
cores (Optional)	plain	xsd:int	The number of instance cores allowed for each tenant.
fixed_ips (Optional)	plain	xsd:int	The number of fixed IP addresses allowed for each tenant. Must be equal to or greater than the number of allowed instances.
floating_ips (Optional)	plain	xsd:int	The number of floating IP addresses allowed for each tenant.
id (Optional)	plain	xsd:int	The ID for the quota set.
injected_file_content_bytes (Optional)	plain	xsd:int	The number of bytes of content allowed for each injected file.
injected_file_path_bytes (Optional)	plain	xsd:int	The number of bytes allowed for each injected file path.
injected_files (Optional)	plain	xsd:int	The number of injected files allowed for each tenant.
instances (Optional)	plain	xsd:int	The number of instances allowed for each tenant.
key_pairs (Optional)	plain	xsd:int	The number of key pairs allowed for each user.
metadata_items (Optional)	plain	xsd:int	The number of metadata items allowed for each instance.
ram (Optional)	plain	xsd:int	The amount of instance RAM in megabytes allowed for each tenant.
security_group_rules (Optional)	plain	xsd:int	The number of rules allowed for each security group.
security_groups (Optional)	plain	xsd:int	The number of security groups allowed for each tenant.
server_groups (Optional)	plain	xsd:int	The number of server groups allowed for each tenant.
server_group_members (Optional)	plain	xsd:int	The number of members allowed for each server group.

Response parameters

Parameter	Style	Type	Description
quota_set	plain	xsd:string	A quota_set object.
cores	plain	xsd:int	The number of instance cores allowed for each tenant.
fixed_ips	plain	xsd:int	The number of fixed IP addresses allowed for each tenant. Must be equal to or greater than the number of allowed instances.
floating_ips	plain	xsd:int	The number of floating IP addresses allowed for each tenant.
id	plain	xsd:int	The ID for the quota set.
injected_file_content_bytes	plain	xsd:int	The number of bytes of content allowed for each injected file.
injected_file_path_bytes	plain	xsd:int	The number of bytes allowed for each injected file path.
injected_files	plain	xsd:int	The number of injected files allowed for each tenant.
instances	plain	xsd:int	The number of instances allowed for each tenant.
key_pairs	plain	xsd:int	The number of key pairs allowed for each user.
metadata_items	plain	xsd:int	The number of metadata items allowed for each instance.
ram	plain	xsd:int	The amount of instance RAM in megabytes allowed for each tenant.
security_group_rules (Optional)	plain	xsd:int	The number of rules allowed for each security group.
security_groups	plain	xsd:int	The number of security groups allowed for each tenant.
server_groups	plain	xsd:int	The number of server groups allowed for each tenant.
server_group_members	plain	xsd:int	The number of members allowed for each server group.

{
    "quota_set": {
        "force": "True",
        "instances": 9
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<quota_set id="fake_tenant">
  <force>True</force>
  <instances>9</instances>
</quota_set>

{
    "quota_set": {
        "cores": 20,
        "floating_ips": 10,
        "fixed_ips": -1,
        "injected_file_content_bytes": 10240,
        "injected_file_path_bytes": 255,
        "injected_files": 5,
        "instances": 9,
        "key_pairs": 100,
        "metadata_items": 128,
        "ram": 51200,
        "security_group_rules": 20,
        "security_groups": 10
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<quota_set>
  <cores>20</cores>
  <floating_ips>10</floating_ips>
  <fixed_ips>-1</fixed_ips>
  <injected_file_content_bytes>10240</injected_file_content_bytes>
  <injected_file_path_bytes>255</injected_file_path_bytes>
  <injected_files>5</injected_files>
  <instances>9</instances>
  <key_pairs>100</key_pairs>
  <metadata_items>128</metadata_items>
  <ram>51200</ram>
  <security_group_rules>20</security_group_rules>
  <security_groups>10</security_groups>
</quota_set>

DELETE

/v2/{tenant_id}/os-quota-sets/{tenant_id}/{user_id}

Delete quotas for user

Deletes quotas for a user so that the quotas revert to default values.

Normal response codes

200

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or project in a multi-tenancy cloud.
tenant_id	URI	xsd:string	The ID for the tenant for which you want to show, update, or delete quotas. This ID is different from the first tenant ID that you specify in the URI: That ID is for the admin tenant.
user_id	URI	xsd:string	The user ID. Specify in the URI as a query string: `user_id={user_id}`.

This operation does not accept a request body and does not return a response body.

GET

/v2/{tenant_id}/os-quota-sets/{tenant_id}/detail/{user_id}

Show quota details for user

Shows details for quotas for a specified tenant and user.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or project in a multi-tenancy cloud.
tenant_id	URI	xsd:string	The ID for the tenant for which you want to show, update, or delete quotas. This ID is different from the first tenant ID that you specify in the URI: That ID is for the admin tenant.
user_id	URI	xsd:string	The user ID. Specify in the URI as a query string: `user_id={user_id}`.

Response parameters

Parameter	Style	Type	Description
quota_set	plain	xsd:string	A quota_set object.
cores	plain	xsd:string	A cores object.
fixed_ips	plain	xsd:string	A fixed_ips object.
floating_ips	plain	xsd:string	A floating_ips object.
id	plain	csapi:UUID	The ID for the quota set.
injected_file_content_bytes	plain	xsd:string	An injected_file_content_bytes object.
injected_file_path_bytes	plain	xsd:string	An injected_file_path_bytes object.
injected_files	plain	xsd:string	An injected_files object.
instances	plain	xsd:string	An instances object.
key_pairs	plain	xsd:string	A key_pairs object.
metadata_items	plain	xsd:string	A metadata_items object.
ram	plain	xsd:string	A ram object.
security_group_rules	plain	xsd:string	A security_group_rules object.
security_groups	plain	xsd:string	A security_groups object.
in_use	plain	xsd:int	The number of items in use.
limit	plain	xsd:int	The number of items permitted for this tenant.
reserved	plain	xsd:int	The number of reserved items.

{
    "quota_set": {
        "cores": 20,
        "fixed_ips": -1,
        "floating_ips": 10,
        "id": "fake_tenant",
        "injected_file_content_bytes": 10240,
        "injected_file_path_bytes": 255,
        "injected_files": 5,
        "instances": 10,
        "key_pairs": 100,
        "metadata_items": 128,
        "ram": 51200,
        "security_group_rules": 20,
        "security_groups": 10
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<quota_set id="fake_tenant">
  <cores>20</cores>
  <fixed_ips>-1</fixed_ips>
  <floating_ips>10</floating_ips>
  <injected_file_content_bytes>10240</injected_file_content_bytes>
  <injected_file_path_bytes>255</injected_file_path_bytes>
  <injected_files>5</injected_files>
  <instances>10</instances>
  <key_pairs>100</key_pairs>
  <metadata_items>128</metadata_items>
  <ram>51200</ram>
  <security_group_rules>20</security_group_rules>
  <security_groups>10</security_groups>
</quota_set>

This operation does not accept a request body.

Security groups (os-security-groups)

Lists, lists by server, creates, shows information for, updates, and deletes security groups.

GET

/v2/{tenant_id}/os-security-groups

List security groups

Lists security groups.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The unique identifier of the tenant or account.

Response parameters

Parameter	Style	Type	Description
security_groups	plain	xsd:string	Security groups object.
description	plain	xsd:string	Security group description.
id	plain	csapi:UUID	The security group ID.
name	plain	xsd:string	The security group name.
tenant_id	plain	xsd:string	The tenant.

{
    "security_groups": [
        {
            "description": "default",
            "id": "3fb26eb3-581b-4420-9963-b0879a026506",
            "name": "default",
            "rules": [],
            "tenant_id": "openstack"
        }
    ]
}

This operation does not accept a request body.

GET

/v2/{tenant_id}/servers/{server_id}/os-security-groups

List security groups by server

Lists security groups for a specified server.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The unique identifier of the tenant or account.
server_id	URI	csapi:UUID	The UUID for the server of interest to you.

Response parameters

Parameter	Style	Type	Description
security_groups	plain	xsd:string	Security groups object.
description	plain	xsd:string	Security group description.
id	plain	csapi:UUID	The security group ID.
name	plain	xsd:string	The security group name.
tenant_id	plain	xsd:string	The tenant.

{
    "security_groups": [
        {
            "description": "default",
            "id": "3fb26eb3-581b-4420-9963-b0879a026506",
            "name": "default",
            "rules": [],
            "tenant_id": "openstack"
        }
    ]
}

This operation does not accept a request body.

POST

/v2/{tenant_id}/os-security-groups

Create security group

Creates a security group.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The unique identifier of the tenant or account.
security_group	plain	xsd:string	Specify the `security_group` action in the request body.
name	plain	xsd:string	The security group name.
description (Optional)	plain	xsd:string	Security group description.

Response parameters

Parameter	Style	Type	Description
security_group	plain	xsd:string	A `security_group` object.
description	plain	xsd:string	Security group description.
id	plain	csapi:UUID	The security group ID.
name	plain	xsd:string	The security group name.
tenant_id	plain	xsd:string	The tenant.

{
    "security_group": {
        "name": "test",
        "description": "test"
    }
}

{
    "security_group": {
        "description": "test",
        "id": "de3ff110-46b2-4ace-bb76-a2e1ed741b95",
        "name": "test",
        "rules": [],
        "tenant_id": "openstack"
    }
}

GET

/v2/{tenant_id}/os-security-groups/{security_group_id}

Show security group information

Shows information for a specified security group.

Normal response codes

200

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The unique identifier of the tenant or account.
security_group_id	URI	csapi:uuid	The unique identifier of the security group.

Response parameters

Parameter	Style	Type	Description
security_group	plain	xsd:string	A `security_group` object.
description	plain	xsd:string	Security group description.
id	plain	csapi:UUID	The security group ID.
name	plain	xsd:string	The security group name.
tenant_id	plain	xsd:string	The tenant.

{
    "security_group": {
        "description": "default",
        "id": "de3ff110-46b2-4ace-bb76-a2e1ed741b95",
        "name": "default",
        "rules": [],
        "tenant_id": "openstack"
    }
}

This operation does not accept a request body.

PUT

/v2/{tenant_id}/os-security-groups/{security_group_id}

Update security group

Updates a specified security group.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The unique identifier of the tenant or account.
security_group_id	URI	csapi:uuid	The unique identifier of the security group.
name	plain	xsd:string	The security group name.
description (Optional)	plain	xsd:string	Security group description.

Response parameters

Parameter	Style	Type	Description
security_group	plain	xsd:string	A `security_group` object.
description	plain	xsd:string	Security group description.
id	plain	csapi:UUID	The security group ID.
name	plain	xsd:string	The security group name.
tenant_id	plain	xsd:string	The tenant.

{
    "security_group": {
        "name": "mysecgroup",
        "description": "my security group"
    }
}

{
    "security_group": {
        "rules": [],
        "tenant_id": "a52cdb9cc7854a39a23d3af73a40899e",
        "id": "01fbade5-b664-42f6-83ae-4e214f4263fa",
        "name": "mysecgroup",
        "description": "my security group"
    }
}

DELETE

/v2/{tenant_id}/os-security-groups/{security_group_id}

Delete security group

Deletes a specified security group.

Normal response codes

202

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The unique identifier of the tenant or account.
security_group_id	URI	csapi:uuid	The unique identifier of the security group.

This operation does not accept a request body and does not return a response body.

Rules for security group (os-security-group-rules)

Creates and deletes security group rules.

POST

/v2/{tenant_id}/os-security-group-rules

Create security group rule

Creates a rule for a specified security group.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID of the tenant.
security_group_rule	plain	xsd:dict	A `security_group_rule` object.
parent_group_id	plain	csapi:UUID	Security group ID.
ip_protocol	plain	xsd:string	The IP protocol: ICMP, TCP, or UDP.
from_port	plain	xsd:int	Port at start of range.
to_port	plain	xsd:int	Port at end of range.
cidr	plain	xsd:string	The CIDR for address range.
group_id (Optional)	plain	csapi:UUID	Source security group ID.

Response parameters

Parameter	Style	Type	Description
security_group_rule	plain	csapi:UUID	A `security_group_rule` object.
ip_protocol	plain	xsd:string	The IP protocol: ICMP, TCP, or UDP.
from_port	plain	xsd:int	Port at start of range.
to_port	plain	xsd:int	Port at end of range.
ip_range	plain	xsd:string	An `ip_range` object.
cidr	plain	xsd:string	The CIDR for address range.
id	plain	xsd:int	The security group ID.
group	plain	xsd:string	A `group` object. Includes the tenant ID and the source security group name.
tenant_id	plain	csapi:UUID	The ID of the tenant who owns the source security group.
name	plain	xsd:string	The source security group name.

{
    "security_group_rule": {
        "from_port": "443",
        "ip_protocol": "tcp",
        "to_port": "443",
        "cidr": "0.0.0.0/0",
        "parent_group_id": "48700ff3-30b8-4e63-845f-a79c9633e9fb"
    }
}

{
    "security_group_rule": {
        "id": "2d021cf1-ce4b-4292-994f-7a785d62a144",
        "ip_range": {
            "cidr": "0.0.0.0/0"
        },
        "parent_group_id": "48700ff3-30b8-4e63-845f-a79c9633e9fb",
        "to_port": 443,
        "ip_protocol": "tcp",
        "group": {},
        "from_port": 443
    }
}

DELETE

/v2/{tenant_id}/os-security-group-rules/{security_group_rule_id}

Delete security group rule

Deletes a specified security group rule.

Normal response codes

202

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID of the tenant.
security_group_rule_id	URI	csapi:uuid	The ID of the security group rule.

This operation does not accept a request body and does not return a response body.

Rules for default security group (os-security-group-default-rules)

Lists, shows information for, and creates default security group rules.

GET

/v2/{tenant_id}/os-security-group-default-rules

List default security group rules

Lists default security group rules.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The unique identifier of the tenant or account.

Response parameters

Parameter	Style	Type	Description
from_port	plain	xsd:int	Port at start of range.
id	plain	csapi:UUID	Security group ID.
ip_protocol	plain	xsd:string	The IP protocol: ICMP, TCP, or UDP.
ip_range	plain	xsd:string	An IP range object.
cidr	plain	xsd:string	The CIDR for address range.
to_port	plain	xsd:int	Port at end of range.

{
    "security_group_default_rules": [
        {
            "from_port": 80,
            "id": 1,
            "ip_protocol": "TCP",
            "ip_range": {
                "cidr": "10.10.10.0/24"
            },
            "to_port": 80
        }
    ]
}

<?xml version='1.0' encoding='UTF-8'?>
<security_group_default_rules xmlns="http://docs.openstack.org/compute/api/v1.1">
  <security_group_default_rule id="1">
    <ip_protocol>TCP</ip_protocol>
    <from_port>80</from_port>
    <to_port>80</to_port>
    <ip_range>
      <cidr>10.10.10.0/24</cidr>
    </ip_range>
  </security_group_default_rule>
</security_group_default_rules>

This operation does not accept a request body.

POST

/v2/{tenant_id}/os-security-group-default-rules

Create default security group rule

Creates a default security group rule.

You must specify an IP protocol (ip_protocol) value if you specify a source (from_port) or destination (to_port) port value. Otherwise, the operation returns the Bad request (400) Source/destination port requires a protocol error.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The unique identifier of the tenant or account.
id	plain	csapi:UUID	Security group name or ID.
ip_protocol	plain	xsd:string	The IP protocol: ICMP, TCP, or UDP.
from_port	plain	xsd:int	Port at start of range.
to_port	plain	xsd:int	Port at end of range.
cidr	plain	xsd:string	The CIDR for address range.

Response parameters

Parameter	Style	Type	Description
from_port	plain	xsd:int	Port at start of range.
id	plain	csapi:UUID	Security group ID.
ip_protocol	plain	xsd:string	The IP protocol: ICMP, TCP, or UDP.
ip_range	plain	xsd:string	An IP range object.
cidr	plain	xsd:string	The CIDR for address range.
to_port	plain	xsd:int	Port at end of range.

{
    "security_group_default_rule": {
        "ip_protocol": "TCP",
        "from_port": "80",
        "to_port": "80",
        "cidr": "10.10.12.0/24"
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<security_group_default_rule>
  <ip_protocol>TCP</ip_protocol>
  <from_port>80</from_port>
  <to_port>80</to_port>
  <cidr>10.10.12.0/24</cidr>
</security_group_default_rule>

{
    "security_group_default_rule": {
        "from_port": 80,
        "id": 1,
        "ip_protocol": "TCP",
        "ip_range": {
            "cidr": "10.10.10.0/24"
        },
        "to_port": 80
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<security_group_default_rule xmlns="http://docs.openstack.org/compute/api/v1.1"  id="1">
  <ip_protocol>TCP</ip_protocol>
  <from_port>80</from_port>
  <to_port>80</to_port>
  <ip_range>
    <cidr>10.10.10.0/24</cidr>
  </ip_range>
</security_group_default_rule>

GET

/v2/{tenant_id}/os-security-group-default-rules/{security_group_default_rule_id}

Show default security group rule information

Shows information for a specified security group rule.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The unique identifier of the tenant or account.
security_group_default_rule_id	URI	csapi:uuid	The unique identifier of the security group rule.

Response parameters

Parameter	Style	Type	Description
from_port	plain	xsd:int	Port at start of range.
id	plain	csapi:UUID	Security group ID.
ip_protocol	plain	xsd:string	The IP protocol: ICMP, TCP, or UDP.
ip_range	plain	xsd:string	An IP range object.
cidr	plain	xsd:string	The CIDR for address range.
to_port	plain	xsd:int	Port at end of range.

{
    "security_group_default_rule": {
        "id": 1,
        "from_port": 80,
        "to_port": 80,
        "ip_protocol": "TCP",
        "ip_range": {
            "cidr": "10.10.10.0/24"
        }
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<security_group_default_rule xmlns="http://docs.openstack.org/compute/api/v1.1" id="1">
  <from_port>80</from_port>
  <to_port>80</to_port>
  <ip_protocol>TCP</ip_protocol>
  <ip_range>
    <cidr>10.10.10.0/24</cidr>
  </ip_range>
</security_group_default_rule>

This operation does not accept a request body.

DELETE

/v2/{tenant_id}/os-security-group-default-rules/{security_group_default_rule_id}

Delete default security group rule

Deletes a specified security group rule.

Normal response codes

204

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The unique identifier of the tenant or account.
security_group_default_rule_id	URI	csapi:uuid	The unique identifier of the security group rule.

This operation does not accept a request body and does not return a response body.

Server groups (os-server-groups)

Lists, shows information for, creates, and deletes server groups.

GET

/v2/{tenant_id}/os-server-groups

List server groups

Lists server groups.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.

Response parameters

Parameter	Style	Type	Description
server_groups	plain	xsd:string	A `server_groups` object.
id	plain	csapi:uuid	The ID for the server group.
name	plain	xsd:string	The name of the server group.
policies	plain	xsd:dict	A list of policies associated with the server group.
members	plain	xsd:dict	A list of members in the server group.
metadata	plain	xsd:string	Associated metadata key-and-value pairs.

{
    "server_groups": [
        {
            "id": "616fb98f-46ca-475e-917e-2563e5a8cd19",
            "name": "test",
            "policies": [
                "anti-affinity"
            ],
            "members": [],
            "metadata": {}
        }
    ]
}

<?xml version='1.0' encoding='UTF-8'?>
<server_groups  xmlns:atom="http://www.w3.org/2005/Atom" xmlns="http://docs.openstack.org/compute/api/v1.1">
  <server_group id="5bbcc3c4-1da2-4437-a48a-66f15b1b13f9" name="test">
  <policies>
  <policy>anti-affinity</policy>
  </policies>
  <members/>
  <metadata/>
</server_group>
</server_groups>

This operation does not accept a request body.

POST

/v2/{tenant_id}/os-server-groups

Create server group

Creates a server group.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
name	plain	xsd:string	The server group name. A non-empty string with no leading or trailing spaces. Maximum length is 255 characters.
policies (Optional)	plain	xsd:dict	A list of one or more policy names to associate with the server group. The list must contain at least one policy name. Each policy name must be a non-empty string with no leading or trailing spaces. Maximum length is 255 characters.

Response parameters

Parameter	Style	Type	Description
server_group	plain	xsd:string	A `server_group` groups VMs based on common characteristics so that you can apply policies to groups or categorize servers for scheduling purposes.
id	plain	csapi:uuid	The ID for the server group.
name	plain	xsd:string	The name of the server group.
policies	plain	xsd:dict	A list of policies associated with the server group.
members	plain	xsd:dict	A list of members in the server group.
metadata	plain	xsd:string	Associated metadata key-and-value pairs.

{
    "server_group": {
        "name": "test",
        "policies": [
            "anti-affinity"
        ]
    }
}

<server_group name="test">
  <policies>
  <policy>anti-affinity</policy>
  </policies>
</server_group>

{
    "server_group": {
        "id": "5bbcc3c4-1da2-4437-a48a-66f15b1b13f9",
        "name": "test",
        "policies": [
            "anti-affinity"
        ],
        "members": [],
        "metadata": {}
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<server_group xmlns:atom="http://www.w3.org/2005/Atom" xmlns="http://docs.openstack.org/compute/api/v1.1" id="5bbcc3c4-1da2-4437-a48a-66f15b1b13f9" name="test">
  <policies>
  <policy>anti-affinity</policy>
  </policies>
  <members/>
  <metadata/>
</server_group>

GET

/v2/{tenant_id}/os-server-groups/{ServerGroup_id}

Show server group details

Shows details for a specified server group.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
ServerGroup_id	URI	String	The server group ID.

Response parameters

Parameter	Style	Type	Description
server_group	plain	xsd:string	A `server_group` places VMs in a grouping based on common characteristics, so that you can apply policies to groups or categorize servers for scheduling purposes.
id	plain	csapi:uuid	The ID for the server group.
name	plain	xsd:string	The name of the server group.
policies	plain	xsd:dict	A list of policies associated with the server group.
members	plain	xsd:dict	A list of members in the server group.
metadata	plain	xsd:string	Associated metadata key-and-value pairs.

{
    "server_group": {
        "id": "5bbcc3c4-1da2-4437-a48a-66f15b1b13f9",
        "name": "test",
        "policies": [
            "anti-affinity"
        ],
        "members": [],
        "metadata": {}
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<server_group xmlns:atom="http://www.w3.org/2005/Atom" xmlns="http://docs.openstack.org/compute/api/v1.1" id="5bbcc3c4-1da2-4437-a48a-66f15b1b13f9" name="test">
  <policies>
  <policy>anti-affinity</policy>
  </policies>
  <members/>
  <metadata/>
</server_group>

This operation does not accept a request body.

DELETE

/v2/{tenant_id}/os-server-groups/{ServerGroup_id}

Delete server group

Deletes a specified server group.

Normal response codes

204

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
ServerGroup_id	URI	String	The server group ID.

This operation does not accept a request body and does not return a response body.

Manage services (os-services)

Lists, enables, and disables Compute services in all hosts.

GET

/v2/{tenant_id}/os-services

List services

Lists running services.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.

{
    "services": [
        {
            "binary": "nova-scheduler",
            "host": "host1",
            "state": "up",
            "status": "disabled",
            "updated_at": "2012-10-29T13:42:02.000000",
            "zone": "internal"
        },
        {
            "binary": "nova-compute",
            "host": "host1",
            "state": "up",
            "status": "disabled",
            "updated_at": "2012-10-29T13:42:05.000000",
            "zone": "nova"
        },
        {
            "binary": "nova-scheduler",
            "host": "host2",
            "state": "down",
            "status": "enabled",
            "updated_at": "2012-09-19T06:55:34.000000",
            "zone": "internal"
        },
        {
            "binary": "nova-compute",
            "host": "host2",
            "state": "down",
            "status": "disabled",
            "updated_at": "2012-09-18T08:03:38.000000",
            "zone": "nova"
        }
    ]
}

This operation does not accept a request body.

PUT

/v2/{tenant_id}/os-services/enable

Enable scheduling for a service

Enables scheduling for a service.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.

{
    "host": "host1",
    "binary": "nova-compute"
}

{
    "service": {
        "host": "host1",
        "binary": "nova-compute",
        "status": "enabled"
    }
}

PUT

/v2/{tenant_id}/os-services/disable

Disable scheduling for a service

Disables scheduling for a service.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.

{
    "host": "host1",
    "binary": "nova-compute"
}

{
    "service": {
        "host": "host1",
        "binary": "nova-compute",
        "status": "disabled"
    }
}

PUT

/v2/{tenant_id}/os-services/disable-log-reason

Log disabled service information

Logs information to the service table about why a service was disabled.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
host	plain	xsd:string	The host name.
binary	plain	xsd:string	The service name.
disabled_reason	plain	xsd:string	The reason the service was disabled.

{
    "host": "host1",
    "binary": "nova-compute",
    "disabled_reason": "test2"
}

<?xml version='1.0' encoding='UTF-8'?>
<service host="host1" binary="nova-compute" disabled_reason="test2"/>

{
    "service": {
        "binary": "nova-compute",
        "host": "host1",
        "disabled_reason": "test2",
        "status": "disabled"
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<service host="host1" binary="nova-compute" status="disabled" disabled_reason="test2" />

GET

/v2/{tenant_id}/os-services/detail

List disabled services

Lists disabled services. If information exists, includes reasons why services were disabled.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.

{
    "services": [
        {
            "binary": "nova-scheduler",
            "host": "host1",
            "state": "up",
            "status": "disabled",
            "updated_at": "2012-10-29T13:42:02.000000",
            "zone": "internal",
            "disabled_reason": "test1"
        },
        {
            "binary": "nova-compute",
            "host": "host1",
            "state": "up",
            "status": "disabled",
            "updated_at": "2012-10-29T13:42:05.000000",
            "zone": "nova",
            "disabled_reason": "test2"
        },
        {
            "binary": "nova-scheduler",
            "host": "host2",
            "state": "down",
            "status": "enabled",
            "updated_at": "2012-09-19T06:55:34.000000",
            "zone": "internal",
            "disabled_reason": null
        },
        {
            "binary": "nova-compute",
            "host": "host2",
            "state": "down",
            "status": "disabled",
            "updated_at": "2012-09-18T08:03:38.000000",
            "zone": "nova",
            "disabled_reason": "test4"
        }
    ]
}

<services>
    <service status="disabled" binary="nova-scheduler" zone="internal" state="up" host="host1" updated_at="2012-10-29 13:42:02" disabled_reason="test1"/>
    <service status="disabled" binary="nova-compute" zone="nova" state="up" host="host1" updated_at="2012-10-29 13:42:05" disabled_reason="test2"/>
    <service status="enabled" binary="nova-scheduler" zone="internal" state="down" host="host2" updated_at="2012-09-19 06:55:34" disabled_reason="None"/>
    <service status="disabled" binary="nova-compute" zone="nova" state="down" host="host2" updated_at="2012-09-18 08:03:38" disabled_reason="test4"/>
</services>

This operation does not accept a request body.

DELETE

/v2/{tenant_id}/os-services/{service_id}

Delete service

Deletes an existing service.

Normal response codes

204

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.

{
    "host": "host1",
    "binary": "nova-compute"
}

This operation does not return a response body.

Usage reports (os-simple-tenant-usage)

Reports usage statistics on compute and storage resources.

GET

/v2/{tenant_id}/os-simple-tenant-usage

List usage information for all tenants

Lists usage information for all tenants.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
start	plain	String	The start of a time range, in date time format.
end	plain	String	The end of the time range, in date time format.
detailed (Optional)	plain	String	Whether to return detailed usage information. Defaults to false.

{
    "tenant_usages": [
        {
            "start": "2012-10-08T21:10:44.587336",
            "stop": "2012-10-08T22:10:44.587336",
            "tenant_id": "openstack",
            "total_hours": 1.0,
            "total_local_gb_usage": 1.0,
            "total_memory_mb_usage": 512.0,
            "total_vcpus_usage": 1.0
        }
    ]
}

<?xml version='1.0' encoding='UTF-8'?>
<tenant_usages>
  <tenant_usage>
    <tenant_id>openstack</tenant_id>
    <total_local_gb_usage>1.0</total_local_gb_usage>
    <total_vcpus_usage>1.0</total_vcpus_usage>
    <total_memory_mb_usage>512.0</total_memory_mb_usage>
    <total_hours>1.0</total_hours>
    <start>2012-10-08 21:10:51.902640</start>
    <stop>2012-10-08 22:10:51.902640</stop>
    <server_usages/>
  </tenant_usage>
</tenant_usages>

GET

/v2/{tenant_id}/os-simple-tenant-usage/{tenant_id}

Get tenant usage information

Gets usage information for a tenant.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The ID for the tenant or account in a multi-tenancy cloud.
tenant_id	URI	String	The tenant ID.
start	plain	String	The start of a time range, in date time format.
end	plain	String	The end of the time range, in date time format.
detailed (Optional)	plain	String	Whether to return detailed usage information. Defaults to false.

{
    "tenant_usage": {
        "server_usages": [
            {
                "ended_at": null,
                "flavor": "m1.tiny",
                "hours": 1.0,
                "instance_id": "1f1deceb-17b5-4c04-84c7-e0d4499c8fe0",
                "local_gb": 1,
                "memory_mb": 512,
                "name": "new-server-test",
                "started_at": "2012-10-08T20:10:44.541277",
                "state": "active",
                "tenant_id": "openstack",
                "uptime": 3600,
                "vcpus": 1
            }
        ],
        "start": "2012-10-08T20:10:44.587336",
        "stop": "2012-10-08T21:10:44.587336",
        "tenant_id": "openstack",
        "total_hours": 1.0,
        "total_local_gb_usage": 1.0,
        "total_memory_mb_usage": 512.0,
        "total_vcpus_usage": 1.0
    }
}

<?xml version='1.0' encoding='UTF-8'?>
<tenant_usage>
  <tenant_id>openstack</tenant_id>
  <total_local_gb_usage>1.0</total_local_gb_usage>
  <total_vcpus_usage>1.0</total_vcpus_usage>
  <total_memory_mb_usage>512.0</total_memory_mb_usage>
  <total_hours>1.0</total_hours>
  <start>2012-10-08 20:10:51.902640</start>
  <stop>2012-10-08 21:10:51.902640</stop>
  <server_usages>
    <server_usage>
      <instance_id>e4521f3b-d9ad-4454-be8a-e2732f0630ef</instance_id>
      <name>new-server-test</name>
      <hours>1.0</hours>
      <memory_mb>512</memory_mb>
      <local_gb>1</local_gb>
      <vcpus>1</vcpus>
      <tenant_id>openstack</tenant_id>
      <flavor>m1.tiny</flavor>
      <started_at>2012-10-08 20:10:51.854331</started_at>
      <ended_at>None</ended_at>
      <state>active</state>
      <uptime>3600</uptime>
    </server_usage>
  </server_usages>
</tenant_usage>

Volume extension (os-volumes, os-snapshots)

Manages volumes and snapshots for use with the Compute API.

GET

/v2/{tenant_id}/os-volumes

List volumes

Lists the volumes associated with the account.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The unique identifier of the tenant or account.

{
    "volumes": [
        {
            "id": "521752a6-acf6-4b2d-bc7a-119f9148cd8c",
            "display_name": "vol-001",
            "display_description": "Another volume.",
            "size": 30,
            "volume_type": "289da7f8-6440-407c-9fb4-7db01ec49164",
            "metadata": {
                "contents": "junk"
            },
            "availability_zone": "us-east1",
            "snapshot_id": null,
            "attachments": [],
            "created_at": "2012-02-14T20:53:07Z"
        },
        {
            "id": "76b8950a-8594-4e5b-8dce-0dfa9c696358",
            "display_name": "vol-002",
            "display_description": "Yet another volume.",
            "size": 25,
            "volume_type": "96c3bda7-c82a-4f50-be73-ca7621794835",
            "metadata": {},
            "availability_zone": "us-east2",
            "snapshot_id": null,
            "attachments": [],
            "created_at": "2012-03-15T19:10:03Z"
        }
    ]
}

<?xml version="1.0" encoding="UTF-8"?>
<volumes xmlns="http://docs.openstack.org/volume/api/v1">
    <volume xmlns="http://docs.openstack.org/volume/api/v1"
            id="521752a6-acf6-4b2d-bc7a-119f9148cd8c"
            display_name="vol-001"
            display_description="Another volume."
            status="active"
            size="30"
            volume_type="289da7f8-6440-407c-9fb4-7db01ec49164"
            availability_zone="us-east1"
            created_at="2012-02-14T20:53:07Z">
        <metadata>
            <meta key="contents">junk</meta>
        </metadata>
    </volume>
    <volume xmlns="http://docs.openstack.org/volume/api/v1"
            id="76b8950a-8594-4e5b-8dce-0dfa9c696358"
            display_name="vol-002"
            display_description="Yet another volume."
            status="active"
            size="25"
            volume_type="96c3bda7-c82a-4f50-be73-ca7621794835"
            availability_zone="us-east2"
            created_at="2012-03-15T19:10:03Z" />
</volumes>

This operation does not accept a request body.

POST

/v2/{tenant_id}/os-volumes

Create volume

Creates a volume.

Normal response codes

201

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The unique identifier of the tenant or account.
display_name (Optional)	plain	xsd:string	The volume name.
display_description (Optional)	plain	xsd:string	The volume description.
size	plain	xsd:string	The size of the volume, in gigabytes (GB).
volume_type (Optional)	plain	xsd:string	The unique identifier for a volume type.
metadata (Optional)	plain	xsd:string	One or more metadata key and value pairs to associate with the volume.
availability_zone (Optional)	plain	xsd:string	The availability zone.
snapshot_id	plain	xsd:string	The unique identifier for a snapshot.

{
    "volume": {
        "display_name": "vol-001",
        "display_description": "Another volume.",
        "size": 30,
        "volume_type": "289da7f8-6440-407c-9fb4-7db01ec49164",
        "metadata": {
            "contents": "junk"
        },
        "availability_zone": "us-east1"
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<volume xmlns="http://docs.openstack.org/volume/api/v1"
        display_name="vol-001"
        display_description="Another volume."
        size="30"
        volume_type="289da7f8-6440-407c-9fb4-7db01ec49164"
        availability_zone="us-east1">
    <metadata>
        <meta key="contents">junk</meta>
    </metadata>
</volume>

{
    "volume": {
        "id": "521752a6-acf6-4b2d-bc7a-119f9148cd8c",
        "display_name": "vol-001",
        "display_description": "Another volume.",
        "status": "active",
        "size": 30,
        "volume_type": "289da7f8-6440-407c-9fb4-7db01ec49164",
        "metadata": {
            "contents": "junk"
        },
        "availability_zone": "us-east1",
        "snapshot_id": null,
        "attachments": [],
        "created_at": "2012-02-14T20:53:07Z"
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<volume xmlns="http://docs.openstack.org/volume/api/v1"
        id="521752a6-acf6-4b2d-bc7a-119f9148cd8c"
        display_name="vol-001"
        display_description="Another volume."
        status="active"
        size="30"
        volume_type="289da7f8-6440-407c-9fb4-7db01ec49164"
        availability_zone="us-east1"
        created_at="2012-02-14T20:53:07Z">
    <metadata>
        <meta key="contents">junk</meta>
    </metadata>
</volume>

GET

/v2/{tenant_id}/os-volumes/detail

List details for volumes

Lists details for all volumes.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The unique identifier of the tenant or account.

{
    "volumes": [
        {
            "id": "521752a6-acf6-4b2d-bc7a-119f9148cd8c",
            "display_name": "vol-001",
            "display_description": "Another volume.",
            "size": 30,
            "volume_type": "289da7f8-6440-407c-9fb4-7db01ec49164",
            "metadata": {
                "contents": "junk"
            },
            "availability_zone": "us-east1",
            "snapshot_id": null,
            "attachments": [],
            "created_at": "2012-02-14T20:53:07Z"
        },
        {
            "id": "76b8950a-8594-4e5b-8dce-0dfa9c696358",
            "display_name": "vol-002",
            "display_description": "Yet another volume.",
            "size": 25,
            "volume_type": "96c3bda7-c82a-4f50-be73-ca7621794835",
            "metadata": {},
            "availability_zone": "us-east2",
            "snapshot_id": null,
            "attachments": [],
            "created_at": "2012-03-15T19:10:03Z"
        }
    ]
}

<?xml version="1.0" encoding="UTF-8"?>
<volumes xmlns="http://docs.openstack.org/volume/api/v1">
    <volume xmlns="http://docs.openstack.org/volume/api/v1"
            id="521752a6-acf6-4b2d-bc7a-119f9148cd8c"
            display_name="vol-001"
            display_description="Another volume."
            status="active"
            size="30"
            volume_type="289da7f8-6440-407c-9fb4-7db01ec49164"
            availability_zone="us-east1"
            created_at="2012-02-14T20:53:07Z">
        <metadata>
            <meta key="contents">junk</meta>
        </metadata>
    </volume>
    <volume xmlns="http://docs.openstack.org/volume/api/v1"
            id="76b8950a-8594-4e5b-8dce-0dfa9c696358"
            display_name="vol-002"
            display_description="Yet another volume."
            status="active"
            size="25"
            volume_type="96c3bda7-c82a-4f50-be73-ca7621794835"
            availability_zone="us-east2"
            created_at="2012-03-15T19:10:03Z" />
</volumes>

This operation does not accept a request body.

GET

/v2/{tenant_id}/os-volumes/{volume_id}

Show volume information

Shows information for a specified volume.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The unique identifier of the tenant or account.
volume_id	URI	xsd:string	The unique identifier for a volume.

{
    "volume": {
        "id": "521752a6-acf6-4b2d-bc7a-119f9148cd8c",
        "display_name": "vol-001",
        "display_description": "Another volume.",
        "status": "active",
        "size": 30,
        "volume_type": "289da7f8-6440-407c-9fb4-7db01ec49164",
        "metadata": {
            "contents": "junk"
        },
        "availability_zone": "us-east1",
        "snapshot_id": null,
        "attachments": [],
        "created_at": "2012-02-14T20:53:07Z"
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<volume xmlns="http://docs.openstack.org/volume/api/v1"
        id="521752a6-acf6-4b2d-bc7a-119f9148cd8c"
        display_name="vol-001"
        display_description="Another volume."
        status="active"
        size="30"
        volume_type="289da7f8-6440-407c-9fb4-7db01ec49164"
        availability_zone="us-east1"
        created_at="2012-02-14T20:53:07Z">
    <metadata>
        <meta key="contents">junk</meta>
    </metadata>
</volume>

This operation does not accept a request body.

DELETE

/v2/{tenant_id}/os-volumes/{volume_id}

Delete volume

Deletes a specified volume.

Normal response codes

202

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The unique identifier of the tenant or account.
volume_id	URI	xsd:string	The unique identifier for a volume.

HTTP/1.1 202 Accepted
Content-Type: text/html; charset=UTF-8
Content-Length: 0
Date: Fri, 02 Dec 2011 00:39:32 GMT

This operation does not accept a request body.

GET

/v2/{tenant_id}/os-volume-types

List volume types

Lists volume types.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The unique identifier of the tenant or account.

{
    "volume_types": [
        {
            "id": "289da7f8-6440-407c-9fb4-7db01ec49164",
            "name": "vol-type-001",
            "extra_specs": {
                "capabilities": "gpu"
            }
        },
        {
            "id": "96c3bda7-c82a-4f50-be73-ca7621794835",
            "name": "vol-type-002",
            "extra_specs": {}
        }
    ]
}

<?xml version="1.0" encoding="UTF-8"?>
<volume_types xmlns="http://docs.openstack.org/volume/api/v1">
    <volume_type id="289da7f8-6440-407c-9fb4-7db01ec49164"
                 name="vol-type-001">
        <extra_specs>
            <extra_spec key="capabilities">gpu</extra_spec>
        </extra_specs>
    </volume_type>
    <volume_type id="96c3bda7-c82a-4f50-be73-ca7621794835"
                 name="vol-type-002" />
</volume_types>

This operation does not accept a request body.

GET

/v2/{tenant_id}/os-volume-types/{volume_type_id}

Show volume type

Shows information for a specified volume type.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The unique identifier of the tenant or account.
volume_type_id	URI	xsd:string	The unique identifier for a volume type.

{
    "volume_type": {
        "id": "289da7f8-6440-407c-9fb4-7db01ec49164",
        "name": "vol-type-001",
        "extra_specs": {
            "capabilities": "gpu"
        }
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<volume_type xmlns="http://docs.openstack.org/volume/api/v1"
             id="289da7f8-6440-407c-9fb4-7db01ec49164"
             name="vol-type-001">
    <extra_specs>
        <extra_spec key="capabilities">gpu</extra_spec>
    </extra_specs>
</volume_type>

This operation does not accept a request body.

POST

/v2/{tenant_id}/os-snapshots

Create snapshot

Creates a snapshot.

Normal response codes

201

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The unique identifier of the tenant or account.
snapshot	plain	xsd:string	A partial representation of a snapshot that is used to create a snapshot.

{
    "snapshot": {
        "display_name": "snap-001",
        "display_description": "Daily backup",
        "volume_id": "521752a6-acf6-4b2d-bc7a-119f9148cd8c",
        "force": true
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<snapshot xmlns="http://docs.openstack.org/volume/api/v1"
          name="snap-001"
          display_name="snap-001"
          display_description="Daily backup"
          volume_id="521752a6-acf6-4b2d-bc7a-119f9148cd8c"
          force="true" />

{
    "snapshot": {
        "id": "3fbbcccf-d058-4502-8844-6feeffdf4cb5",
        "display_name": "snap-001",
        "display_description": "Daily backup",
        "volume_id": "521752a6-acf6-4b2d-bc7a-119f9148cd8c",
        "status": "available",
        "size": 30,
        "created_at": "2012-02-29T03:50:07Z"
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<snapshot xmlns="http://docs.openstack.org/volume/api/v1"
          id="3fbbcccf-d058-4502-8844-6feeffdf4cb5"
          display_name="snap-001"
          display_description="Daily backup"
          volume_id="521752a6-acf6-4b2d-bc7a-119f9148cd8c"
          status="available"
          size="30"
          created_at="2012-02-29T03:50:07Z" />

GET

/v2/{tenant_id}/os-snapshots

List snapshots

Lists snapshots.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The unique identifier of the tenant or account.

{
    "snapshots": [
        {
            "id": "3fbbcccf-d058-4502-8844-6feeffdf4cb5",
            "display_name": "snap-001",
            "display_description": "Daily backup",
            "volume_id": "521752a6-acf6-4b2d-bc7a-119f9148cd8c",
            "status": "available",
            "size": 30,
            "created_at": "2012-02-29T03:50:07Z"
        },
        {
            "id": "e479997c-650b-40a4-9dfe-77655818b0d2",
            "display_name": "snap-002",
            "display_description": "Weekly backup",
            "volume_id": "76b8950a-8594-4e5b-8dce-0dfa9c696358",
            "status": "available",
            "size": 25,
            "created_at": "2012-03-19T01:52:47Z"
        }
    ]
}

<?xml version="1.0" encoding="UTF-8"?>
<snapshots xmlns="http://docs.openstack.org/volume/api/v1">
    <snapshot id="3fbbcccf-d058-4502-8844-6feeffdf4cb5"
              display_name="snap-001"
              display_description="Daily backup"
              volume_id="521752a6-acf6-4b2d-bc7a-119f9148cd8c"
              status="available"
              size="30"
              created_at="2012-02-29T03:50:07Z" />
    <snapshot id="e479997c-650b-40a4-9dfe-77655818b0d2"
              display_name="snap-002"
              display_description="Weekly backup"
              volume_id="76b8950a-8594-4e5b-8dce-0dfa9c696358"
              status="available"
              size="25"
              created_at="2012-03-19T01:52:47Z" />
</snapshots>

This operation does not accept a request body.

GET

/v2/{tenant_id}/os-snapshots/detail

List details for snapshots

Lists details for all snapshots.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The unique identifier of the tenant or account.

{
    "snapshots": [
        {
            "id": "3fbbcccf-d058-4502-8844-6feeffdf4cb5",
            "display_name": "snap-001",
            "display_description": "Daily backup",
            "volume_id": "521752a6-acf6-4b2d-bc7a-119f9148cd8c",
            "status": "available",
            "size": 30,
            "created_at": "2012-02-29T03:50:07Z"
        },
        {
            "id": "e479997c-650b-40a4-9dfe-77655818b0d2",
            "display_name": "snap-002",
            "display_description": "Weekly backup",
            "volume_id": "76b8950a-8594-4e5b-8dce-0dfa9c696358",
            "status": "available",
            "size": 25,
            "created_at": "2012-03-19T01:52:47Z"
        }
    ]
}

<?xml version="1.0" encoding="UTF-8"?>
<snapshots xmlns="http://docs.openstack.org/volume/api/v1">
    <snapshot id="3fbbcccf-d058-4502-8844-6feeffdf4cb5"
              display_name="snap-001"
              display_description="Daily backup"
              volume_id="521752a6-acf6-4b2d-bc7a-119f9148cd8c"
              status="available"
              size="30"
              created_at="2012-02-29T03:50:07Z" />
    <snapshot id="e479997c-650b-40a4-9dfe-77655818b0d2"
              display_name="snap-002"
              display_description="Weekly backup"
              volume_id="76b8950a-8594-4e5b-8dce-0dfa9c696358"
              status="available"
              size="25"
              created_at="2012-03-19T01:52:47Z" />
</snapshots>

This operation does not accept a request body.

GET

/v2/{tenant_id}/os-snapshots/{snapshot_id}

Show snapshot

Shows information for a specified snapshot.

Normal response codes

200

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The unique identifier of the tenant or account.
snapshot_id	URI	xsd:string	The unique identifier for a snapshot.

{
    "snapshot": {
        "id": "3fbbcccf-d058-4502-8844-6feeffdf4cb5",
        "display_name": "snap-001",
        "display_description": "Daily backup",
        "volume_id": "521752a6-acf6-4b2d-bc7a-119f9148cd8c",
        "status": "available",
        "size": 30,
        "created_at": "2012-02-29T03:50:07Z"
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<snapshot xmlns="http://docs.openstack.org/volume/api/v1"
          id="3fbbcccf-d058-4502-8844-6feeffdf4cb5"
          display_name="snap-001"
          display_description="Daily backup"
          volume_id="521752a6-acf6-4b2d-bc7a-119f9148cd8c"
          status="available"
          size="30"
          created_at="2012-02-29T03:50:07Z" />

This operation does not accept a request body.

DELETE

/v2/{tenant_id}/os-snapshots/{snapshot_id}

Delete snapshot

Deletes a specified snapshot from the account.

This operation is asynchronous. You must list snapshots repeatedly to determine whether the snapshot was deleted.

Normal response codes

202

Error response codes

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

Request parameters

Parameter	Style	Type	Description
tenant_id	URI	xsd:string	The unique identifier of the tenant or account.
snapshot_id	URI	xsd:string	The unique identifier for a snapshot.

HTTP/1.1 202 Accepted
Content-Type: text/html; charset=UTF-8
Content-Length: 0
Date: Mon, 05 Dec 2011 16:23:10 GMT

This operation does not accept a request body.