Update an automation's status

patch

https://api.qfp.quantnetwork.net/api/automations/{automationId}/status

Changes an automation's lifecycle status. Allowed transitions: ACTIVE → INACTIVE, INACTIVE → ACTIVE, INACTIVE → DISABLED; DISABLED is terminal. Any other transition is rejected with 400, including setting the status the automation already holds. The change is recorded in the automation's history.

A TIME automation is registered with the scheduler when it becomes ACTIVE and unregistered on every other target status.

A soft-deleted automation is still resolved, so a transition away from DELETED is rejected with 400. DELETED is reached through DELETE /api/automations/{automationId}, not through this endpoint.

Path Params

automationId

uuid

required

Id of the automation.

Body Params

status

string

enum

required

Target lifecycle status. Allowed transitions: ACTIVE→INACTIVE, INACTIVE→ACTIVE, INACTIVE→DISABLED. DISABLED is terminal; any other transition is rejected with 400.

Allowed:

Headers

API-Version

string

^\d+\.\d+\.\d+$

Version of the API contract the client targets, in MAJOR.MINOR.PATCH format. Mandated by the Gateway standard. Not yet enforced: requests without the header, or with an unsupported value, are currently processed normally. Once enforcement is enabled, such requests will be rejected with 400 Bad Request.

Idempotency-Key

string

required

length ≥ 1

Required on every POST, PUT and PATCH. A client-generated key: retrying with the same key returns the original response without running the request again. Scoped per tenant, user, method and path. A missing or blank key is rejected with 400.

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The updated automation.

400The status is missing, the requested transition is not allowed for the automation's current state (including the status it already holds, and any transition away from DELETED), or a missing/blank Idempotency-Key header.

404No automation with this id exists.

409A request with the same Idempotency-Key is already being processed.