Planning endpoint

Create Plan

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

POST/schedule-plans/

Body

application/json

plan object

Field defined by CreatePlanRequest.

workflow object

Field defined by CreatePlanRequest.

resources array

Field defined by CreatePlanRequest.

executionScope object

Field defined by CreatePlanRequest.

networkTopology object

Field defined by CreatePlanRequest.

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}/schedule-plans/"

201 Createdapplication/json

{
  "plan": {
    "id": "string",
    "workflowVersionId": "string",
    "executionScopeId": "string",
    "networkTopologyId": "string",
    "source": "string",
    "algorithm": "string",
    "algorithmVersion": "string",
    "objective": "string",
    "deadlineSeconds": 0,
    "budget": 0,
    "predicted": {
      "makespanSeconds": 0,
      "cost": 0,
      "feasible": true
    },
    "assignments": [
      "string"
    ],
    "lifecycleActions": [
      "string"
    ],
    "assignmentCount": 0,
    "metadata": {}
  },
  "workflow": {
    "id": "string",
    "workflowId": "string",
    "version": 0,
    "definitionHash": "string",
    "activities": [
      "string"
    ],
    "dependencies": [
      "string"
    ],
    "dataDependencies": [
      "string"
    ]
  },
  "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": {}
    }
  ],
  "executionScope": {
    "id": "string",
    "name": "string",
    "networkTopologyId": "string",
    "environmentVersionIds": [
      "string"
    ],
    "metadata": {}
  },
  "networkTopology": {
    "id": "string",
    "name": "string",
    "version": 0,
    "executionScopeId": "string",
    "links": [
      "string"
    ],
    "metadata": {}
  }
}

CreatePlanRequest

Related guide

See the Planning 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.