List regions

curl --request GET \
  --url https://api.example.com/api/v1/organizations/{organizationID}/regions \
  --header 'Authorization: Bearer <token>'

[
  {
    "metadata": {
      "id": "c7568e2d-f9ab-453d-9a3a-51375f78426b",
      "name": "uk-west-1",
      "description": "A top secret datacenter somewhere in the UK",
      "creationTime": "2023-07-31T10:45:45Z",
      "provisioningStatus": "provisioned",
      "healthStatus": "healthy"
    },
    "spec": {
      "type": "openstack",
      "features": {
        "physicalNetworks": true
      }
    }
  }
]

GET

api

organizations

{organizationID}

regions

List regions

curl --request GET \
  --url https://api.example.com/api/v1/organizations/{organizationID}/regions \
  --header 'Authorization: Bearer <token>'

[
  {
    "metadata": {
      "id": "c7568e2d-f9ab-453d-9a3a-51375f78426b",
      "name": "uk-west-1",
      "description": "A top secret datacenter somewhere in the UK",
      "creationTime": "2023-07-31T10:45:45Z",
      "provisioningStatus": "provisioned",
      "healthStatus": "healthy"
    },
    "spec": {
      "type": "openstack",
      "features": {
        "physicalNetworks": true
      }
    }
  }
]

Authorizations

Authorization

string

header

required

Operation requires OAuth 2.0 bearer token authentication.

Path Parameters

organizationID

string

required

The organization ID. A Kubernetes name. Must be a valid DNS containing only lower case characters, numbers or hyphens, start and end with a character or number, and be at most 63 characters in length.

Required string length: 1 - 63

Response

A list of regions.

metadata

object

required

Metadata required by all 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.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

Information about the region.

Show child attributes

spec.type

enum<string>

required

The region's provider type.

Available options:

openstack,

kubernetes

spec.features

object

required

A set of features the region may provide to clients.

Show child attributes

spec.features.physicalNetworks

boolean

required

If set, this indicates that the region supports physical networks and one should be provisioned for clusters to use. The implication here is the region supports base-metal machines, and these must be provisioned on a physical VLAN etc.

Download Fine-Tuned Model List flavors

⌘I

Serverless Inference

Fine Tuning

Compute

Networking and Storage

Organization

List regions

Authorizations

Path Parameters

Response