Compute API v2 extensions

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, …), 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, …), UnprocessableEntity (422), 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

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

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

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

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" />

Example Responses

{
    "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

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.

Example Requests

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

Example Responses

{
    "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

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

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

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

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

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

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

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

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

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 Trueto 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

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

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

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

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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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.

Example Requests

{
    "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

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

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

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

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

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

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

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

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

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

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.

Example Responses

{
    "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

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

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

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

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

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

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

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

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

Request parameters

Parameter Style Type Description
tenant_id URI xsd:string

The ID for the tenant or account in a multi-tenancy cloud.

Example Requests

{
    "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=="
            }
        ]
    }
}

Example Responses

{
    "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

Request parameters

Parameter Style Type Description
tenant_id URI xsd:string

The ID for the tenant or account in a multi-tenancy cloud.

Example Responses

{
    "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.

Example Responses

{
    "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

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.

Example Responses

{
    "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

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
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.

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

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

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

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

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
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.

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
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. 

{
    "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
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. 

{
    "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

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.

Example Requests

{
    "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
    }
}

Example Responses

{
    "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

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

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

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

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

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

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

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

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

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

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

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

Request parameters