Machines

Pause a Machine

Changed on

Requests an asynchronous pause of an active Machine. A paused Machine stops serving requests but keeps its ID, hostname, disk, and in-memory state.

post/machines/{id}/pause

Request

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

Path parameters

idstring required

The stable Machine ID (UUID).

Response

Accepted

$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