Skip to content

Enables/disables/retargets a schedule (write-tier, self-audited).

PATCH
/v1/m/orchestration/schedules/{id}
curl --request PATCH \
--url https://example.com/v1/m/orchestration/schedules/example \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "approval_ref": "example", "cadence_spec": "example", "desired_status": "active", "expected_interval_seconds": 1, "grace_factor": 1, "subject_ref": "example" }'

Enables/disables/retargets a schedule (write-tier, self-audited).

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
cadence_spec
Any of:
string
desired_status
Any of:
string
Allowed values: active paused retired
expected_interval_seconds
Any of:

Zero disables cadence-miss checks; otherwise the accepted range is 60..31622400.

integer format: int64
grace_factor
Any of:
integer format: int64
>= 1 <= 10
subject_ref
Any of:
string

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