Cloud endpoint

Retrieve Cloud Instance

GET/cloud-instances/{instanceId}/

Path parameters

instanceId

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}/cloud-instances/{instanceId}/"

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
  }
}

Related guide

See the Cloud guide for related tasks and context.