Query parameters

  • cursor string

    A cursor returned from a previous call to /machines/{machineSlug}/i

Responses

  • 200

    The instances of this machine

    Hide response attributes Show response attributes object
    • instances array[object] Required
      Hide instances attributes Show instances attributes
      • slug string Required

        An identifier for the machine instance. Must be unique within the instances for the associated machine definition.

        Minimum length is 1. Format should match the following pattern: ^[a-zA-Z0-9_-]{1,128}$.

      • createdAt string(date-time) Required
      • status string Required

        The status of a machine instance.

        Values are running or paused.

      • machineVersion object Required
        Hide machineVersion attributes Show machineVersion attributes
    • cursor string

      The cursor to use on the next call to retrieve the next page of instances. If no cursor is returned, there are no more pages to retrieve.

GET /machines/{machineSlug}/i
curl \
 -X GET https://api.statebacked.dev/machines/{machineSlug}/i \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
{
  "instances": [
    {
      "slug": "user-1234",
      "createdAt": "2023-05-04T09:42:00+00:00",
      "status": "running",
      "machineVersion": {
        "id": "string",
        "createdAt": "2023-05-04T09:42:00+00:00",
        "clientInfo": "string"
      }
    }
  ],
  "cursor": "string"
}