Skip to main content
POST
Execute server state transition

Authorizations

Authorization
string
header
required

Bearer token authentication using OAuth2/OIDC tokens

Path Parameters

region
string
required

Region identifier

project
string
required

Project identifier

id
string<uuid>
required

Unique server identifier (UUID)

action
string
required

Lifecycle transition action

Body

application/json

Action-specific parameters

Response

Action executed successfully

Bare metal server resource

Server-defined URL for this resource.

Example:

"/v1/regions/us-texas-1/projects/project-x9y8z7/infrastructure/servers/server-p7q8r9"

uid
string<uuid>
read-only

Server-generated UUID.

id
string

Name of the resource. Provided by the client when the resource is created, or generated by the server if not specified. Must be 1-63 characters long and match the pattern a-z [blocked]? — the first character must be a lowercase letter, and all following characters must be lowercase letters, digits, or hyphens, with the last character being a letter or digit. Cannot be changed after the resource is created.

Required string length: 1 - 63
Pattern: ^[a-z]([-a-z0-9]*[a-z0-9])?$
Example:

"server-p7q8r9"

displayName
string

Optional human-friendly display name for the server.

description
string

An optional description of this resource.

hardwareSpecs
object

Hardware specifications

bmcAddress
string

Baseboard Management Controller address

provisioningState
enum<string>

Current provisioning state

Available options:
registered,
provisioning,
ready,
failed,
decommissioned
healthStatus
object

Host health information

tags
object

Host metadata tags

persona
string

Assigned persona/role for the host

createdAt
string<date-time>

Creation timestamp

updatedAt
string<date-time>

Last update timestamp