Create a Run schedule rule.

Create a new run schedule rule.

In order to create a run schedule rule, the user must have workspaces:set-schedule permission.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
data
object

A RunScheduleRule resource represents a rule for scheduling runs in a workspace.

Each RunScheduleRule is associated with a workspace and has a schedule and a schedule mode. The schedule is a cron expression that determines when runs should be triggered. The schedule mode determines whether the triggered run is an 'apply' 'destroy' or 'refresh' run.

Responses

403

Missing required permissions.

404

Relationship not found, or user unauthorized to perform action.

422

Malformed request body (missing attributes, wrong types, etc.)

4XX

Client error.

5XX

Server error.

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/vnd.api+json