Environments endpoint

Create Environment

POST/environments/

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 POST \
  "${AKOFLOW_API_URL}/environments/"

Supply a valid request.json before running this command.

201 Createdapplication/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"
    }
  ]
}

Runnable SimGrid request

The first-run tutorial submits akoflow-examples/simulation/environment.yaml in a six-request sequence. Follow that order so referenced IDs exist.

Handler-checked behavior

The response echoes the submitted definition. The repository saves the environment, version, inventory, storage, and connections, but ignores connectionChecks and connectorBindings if they appear in the body. Read GET /environments/{environmentId}/ for saved IDs and separately recorded connection checks. See the environment YAML reference.

Related guide

See the Environments guide for related tasks and context.