Get a single cloud-instance by id

GET

/cloud-instances/{id}

• Current canonical versioned path (F3.API.01)

Authorizations

• bearerAuth
• apiTokenAuth

Parameters

Path Parameters

id

required

string

DocumentId

Responses

200

OK

object

data

object

name

required

string

>= 1 characters <= 120 characters

provider

required

string

Allowed values: hetzner ovhcloud aws gcp azure scaleway upcloud digitalocean

region

required

string

instance_type

required

string

os_image

Provider OS image / snapshot identifier requested at create time (mapped to cloudConfig.imageId in the provision message).

string

root_disk_gb

Requested root/boot disk size in GB (mapped to cloudConfig.rootDiskGb).

integer

additional_disks

Optional extra data volumes requested at create time: array of { sizeGb, type?, label? } (mapped to cloudConfig.additionalDisks).

status

required

string

Allowed values: pending provisioning running starting stopping stopped terminating terminated failed imported

ip_address

string

ipv6_address

string

metadata

Arbitrary JSON value (object, array, string, number, boolean, or null)

error_message

string

monthly_cost

number

currency

required

string

Allowed values: EUR USD CZK GBP

external_id

Provider-specific instance identifier (e.g. Hetzner server ID, AWS instance-id). For source=‘terraform’ this is the Terraform resource address (e.g. “aws_instance.web”) — used as the IaC-import dedup key (F3.IMPORT.01).

string

source

required

Provenance of this record: ‘sencai’ = provisioned through cloud-connector (default); ‘terraform’ = imported from an existing terraform.tfstate (F3.IMPORT.01, IMPORT ONLY — never generates/exports .tf).

string

Allowed values: sencai terraform

provisioned_at

string format: date-time

terminated_at

string format: date-time

organisation

One of:

string

DocumentId reference to api::organisation.organisation

string

object

object

key

additional properties

any

created_by_user

One of:

string

DocumentId reference to plugin::users-permissions.user

string

object

object

key

additional properties

any

connector_status

One of:

string

DocumentId reference to api::cloud-connector-status.cloud-connector-status

string

object

object

key

additional properties

any

cloud_credential

One of:

string

DocumentId reference to api::cloud-credential.cloud-credential

string

object

object

key

additional properties

any

network

One of:

string

DocumentId reference to api::cloud-network.cloud-network

string

object

object

key

additional properties

any

subnet

One of:

string

DocumentId reference to api::cloud-subnet.cloud-subnet

string

object

object

key

additional properties

any

security_groups

One of:

string

DocumentId reference to api::cloud-security-group.cloud-security-group

string

object

object

key

additional properties

any

agents

One of:

string

DocumentId reference to api::sencai-agent.sencai-agent

string

object

object

key

additional properties

any

home_region

required

Logical data-residency region of the tenant (CELL invariant, F2.CELL.01)

string

Allowed values: eu us apac

cell_id

Deployment cell within home_region for blast-radius isolation (CELL invariant, F2.CELL.01)

string

documentId

string

id

integer

createdAt

string format: date-time

updatedAt

string format: date-time

publishedAt

string format: date-time

nullable

401

Missing or invalid authentication

403

Not authorized (tenant scope or capability)

404

Not found