Create an instance type (operator-only).

POST

/v1/compute/instance-types

Code sample: Shell / cURL

curl --request POST \
  --url https://stratum.example.com/v1/compute/instance-types \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "displayName": "example", "description": "example", "vcpus": 1, "memoryBytes": 1, "networkPerformance": "example", "networkThroughputMbps": 1, "diskIops": 1, "diskThroughputMbps": 1, "defaultRootVolumeBytes": 1, "architecture": "amd64", "hypervisorDriver": "example", "tags": { "additionalProperty": "example" } }'

• A Stratum cluster endpoint.

Authorizations

• bearerAuth

Request Body^required

Media typeapplication/json

object

name

required

string

/^[a-z][a-z0-9]*\.[a-z0-9]+$/

displayName

string

description

string

vcpus

required

integer

>= 1

memoryBytes

required

integer format: int64

>= 1

networkPerformance

string

networkThroughputMbps

Per-NIC bandwidth cap in Mbps; omit for unlimited.

integer

nullable >= 1

diskIops

Per-instance disk IOPS ceiling; omit for unlimited.

integer

nullable >= 1

diskThroughputMbps

Per-instance disk bandwidth ceiling in megaBYTES/s; omit for unlimited. Megabytes, unlike networkThroughputMbps which is megabits.

integer

nullable >= 1

defaultRootVolumeBytes

integer format: int64

architecture

required

string

Allowed values: amd64 arm64

hypervisorDriver

required

string

tags

AWS-shape resource tags. Freeform UTF-8 keys (1-128 bytes, no leading/trailing whitespace) mapped to freeform UTF-8 values (0-256 bytes). Max 50 tags per resource. Reserved prefixes (stratum.dev/, stratum.platform_health., stratum:, aws:) return 400 RESERVED_NAMESPACE on customer input. PATCH replaces the whole map..

object

<= 50 properties

key

additional properties

string

<= 256 characters

Responses

201

Created.

Media typeapplication/json

object

id

required

string

/^itype-[a-z0-9-]+$/

name

required

AWS-shaped catalog name (e.g. m1.large).

string

/^[a-z][a-z0-9]*\.[a-z0-9]+$/

displayName

string

description

string

vcpus

required

integer

>= 1

memoryBytes

required

integer format: int64

>= 1

networkPerformance

Human-readable network performance hint (e.g. up to 10 Gbps).

string

networkThroughputMbps

Enforced per-NIC bandwidth cap in Mbps. null (or omitted) means unlimited — the back-compat path for instance-type rows created before.

integer

nullable >= 1

diskIops

Enforced per-instance disk IOPS ceiling, the other half of ’s noisy-neighbour story: vCPU and memory are capped by the type, network by networkThroughputMbps, and until this landed disk by nothing at all. null (or omitted) means unlimited.

Applied by the hypervisor as a qemu-level throttle (<iotune>), so it holds for both Ceph RBD and node-local LVM-thin volumes.

Stamped at launch and not re-applied. Editing this on a type does not re-throttle instances already running on it — the same behaviour as networkThroughputMbps.

integer

nullable >= 1

diskThroughputMbps

Enforced per-instance disk bandwidth ceiling in megaBYTES per second. Note the deliberate unit difference from networkThroughputMbps, which is megaBITS: each follows the convention of its own domain. null (or omitted) means unlimited.

Capping one axis without the other is supported and useful — an IOPS ceiling with no bandwidth ceiling throttles a random-IO neighbour without slowing a large sequential restore.

integer

nullable >= 1

defaultRootVolumeBytes

integer format: int64

architecture

required

string

Allowed values: amd64 arm64

hypervisorDriver

required

Driver kind that can launch this type (libvirt-kvm, cloud-hypervisor, firecracker, fake).

string

state

required

string

Allowed values: active deprecated removed

tags

AWS-shape resource tags. Freeform UTF-8 keys (1-128 bytes, no leading/trailing whitespace) mapped to freeform UTF-8 values (0-256 bytes). Max 50 tags per resource. Reserved prefixes (stratum.dev/, stratum.platform_health., stratum:, aws:) return 400 RESERVED_NAMESPACE on customer input. PATCH replaces the whole map..

object

<= 50 properties

key

additional properties

string

<= 256 characters

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

Example

{
  "architecture": "amd64",
  "state": "active"
}

400

Bad request.

Media typeapplication/problem+json

object

type

required

string format: uri

title

required

string

status

required

integer

>= 400 <= 599

detail

string

instance

string format: uri-reference

requestId

required

string

code

required

string

issues

The findings of a rejected IAM policy document (custom and resource policies).

Array<object>

One finding of a rejected IAM policy document. A rejection lists every finding, so the author fixes the document in one round trip.

object

code

required

The finding, e.g. INVALID_DOCUMENT, UNKNOWN_ACTION, ACTION_NOT_APPLICABLE.

string

statement

required

Index of the statement at fault; -1 for the document as a whole.

integer

>= -1

detail

required

string

action

The offending action, where one is at fault (ACTION_NOT_APPLICABLE).

string

errors

Field errors, for codes that carry them: each problem at its field (see FieldError). Documented on the responses that set it, e.g. approveNodeJoin’s INVALID_INPUT and JOIN_APPROVAL_REFUSED. Absent otherwise.

Array<object>

One field’s problem, the stage-2 installer API’s shape. field is the field’s path, message what is wrong with it.

object

field

required

The field’s path, e.g. links[0].interface, disks[1].confirm, mgmt.address or role; empty for the whole request.

string

message

required

string

details

Structured facts about the refusal, for codes that carry them. The shape is fixed per code and documented on the response that answers it, e.g. IMAGE_POOL_MISMATCH (see ImagePoolMismatchDetails) and IMAGE_IN_USE. Absent for codes that carry none.

object

key

additional properties

any

Example

{
  "issues": [
    {
      "code": "ACTION_NOT_APPLICABLE",
      "action": "compute:CreateVpc"
    }
  ]
}

409

Conflicting state.

Media typeapplication/problem+json

object

type

required

string format: uri

title

required

string

status

required

integer

>= 400 <= 599

detail

string

instance

string format: uri-reference

requestId

required

string

code

required

string

issues

The findings of a rejected IAM policy document (custom and resource policies).

Array<object>

One finding of a rejected IAM policy document. A rejection lists every finding, so the author fixes the document in one round trip.

object

code

required

The finding, e.g. INVALID_DOCUMENT, UNKNOWN_ACTION, ACTION_NOT_APPLICABLE.

string

statement

required

Index of the statement at fault; -1 for the document as a whole.

integer

>= -1

detail

required

string

action

The offending action, where one is at fault (ACTION_NOT_APPLICABLE).

string

errors

Field errors, for codes that carry them: each problem at its field (see FieldError). Documented on the responses that set it, e.g. approveNodeJoin’s INVALID_INPUT and JOIN_APPROVAL_REFUSED. Absent otherwise.

Array<object>

One field’s problem, the stage-2 installer API’s shape. field is the field’s path, message what is wrong with it.

object

field

required

The field’s path, e.g. links[0].interface, disks[1].confirm, mgmt.address or role; empty for the whole request.

string

message

required

string

details

Structured facts about the refusal, for codes that carry them. The shape is fixed per code and documented on the response that answers it, e.g. IMAGE_POOL_MISMATCH (see ImagePoolMismatchDetails) and IMAGE_IN_USE. Absent for codes that carry none.

object

key

additional properties

any

Example

{
  "issues": [
    {
      "code": "ACTION_NOT_APPLICABLE",
      "action": "compute:CreateVpc"
    }
  ]
}