Environments endpoint

Provision Cloud Instance

Send this request to the AkôFlow daemon. Authentication is required when an API token is configured.

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

Path parameters

environmentId

Identifier used by the registered route.

Body

application/json

capacityTargetId string

Field defined by domain.CloudProvisionRequest.

name string

Field defined by domain.CloudProvisionRequest.

sshUsername string

Field defined by domain.CloudProvisionRequest.

instanceId string

Field defined by domain.CloudProvisionRequest.

cURL

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

200 OKapplication/json

{
  "id": "string",
  "kind": "string",
  "status": "string",
  "environmentId": "string",
  "capacityTargetId": "string",
  "instanceId": "string",
  "executionRunId": "string",
  "activityId": "string",
  "phase": "string",
  "request": {
    "capacityTargetId": "string",
    "name": "string",
    "sshUsername": "string",
    "instanceId": "string"
  },
  "failureReason": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "startedAt": "2026-01-01T00:00:00Z",
  "finishedAt": "2026-01-01T00:00:00Z"
}

domain.CloudOperationRun

Related guide

See the Environments guide for the corresponding Desktop workflow, concepts, and authored request examples.

Generated from the daemon router

This page is generated from internal/api/httpserver/httpserver.go, the registered handler, and JSON-tagged Go structs. Method, path, request fields, response kind, query parameters, media type, and successful status codes stay synchronized with the implementation.