Schedule a job immediately | Docs

POST

/workflows/{workflow_id}/jobs/schedule

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

Responses

201

Manual job created for a workflow owned by the caller that is not terminated and has completed its build

application/json

{
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    }
  }
}

401

Missing or invalid session

404

Resource not found

409

Idempotency key was already used with a different logical request

412

Current workflow or job state does not allow the operation

429

Ingress rate or connection limit exceeded for the client address