Environments endpoint

Replace Environment

PUT/environments/{environmentId}/

Path parameters

environmentId

Identifier used by the registered route.

Request body

application/json

See the request guidance below for a valid body.

cURL template

curl --fail-with-body \
  -H "Authorization: Bearer ${AKOFLOW_API_TOKEN}" \
  -H "Content-Type: application/json" \
  --data-binary @request.json \
  -X PUT \
  "${AKOFLOW_API_URL}/environments/{environmentId}/"

Supply a valid request.json before running this command.

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

Handler-checked behavior

Read GET /environments/{environmentId}/ before editing and send a complete environment definition; environment.id must match the path ID. The response echoes the submitted definition, while the repository ignores connectionChecks and connectorBindings in it. Replacement returns 404 when the environment does not exist and can return 422 when references prevent replacing its inventory. Use new environment and version IDs for revised inventory already used by scopes or plans; see the environment YAML reference.

Related guide

See the Environments guide for related tasks and context.