Sign in
Machines

Get a Machine

Returns an active Machine by its stable ID from the caller's current workspace. The internal execution VM and IP are not exposed. Root filesystem changes are lost whenever execution stops or restarts.

get/machines/{id}

Request

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

Path parameters

idstring required

The stable Machine ID (UUID).

Response

OK

$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.