Cloud endpoint

Provision Cloud Instance

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

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

Supply a valid request.json before running this command.

Replace the path identifiers with IDs from your instance.

202 Acceptedapplication/json

Field shape inferred from Go types; inspect the returned JSON for actual values and optional fields.

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

Handler-checked behavior

Send a capacityTargetId for a target in this environment. name and sshUsername are optional; the server generates an instanceId when omitted. 202 Accepted means the operation was queued. Target ownership, connection, and credential checks run later, as does VM provisioning. Inspect the returned operation's status, failure reason, and events; an active provision for the same target returns the existing operation. Follow the GCP guide for account-specific setup.

Related guide

See the Cloud guide for related tasks and context.