Update a workflow | Docs

PUT

/workflows/{workflow_id}

Authentication

cookieSession

apiKey

required

Encrypted session cookie issued after registration or login.

cookie: session

csrfToken

apiKey

required

CSRF cookie issued with the session and required for state-changing requests.

cookie: csrf

All credentials in this group are required.

Parameters

workflow_id

path

required

No additional description.

string · uuid

Idempotency-Key

header

required

Valid UTF-8 containing 1-255 bytes after trimming only outer ASCII spaces (U+0020), with no Unicode control characters. Reuse a key only for retries of the exact same logical request.

stringmin length: 1

Request body

required

application/json

{
  "type": "object",
  "required": [
    "name",
    "payload",
    "interval",
    "max_consecutive_job_failures_allowed"
  ],
  "properties": {
    "name": {
      "type": "string"
    },
    "payload": {
      "type": "string",
      "description": "Workflow-kind-specific JSON encoded as a string"
    },
    "interval": {
      "type": "integer",
      "minimum": 1,
      "maximum": 10080,
      "description": "Schedule interval in minutes"
    },
    "max_consecutive_job_failures_allowed": {
      "type": "integer",
      "minimum": 3,
      "maximum": 100
    }
  }
}

Responses

204

Workflow updated

401

Missing or invalid session

404

Resource not found

409

Idempotency key was already used with a different logical request

413

Request body exceeds the 4 MiB ingress limit

429

Ingress rate or connection limit exceeded for the client address