Environments endpoint

Retrieve Environment

GET/environments/{environmentId}/

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

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.

{
  "environment": {
    "id": "string",
    "name": "string",
    "description": "string",
    "status": "string",
    "createdAt": "2026-01-01T00:00:00Z"
  },
  "version": {
    "id": "string",
    "environmentId": "string",
    "version": 0,
    "status": "string",
    "networkModel": "string",
    "interferenceModel": "string",
    "costModel": "string",
    "configurationHash": "string",
    "createdAt": "2026-01-01T00:00:00Z",
    "publishedAt": "2026-01-01T00:00:00Z"
  },
  "runtimes": [
    {
      "environmentVersionId": "string",
      "id": "string",
      "name": "string",
      "driver": "string",
      "mode": "string",
      "role": "string",
      "configuration": {},
      "capabilities": {}
    }
  ],
  "resources": [
    {
      "id": "string",
      "environmentVersionId": "string",
      "executionTarget": "string",
      "parentResourceId": "string",
      "type": "string",
      "name": "string",
      "providerId": "string",
      "tier": "string",
      "region": "string",
      "zone": "string",
      "architecture": "string",
      "cpuCores": 0,
      "cpuCapacity": 0,
      "memoryBytes": 0,
      "storageBytes": 0,
      "computeSpeedup": 0,
      "pricePerSecond": 0,
      "bootOverheadSeconds": 0,
      "containerOverheadSeconds": 0,
      "schedulable": true,
      "metadata": {}
    }
  ],
  "resourceRuntimeBindings": [
    {
      "resourceId": "string",
      "runtimeId": "string",
      "enabled": true,
      "configuration": {}
    }
  ],
  "resourceRelations": [
    {
      "environmentVersionId": "string",
      "sourceResourceId": "string",
      "targetResourceId": "string",
      "type": "string",
      "metadata": {}
    }
  ],
  "storages": [
    {
      "id": "string",
      "environmentVersionId": "string",
      "name": "string",
      "type": "string",
      "endpoint": "string",
      "capacityBytes": 0,
      "shared": true,
      "readOnly": true,
      "configuration": {},
      "credentialReference": "string",
      "metadata": {},
      "runtimeBindings": [],
      "browseRoots": [],
      "capabilities": {},
      "health": {},
      "indexPolicy": {},
      "indexStatus": {}
    }
  ],
  "activityResourceProfiles": [
    {
      "id": "string",
      "activityTypeId": "string",
      "resourceId": "string",
      "runtimeSeconds": 0,
      "runtimeStdDevSeconds": 0,
      "cpuUtilization": 0,
      "peakMemoryBytes": 0,
      "diskReadBytes": 0,
      "diskWriteBytes": 0,
      "energyJoules": 0,
      "source": "string",
      "sampleSize": 0,
      "modelVersion": "string",
      "metadata": {}
    }
  ],
  "connections": [
    {
      "id": "string",
      "environmentId": "string",
      "name": "string",
      "type": "string",
      "endpoint": "string",
      "username": "string",
      "credentialRef": "string",
      "configuration": {},
      "createdAt": "2026-01-01T00:00:00Z"
    }
  ],
  "connectionChecks": []
}

Handler-checked behavior

Returns the saved definition, including IDs filled from the enclosing environment/version. connectionChecks comes from recent connection-health records, not from the submitted YAML. The repository does not populate connectorBindings from that document.

Related guide

See the Environments guide for related tasks and context.