Skip to main content
GET
List instances

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

Range filter on creation time.

flavor_name
StringFilter · object

Operator flavor name filter.

ids
string<uuid4>[]

Filter by instance UUID(s).

ip_address
IpAddressFilter · object

Exact IP filter on a fixed IP.

limit
integer
default:100

Max items to return.

Required range: x <= 1000
managed
boolean

Filter by managed status. true = managed by a service, false = customer-operated.

managed_by
enum<string>

Filter by manager type, e.g. k8s_cluster.

Available options:
k8s_cluster
managed_by_resource_ids
string[]

Filter by managing resource ID(s).

managed_by_resource_names
string[]

Filter by managing resource name(s).

name
StringFilter · object

Operator name filter, e.g. name[contains]=web.

network_ids
string<uuid4>[]

Filter by network ID(s) the instance has a port on.

offset
integer
default:0

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 ID(s). Omit = all regions.

security_group_ids
string<uuid4>[]

Filter by security group ID(s).

statuses
enum<string>[]

Filter by lifecycle status(es).

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 ID(s).

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

Range filter on last-update time.

Response

Instances

count
integer
required

Number of objects

Required range: x >= 0
Example:

1

results
GlobalInstanceSerializer · object[]
required

Objects