Skip to main content
GET
/
containers
cURL
curl --request GET \
  --url https://app.beam.cloud/api/v1/gateway/containers \
  --header 'Authorization: Bearer <token>'
{
  "containers": [
    {
      "containerId": "<string>",
      "stubId": "<string>",
      "status": "<string>",
      "scheduledAt": "2023-11-07T05:31:56Z",
      "startedAt": "2023-11-07T05:31:56Z",
      "workspaceId": "<string>",
      "workerId": "<string>",
      "machineId": "<string>",
      "deploymentId": "<string>"
    }
  ],
  "ok": true,
  "errorMsg": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.beam.cloud/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

A successful response.

​
containers
object[]
​
ok
boolean
​
errorMsg
string