Skip to content

orchestration module route (requires orchestration:schedule:admin)

POST
/v1/m/orchestration/schedules/{id}/fire
curl --request POST \
--url https://example.com/v1/m/orchestration/schedules/example/fire \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "approval_ref": "example" }'

Fires one schedule out of band; an empty body requests approval first, and a body carries the approved run.

id
required
string

Path parameter id.

X-Olivares-Tenant
string format: uuid

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

Media type application/json
Any of:
object
approval_ref
Any of:
string
Example generated
{
"approval_ref": "example"
}

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
{}