Machines

Create a Machine

Creates a Machine from a workspace-owned OCI image. Execution placement is asynchronous. The root filesystem is ephemeral, and all filesystem changes are lost whenever execution stops or restarts.

post/machines

Request

Base URL: /v1 (relative, and the document was published on a file host, not at the API’s origin)
URL: /v1/machines
Auth: HTTP bearer

Request body

$schemastring uri

A URL to the JSON Schema for this object.

commandstring[] nullable

Optional argv that replaces the OCI image's default process arguments. Commands are executed directly without a shell.

image_idstring required

A workspace-owned OCI image ID.

machine_tierstring

Runtime tier: small, medium, large, or xlarge. Defaults to small.

regionstring

Region where the Machine runs. Defaults to de-fra-1.

Example request

{
  "$schema": "/v1/schemas/CreateMachineInputBody.json",
  "machine_tier": "small",
  "network": {
    "ingress": {
      "authenticated": {
        "key": "atlasflow",
        "ports": [
          "80",
          "443"
        ]
      },
      "public": {
        "ports": [
          "0-65535"
        ]
      }
    }
  },
  "region": "de-fra-1"
}

Response

Created

$schemastring uri

A URL to the JSON Schema for this object.

commandstring[] nullable

Optional argv that replaces the OCI image's default process arguments.

created_atstring date-time required

When the Machine was created.

desired_statestring required

The logical desired state.

hostnamestring required

The Machine hostname component. Access a port at https://machine-{hostname}-{port}.atlasflow.dev.

idstring required

The stable Machine ID.

machine_tierstring required

The runtime Machine tier.

regionstring required

The region where the Machine runs.

updated_atstring date-time required

When the Machine was last updated.

Example response

{
  "$schema": "/v1/schemas/MachineResponse.json",
  "network": {
    "ingress": {
      "authenticated": {
        "key": "atlasflow",
        "ports": [
          "80",
          "443"
        ]
      },
      "public": {
        "ports": [
          "0-65535"
        ]
      }
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.