Skip to main content
GET
List basic VMs

Authorizations

Authorization
string
header
required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234_abcdef

Path Parameters

project_id
integer
required

Project ID.

Example:

1

Query Parameters

created_at
DateTimeRangeFilter · object

Filter by the creation time.

flavor_name
StringFilter · object

Filter by flavor name, e.g. flavor_name[prefix]=g2s-.

ids
string<uuid4>[]

Filter by basic VM IDs.

ip_address
IpAddressFilter · object

Filter by an IP address of a port of the basic VM.

limit
integer
default:100

Maximum number of items to return.

Required range: x <= 1000
name
StringFilter · object

Filter by name, e.g. name[contains]=web.

network_ids
string<uuid4>[]

Filter by the networks of the ports of the basic VM.

offset
integer
default:0

Number of items to skip.

Required range: x >= 0
order_by
enum<string>
default:created_at.desc

Sort field and direction.

Available options:
created_at.asc,
created_at.desc,
name.asc,
name.desc,
region_id.asc,
region_id.desc,
status.asc,
status.desc
region_ids
integer[]

Filter by region IDs. Omit it to get all regions.

security_group_ids
string<uuid4>[]

Filter by security group IDs.

statuses
enum<string>[]

Filter by statuses.

Lifecycle status of the resource. All resource types use the same values.

Available options:
active,
deleted,
deleting,
error,
provisioning,
rebooting,
rebuilding,
resizing,
stopped,
unknown,
updating
subnet_ids
string<uuid4>[]

Filter by subnet IDs.

tag_key
StringFilter · object

Filter by tag key regardless of value, e.g. tag_key[contains]=team.

tag_value
StringFilter · object

Filter by tag value regardless of key, e.g. tag_value[prefix]=prod.

tags
TagFilter · object

Filter by exact tag key-value pairs, e.g. tags[env]=prod&tags[team]=core. Repeat a key to match any of several values for it, e.g. tags[env]=prod&tags[env]=dev. Values for one key are ORed, different keys are ANDed; values match case-insensitively.

Example:
updated_at
DateTimeRangeFilter · object

Filter by the time of the last update.

Response

Basic VMs

count
integer
required

Number of objects

Required range: x >= 0
Example:

1

results
GlobalBasicVmSerializer · object[]
required

Objects