Cloud endpoint

List Cloud Instances

GET/environments/{environmentId}/cloud-instances/

Path parameters

environmentId

Identifier used by the registered route.

Request body

none

This endpoint does not accept a request body.

cURL template

curl --fail-with-body \
  -H "Authorization: Bearer ${AKOFLOW_API_TOKEN}" \
  "${AKOFLOW_API_URL}/environments/{environmentId}/cloud-instances/"

Replace the path identifiers with IDs from your instance.

200 OKapplication/json

Field shape inferred from Go types; inspect the returned JSON for actual values and optional fields.

[
  {
    "id": "string",
    "capacityTargetId": "string",
    "environmentId": "string",
    "provider": "string",
    "providerId": "string",
    "name": "string",
    "status": "string",
    "publicAddress": "string",
    "privateAddress": "string",
    "sshUsername": "string",
    "sshCredentialRef": "string",
    "disk": {},
    "terraformOutput": {},
    "failureReason": "string",
    "createdAt": "2026-01-01T00:00:00Z",
    "readyAt": "2026-01-01T00:00:00Z",
    "destroyedAt": "2026-01-01T00:00:00Z",
    "billing": {
      "pricingStatus": "string",
      "priceCurrency": "string",
      "priceSource": "string",
      "priceObservedAt": "string",
      "priceRegion": "string",
      "priceMachineType": "string",
      "missingPrices": [
        "string"
      ],
      "startedAt": "2026-01-01T00:00:00Z",
      "finishedAt": "2026-01-01T00:00:00Z",
      "computeStartedAt": "2026-01-01T00:00:00Z",
      "accumulatedComputeSeconds": 0,
      "computePricePerSecond": 0,
      "diskPricePerSecond": 0,
      "asOf": "2026-01-01T00:00:00Z",
      "currentCost": 0
    }
  }
]

Handler-checked behavior

Returns this environment's saved instances newest first, including records marked destroyed. Inspect each instance's status and destroyedAt rather than treating the list length as the number of active VMs.

Related guide

See the Cloud guide for related tasks and context.