List instances

curl --request GET \
  --url https://api.example.com/api/v2/instances \
  --header 'Authorization: Bearer <token>'

[
  {
    "metadata": {
      "id": "c7568e2d-f9ab-453d-9a3a-51375f78426b",
      "name": "my-host",
      "organizationId": "d4600d6e-e965-4b44-a808-84fb2fa36702",
      "projectId": "cae219d7-10e5-4601-8c2c-ee7e066b93ce",
      "creationTime": "2023-07-31T10:45:45Z",
      "provisioningStatus": "provisioned",
      "healthStatus": "healthy"
    },
    "spec": {
      "flavorId": "c7568e2d-f9ab-453d-9a3a-51375f78426b",
      "imageId": "a10e30e8-006a-48e6-a3c7-3c9416891f31",
      "networking": {
        "publicIP": true,
        "securityGroups": [
          "dd5954af-1d71-4abf-bb16-5729c7163886"
        ]
      }
    },
    "status": {
      "regionId": "bb518c64-6856-4d67-a799-314ba668649f",
      "networkId": "b059b3e6-9ae5-42b7-94b4-f42fb7a6baee",
      "privateIP": "192.168.0.3",
      "publicIP": "183.45.68.162",
      "powerState": "Running"
    }
  }
]

GET

api

instances

List instances

curl --request GET \
  --url https://api.example.com/api/v2/instances \
  --header 'Authorization: Bearer <token>'

[
  {
    "metadata": {
      "id": "c7568e2d-f9ab-453d-9a3a-51375f78426b",
      "name": "my-host",
      "organizationId": "d4600d6e-e965-4b44-a808-84fb2fa36702",
      "projectId": "cae219d7-10e5-4601-8c2c-ee7e066b93ce",
      "creationTime": "2023-07-31T10:45:45Z",
      "provisioningStatus": "provisioned",
      "healthStatus": "healthy"
    },
    "spec": {
      "flavorId": "c7568e2d-f9ab-453d-9a3a-51375f78426b",
      "imageId": "a10e30e8-006a-48e6-a3c7-3c9416891f31",
      "networking": {
        "publicIP": true,
        "securityGroups": [
          "dd5954af-1d71-4abf-bb16-5729c7163886"
        ]
      }
    },
    "status": {
      "regionId": "bb518c64-6856-4d67-a799-314ba668649f",
      "networkId": "b059b3e6-9ae5-42b7-94b4-f42fb7a6baee",
      "privateIP": "192.168.0.3",
      "publicIP": "183.45.68.162",
      "powerState": "Running"
    }
  }
]

Authorizations

Authorization

string

header

required

Operation requires OAuth 2.0 bearer token authentication.

Query Parameters

tag

string[]

A set of tags to match against resources in the form "name=value", thus when encoded you get "?tag=foo%3Dcat&tag=bar%3Ddog".

organizationID

string[]

Allows resources to be filtered by organization.

projectID

string[]

Allows resources to be filtered by project.

regionID

string[]

Allows resources to be filtered by region.

networkID

string[]

Allows resources to be filtered by network.

Response

A list of compute instances.

metadata

object

required

Metadata required by project scoped resource reads.

Show child attributes

metadata.name

string

required

A valid Kubernetes label value, typically used for resource names that can be indexed in the database.

metadata.id

string

required

The unique resource ID.

metadata.creationTime

string<date-time>

required

The time the resource was created.

metadata.provisioningStatus

enum<string>

required

The provisioning state of a resource.

Available options:

unknown,

provisioning,

provisioned,

deprovisioning,

error

metadata.healthStatus

enum<string>

required

The health state of a resource.

Available options:

unknown,

healthy,

degraded,

error

metadata.organizationId

string

required

The organization identifier the resource belongs to.

metadata.projectId

string

required

The project identifier the resource belongs to.

metadata.description

string

The resource description, this optionally augments the name with more context.

metadata.tags

object[]

A list of tags.

Show child attributes

metadata.tags.name

string

required

A unique tag name.

metadata.tags.value

string

required

The value of the tag.

metadata.createdBy

string

The user who created the resource.

metadata.modifiedTime

string<date-time>

The time a resource was updated.

metadata.modifiedBy

string

The user who updated the resource.

metadata.deletionTime

string<date-time>

The time the resource was deleted.

spec

object

required

A compute instance.

Show child attributes

spec.flavorId

string

required

The flavor CPU/RAM of a compute instance.

spec.imageId

string

required

The image of a compute instance.

spec.networking

object

A compute instance's network configuration.

Show child attributes

spec.networking.securityGroups

string[]

A list of security group IDs.

A security group ID.

spec.networking.publicIP

boolean

Whether or not to provision a public IP.

spec.networking.allowedSourceAddresses

string[]

A list of network prefixes that are allowed to egress from the server. By default, only packets from the server's network interface's IP address are allowed to enter the network. Use of this option allows the server to act as a router without SNAT rules.

An allowed source address prefix.

spec.userData

string<byte>

Contains base64-encoded configuration information or scripts to use upon launch. The format of the data is governed by the cloud-init standard, and may be a script, a MIME multipart archive, etc.

status

object

required

Read only status information about a compute instance.

Show child attributes

status.regionId

string

required

The region a security group belongs to.

status.networkId

string

required

The network a security group belongs to.

status.powerState

enum<string>

The lifecycle phase of an instance.

Available options:

Pending,

Running,

Stopping,

Stopped

status.privateIP

string

The private IP address of the server.

status.publicIP

string

The public IP address of the server.

List images Create instance

⌘I

Serverless Inference

Fine Tuning

Compute

Networking and Storage

Organization

List instances

Authorizations

Query Parameters

Response