Cloud endpoint

Create Cloud Capacity Target

POST/environments/{environmentId}/cloud-capacity-targets/

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-capacity-targets/"

Supply a valid request.json before running this command.

Replace the path identifiers with IDs from your instance.

201 Createdapplication/json

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

{
  "id": "string",
  "environmentId": "string",
  "name": "string",
  "provider": "string",
  "providerMachineType": "string",
  "region": "string",
  "zonePolicy": "string",
  "fixedZone": "string",
  "imageReference": "string",
  "architecture": "string",
  "vcpu": 0,
  "memoryMiB": 0,
  "provisioningMode": "string",
  "maximumInstances": 0,
  "lifecyclePolicy": "string",
  "configuration": {},
  "machineConfigurations": [
    {
      "configurationVersionId": "string",
      "executionOrder": 0,
      "variables": {},
      "required": true,
      "enabled": true
    }
  ],
  "enabled": true,
  "createdAt": "2026-01-01T00:00:00Z"
}

Handler-checked behavior

Use an existing cloud environment with a cloud runtime. Send name, providerMachineType, and imageReference. The server supplies an omitted id, sets environmentId from the path, and enables the target.

Choose the provider-specific region, image, machine type, and network policy using the GCP guide. Set configuration.projectId to the validated project; Terraform reads it from the target, not the connection. The built-in worker requires amd64. Set fixedZone if needed; otherwise Terraform uses the first active zone in the region. The stored zonePolicy does not affect that choice. Set approved configuration.sshSourceRanges before provisioning; otherwise the Terraform target defaults SSH ingress to 0.0.0.0/0.

This route creates a schedulable capacity resource, not a VM. If it returns 422, inspect the target list before retrying: the target can be saved before resource binding fails.

Related guide

See the Cloud guide for related tasks and context.