Skip to content

orchestration module route (requires orchestration:schedule:write)

POST
/v1/m/orchestration/schedules
curl --request POST \
--url https://example.com/v1/m/orchestration/schedules \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "approval_ref": "example", "cadence_spec": "example", "expected_interval_seconds": 1, "grace_factor": 1, "name": "example", "subject_kind": "agent", "subject_ref": "example", "trigger_kind": "cron" }'

Returns HTTP 501 with orchestration_unavailable because orchestration is a Business capability; no orchestration action is performed.

X-Olivares-Tenant
string format: uuid

Target tenant id; required when the principal can act in more than one tenant.

Media type application/json
object
approval_ref
Any of:
string
cadence_spec
Any of:
string
expected_interval_seconds
Any of:

Zero disables cadence-miss checks; otherwise 60..31622400 and trigger_kind must be cron.

integer format: int64
grace_factor
Any of:

Zero or omission selects the default of 2; otherwise the accepted range is 1..10.

integer format: int64
name
required

Must be non-empty; persistence byte-caps it.

string
>= 1 characters
subject_kind
required
string
Allowed values: agent swarm
subject_ref
required
string
>= 1 characters
trigger_kind
required
string
Allowed values: cron event manual

OK

Media type application/json
object
Example generated
{}

Bad request

Media type application/json
object
Example generated
{}

Unauthenticated

Media type application/json
object
Example generated
{}

Forbidden

Media type application/json
object
Example generated
{}

Not found

Media type application/json
object
Example generated
{}

Conflict / setup required

Media type application/json
object
Example generated
{}

Rate limited

Media type application/json
object
Example generated
{}