Skip to content
Stratum Docs
Search
Ctrl
K
Cancel
Documentation version
Stratum 0.7.0
Content width
Normal
Wide
Full
Select theme
Dark
Light
Auto
Menu
Documentation
stratumctl
API
API
Overview
meta
iam
platform
regions
audit
network
compute
Overview
Download a node's node.yaml, secrets redacted (bootstrap-admin).
GET
A node's hardware plan next to what it reports (bootstrap-admin).
GET
Change disk roles and link purposes in a node's hardware plan (bootstrap-admin).
PATCH
List instance types (customer-readable, operator-managed).
GET
Create an instance type (operator-only).
POST
Describe an instance type.
GET
Deprecate an instance type (stops new launches).
POST
Re-activate a deprecated instance type.
POST
Remove an instance type (terminal; refused while live instances reference it).
POST
List key pairs in a project.
GET
Import a key pair (public key only).
POST
Describe a key pair.
GET
Delete a key pair. Running instances keep working — only new launches are affected.
DELETE
List placement groups in a project.
GET
Create a placement group.
POST
Describe a placement group.
GET
Delete a placement group. Members keep running and are never relocated.
DELETE
Read the explicit custom-shape policy at a scope.
GET
Upsert the custom-shape policy at a scope.
PUT
Resolve the effective custom-shape policy for a launch.
GET
List the project's image recipes.
GET
Create an image recipe.
POST
Describe an image recipe.
GET
Replace an image recipe.
PUT
Delete an image recipe.
DELETE
Start a build of the recipe.
POST
List a recipe's builds, newest first.
GET
Describe an image build.
GET
Cancel an in-flight build.
POST
Get an instance's in-VM agent liveness.
GET
List an instance's Session Manager sessions.
GET
Open a Session Manager session into the instance.
POST
Run a command on one or more instances (non-interactive).
POST
Upgrade the in-VM agent in place on one or more instances.
POST
Describe one Session Manager session.
GET
Close a Session Manager session.
DELETE
Get the project's effective Session Manager concurrent-session quota.
GET
Set or clear a project's Session Manager concurrent-session quota override.
PATCH
List instances in a project.
GET
Launch an instance.
POST
Describe an instance.
GET
Update mutable instance attributes (display name, tags, protection flags).
PATCH
Start a stopped instance (async).
POST
Stop a running instance (async). Refused while `stopProtection` is set.
POST
Reboot a running instance (async; ACPI reset).
POST
Resize a STOPPED instance's vCPU/memory shape.
POST
Migrate an instance to another node — cold (stopped) or live (running).
POST
List an instance's migration records.
GET
Where this instance can live-migrate to, and why not elsewhere.
GET
Describe a migration by id.
GET
Modify an instance's IMDS metadata options.
POST
Swap a running instance's instance profile.
POST
Force-revoke an instance's IMDS-minted credentials.
POST
Enable the in-VM agent on an existing instance.
POST
Disable the in-VM agent on an existing instance.
POST
Terminate an instance (async; soft-deleted for 7d). Refused while `terminationProtection` is set.
POST
operator escape hatch: terminate an instance regardless of its current lifecycle state. Unlike the normal terminate action (which the state machine allows from `creating`, `running`, `stopped`, or `error`), this walks an instance wedged in one of the remaining transitional states (`stopping`, `starting`, `rebooting`, `migrating`) straight to `terminating`, then tears down whatever partial substrate exists (auto-NIC + its OVN port, volumes, auto-FIP, a half-defined domain) best-effort. Still refused (409) while `terminationProtection` is set — force overrides the state gate, not that deliberate flag.
POST
retry an instance stuck in `error`. Flips the row back to `creating` so the lifecycle worker re-drives the full creation pipeline against the existing row (id + name + IPs + volume attachments preserved). Refused (409 INVALID_STATE) on any state besides `error`.
POST
Return the raw cloud-init user-data the instance was launched with (or had set via a subsequent PUT).
GET
Replace the cloud-init user-data on a STOPPED instance.
PUT
Return the rendered NoCloud seed (system meta-data + customer user-data) the next boot will see.
GET
Open a serial-console session.
POST
Open a VNC graphical-console session.
POST
How many more of each instance type the cluster can place.
GET
List hypervisor nodes (operator-only).
GET
Describe a hypervisor node (operator-only).
GET
Update a node's display name or its reservation.
PATCH
Report a hypervisor-agent heartbeat (agent-only).
PUT
List instances placed on a hypervisor node (operator-only, cross-project).
GET
Cordon a node (stop new placements).
POST
Drain a node — stop new placements and evacuate its instances.
POST
What draining this node would do to each of its instances.
GET
Flag a node for maintenance (preserved across heartbeats).
POST
Return a node to ready from cordoned/draining/maintenance/unknown.
POST
Shut a node down (power off), gracefully.
POST
Reboot a node, gracefully.
POST
List a node's block devices (operator-only).
GET
List a node's physical NICs (operator-only).
GET
List a node's memory modules / DIMMs (operator-only).
GET
List a node's temperature sensors (operator-only).
GET
List a node's PCI devices (operator-only).
GET
Wipe a disk's signatures so it can join a pool (operator-only).
POST
Write a fresh GPT label on a disk (operator-only).
POST
Create a partition in a disk's free space (operator-only).
POST
Grow a partition into trailing free space (operator-only).
POST
Raw LVM diagnostic view of a node (operator-only).
GET
storage
lb
dns
observability
backup
ssh-ca
operations
quotas
inventory
advisor
secrets
asg
db
admin
backup-admin
observability-admin
join
Documentation version
Stratum 0.7.0
Content width
Normal
Wide
Full
Select theme
Dark
Light
Auto
Overview
compute
Section titled “compute”
Instances, instance types, key pairs, images, custom-shape policy.
Operations
Section titled “Operations”
GET
/v1/admin/nodes/{nodeId}/config
GET
/v1/admin/nodes/{nodeId}/hardware-plan
PATCH
/v1/admin/nodes/{nodeId}/hardware-plan
GET
/v1/compute/instance-types
POST
/v1/compute/instance-types
GET
/v1/compute/instance-types/{instanceTypeName}
POST
/v1/compute/instance-types/{instanceTypeName}/actions/deprecate
POST
/v1/compute/instance-types/{instanceTypeName}/actions/activate
POST
/v1/compute/instance-types/{instanceTypeName}/actions/remove
GET
/v1/projects/{projectId}/compute/key-pairs
POST
/v1/projects/{projectId}/compute/key-pairs
GET
/v1/projects/{projectId}/compute/key-pairs/{keyId}
DELETE
/v1/projects/{projectId}/compute/key-pairs/{keyId}
GET
/v1/projects/{projectId}/compute/placement-groups
POST
/v1/projects/{projectId}/compute/placement-groups
GET
/v1/projects/{projectId}/compute/placement-groups/{pgId}
DELETE
/v1/projects/{projectId}/compute/placement-groups/{pgId}
GET
/v1/admin/compute/custom-shape-policies/{scope}/{scopeId}
PUT
/v1/admin/compute/custom-shape-policies/{scope}/{scopeId}
GET
/v1/projects/{projectId}/regions/{region}/custom-shape-policy
GET
/v1/projects/{projectId}/compute/image-recipes
POST
/v1/projects/{projectId}/compute/image-recipes
GET
/v1/projects/{projectId}/compute/image-recipes/{recipeId}
PUT
/v1/projects/{projectId}/compute/image-recipes/{recipeId}
DELETE
/v1/projects/{projectId}/compute/image-recipes/{recipeId}
POST
/v1/projects/{projectId}/compute/image-recipes/{recipeId}/actions/build
GET
/v1/projects/{projectId}/compute/image-recipes/{recipeId}/builds
GET
/v1/projects/{projectId}/compute/image-builds/{buildId}
POST
/v1/projects/{projectId}/compute/image-builds/{buildId}/actions/cancel
GET
/v1/projects/{projectId}/compute/instances/{instanceId}/agent-status
GET
/v1/projects/{projectId}/compute/instances/{instanceId}/sessions
POST
/v1/projects/{projectId}/compute/instances/{instanceId}/sessions
POST
/v1/projects/{projectId}/compute/run-command
POST
/v1/projects/{projectId}/compute/instances/actions/refresh-agent
GET
/v1/projects/{projectId}/compute/instances/{instanceId}/sessions/{sessionId}
DELETE
/v1/projects/{projectId}/compute/instances/{instanceId}/sessions/{sessionId}
GET
/v1/projects/{projectId}/compute/session-quota
PATCH
/v1/admin/compute/projects/{projectId}/session-quota
GET
/v1/projects/{projectId}/compute/instances
POST
/v1/projects/{projectId}/compute/instances
GET
/v1/projects/{projectId}/compute/instances/{instanceId}
PATCH
/v1/projects/{projectId}/compute/instances/{instanceId}
POST
/v1/projects/{projectId}/compute/instances/{instanceId}/actions/start
POST
/v1/projects/{projectId}/compute/instances/{instanceId}/actions/stop
POST
/v1/projects/{projectId}/compute/instances/{instanceId}/actions/reboot
POST
/v1/projects/{projectId}/compute/instances/{instanceId}/actions/resize
POST
/v1/projects/{projectId}/compute/instances/{instanceId}/actions/migrate
GET
/v1/projects/{projectId}/compute/instances/{instanceId}/migrations
GET
/v1/projects/{projectId}/compute/instances/{instanceId}/migration-destinations
GET
/v1/projects/{projectId}/compute/migrations/{migrationId}
POST
/v1/projects/{projectId}/compute/instances/{instanceId}/actions/modify-metadata-options
POST
/v1/projects/{projectId}/compute/instances/{instanceId}/actions/replace-instance-profile
POST
/v1/projects/{projectId}/compute/instances/{instanceId}/actions/revoke-credentials
POST
/v1/projects/{projectId}/compute/instances/{instanceId}/actions/enable-agent
POST
/v1/projects/{projectId}/compute/instances/{instanceId}/actions/disable-agent
POST
/v1/projects/{projectId}/compute/instances/{instanceId}/actions/terminate
POST
/v1/projects/{projectId}/compute/instances/{instanceId}/actions/force-terminate
POST
/v1/projects/{projectId}/compute/instances/{instanceId}/actions/retry
GET
/v1/projects/{projectId}/compute/instances/{instanceId}/user-data
PUT
/v1/projects/{projectId}/compute/instances/{instanceId}/user-data
GET
/v1/projects/{projectId}/compute/instances/{instanceId}/cloud-init/preview
POST
/v1/projects/{projectId}/compute/instances/{instanceId}/actions/console-serial
POST
/v1/projects/{projectId}/compute/instances/{instanceId}/actions/console-vnc
GET
/v1/compute/capacity
GET
/v1/compute/nodes
GET
/v1/compute/nodes/{nodeId}
PATCH
/v1/compute/nodes/{nodeId}
PUT
/v1/compute/nodes/{nodeId}/heartbeat
GET
/v1/compute/nodes/{nodeId}/instances
POST
/v1/compute/nodes/{nodeId}/actions/cordon
POST
/v1/compute/nodes/{nodeId}/actions/drain
GET
/v1/compute/nodes/{nodeId}/evacuation-plan
POST
/v1/compute/nodes/{nodeId}/actions/enter-maintenance
POST
/v1/compute/nodes/{nodeId}/actions/uncordon
POST
/v1/compute/nodes/{nodeId}/actions/shutdown
POST
/v1/compute/nodes/{nodeId}/actions/reboot
GET
/v1/compute/nodes/{nodeId}/disks
GET
/v1/compute/nodes/{nodeId}/network-interfaces
GET
/v1/compute/nodes/{nodeId}/memory-modules
GET
/v1/compute/nodes/{nodeId}/thermals
GET
/v1/compute/nodes/{nodeId}/pci-devices
POST
/v1/compute/nodes/{nodeId}/disks/{disk}/actions/wipe
POST
/v1/compute/nodes/{nodeId}/disks/{disk}/actions/init-gpt
POST
/v1/compute/nodes/{nodeId}/disks/{disk}/actions/create-partition
POST
/v1/compute/nodes/{nodeId}/disks/{disk}/partitions/{n}/actions/resize
GET
/v1/compute/nodes/{nodeId}/lvm