Route a control-plane action
1 min read
application/json- body
action*stringKnown action id advertised by GET /capabilities.
1 <= lengthorigin?stringOptional caller identifier echoed for correlation. Grants no authority.
1 <= lengthargs?Action-specific arguments. May be empty.
intentId?stringOptional caller-supplied correlation id echoed in the event. On
coven.automations.create, .update, and .delete it is also an
idempotency key: a repeat returns the first result, and a different
request with the same value is rejected.
1 <= lengthid?stringDefinition, run, occurrence, or receipt id. Required by get, delete,
runs, run, health, unquarantine, the definition get, health,
activate, pause, disable, and tombstone commands, run.get.v1,
occurrence.get.v1, and receipt.get.v1.
1 <= lengthlimit?integerOptional page size. coven.automations.runs defaults to 20;
history and occurrence reads accept 1 to 100 (default 20);
events.read.v1 accepts 1 to 1000 (default 100).
definition?Required routine definition for create, update, and the versioned create and revise commands.
adoptionKey?stringIdempotency key required by versioned automation mutations. The same request with the same key returns the first outcome; a different request with a used key is rejected.
^[A-Za-z0-9][A-Za-z0-9._:-]*$8 <= length <= 200expectedRevision?integerRequired by revise, activate, pause, disable, and tombstone; forbidden on create. A stale value returns REVISION_CONFLICT.
1 <= valuereason?stringOptional reason for activate, pause, and disable (at most 500 bytes). Required by run.cancel.v1.
automationId?stringRequired by run.history.v1 and occurrence.history.v1; optional filter for occurrence.list.v1.
1 <= lengthcursor?stringOpaque cursor.next value from a previous history page.
[key: string]?anyAction was accepted and completed.
application/json- response
ok*booleanaccepted*booleanWhether the action was accepted. A failed operation returns false.
action*stringEcho of the action id that was routed.
status*stringLifecycle status of the action. Only completed is returned for immediately-completed safe actions in coven.daemon.v1.
"completed""rejected"event?|nullreason?stringWhy the action was rejected, or a replay note.
result?Result of versioned automation commands, event pages, receipt reads, and coven.automations.command.v1.
error?Typed Coven Automations error returned by versioned automation actions and the owner-local transport check.
curl -X POST 'http://localhost:3000/api/v1/actions' \ -H 'Content-Type: application/json' \ -d '{ "action": "coven.capabilities.refresh", "origin": "coven-client", "intentId": "refresh-1"}'{ "ok": true, "accepted": true, "action": "coven.automations.health", "status": "completed", "event": { "kind": "automations.changed", "action": "coven.automations.health", "origin": "local-maintainer-tool", "intentId": "inspect-daily-notes-1", "payload": { "health": { "automationId": "daily-notes" } } }}Last updated on