Authentication

Determines whether this parameter must be set.

Regular expression used to determine if a parameter is valid.

Unique ID of the runbook. You can find your runbook's ID by visiting the runbook's page on Airplane.
The runbook ID is located at the end of the url.

e.g. the runbook ID for `https://app.airplane.dev/runbooks/rbk20220120z15kl79` is `rbk20220120z15kl79`

Mapping of parameter slug to value. You can find your runbooks's parameter slugs inside the
runbook editor on Airplane.

Unique slug of the runbook. You can find your runbook's slug next to the runbook's name within the
runbook editor on Airplane.

Either an ID or a slug must be provided.

Unique ID of the task. You can find your task's ID by visiting the task's page on Airplane.
The task ID is located at the end of the url.

e.g. the task ID for `https://app.airplane.dev/tasks/tsk20210728zxb2vxn` is `tsk20210728zxb2vxn`

Either an ID or a slug must be provided.

Mapping of parameter slug to value. You can find your task's parameter slugs inside the
task editor on Airplane or by running `airplane tasks list` from the CLI.

Mapping of resource aliases to id identifiers used by the task.

Unique slug of the task. You can find your task's slug next to the task's name within the
task editor on Airplane or by running `airplane tasks list` from the CLI.

Either an ID or a slug must be provided.

When the run became active. Empty if this run has not started yet.

When the run was cancelled. Empty if this run was not cancelled.

Agent run constraints. Used to control which agents a run can be scheduled on.

When the run failed. Empty if this run did not fail.

Mapping of parameter slug to value used in this run's execution.

Schema for the set of values users can provide when executing this run.

Explicit permissions of this run if it is private.

Which role is assigned to this permission.

ID of the group  this permission applies to if assigned to a group.

ID of the user this permission applies to if assigned directly to a user.

Mapping of resource name to resource ID of the resources that were used for this run.

ID of the session this run was spawned from if triggered by a session.

When the run succeeded. Empty if this run did not succeed.

ID of the task this run was spawned from if triggered by a task.

Maximum amount of time in seconds the run could have executed for.

ID of the storage zone that the run used for its runs and outputs. Will be null if
there was no storage zone, in which case logs and outputs will be in the airplane API.

ID of the user that created this session.

Mapping of parameter slug to value used in this session's execution.

Schema for the set of values users can provide when executing this session.

Explicit permissions of this session if it is private.

ID of the runbook this session was spawned from if triggered from a runbook.

Used to specify UI-only type modifiers. If not specified, the default UI for the parameter type is used.

Contraints that restrict what users are allowed to enter for this parameter.

Optional default value for this parameter, used if not set.

If this parameter has an object data type, represents an ordered list of key-value pairs that can be included in this object.

A human-friendly identifier for the parameter that can be referenced inside a task or runbook.
Airplane automatically generates a slug when provided a parameter name.

If this parameter has a list data type, represents the schema for the items in the list .
If this parameter has a map data type, represents the schema for the values in the map.

Mapping of parameter slug to value. You can find your prompt's parameter slugs on
the Airplane runs page or by fetching the prompt via the API.

Applicable for TypeObject parameters only.

Optional determines whether this parameter must be set. A parameter is considered
not set if its value is explicitly `null` or if the parameter's slug is not included
in the enclosing object. It does _not_ validate whether the value is "empty", f.e.
`""` for a string or `0` for an integer. To validate that, use a different constraint
such as a regex (or other, future constraints).

In other words, `Optional` means `Nullable`.

A human-friendly identifier for the parameter.

When this prompt was cancelled. This value will be null if the prompt has not been cancelled.

Who cancelled this this prompt. This value will be null if the prompt has not been cancelled.

Reviewers allowed to submit this prompt. If reviewers are null, anyone allowed to access the
prompt is allowed to submit.

Whether or not self approvals are allowed.

Groups allowed to review a given prompt indentified by their slugs.

Users allowed to review a given prompt indentified by their emails.

Unique ID of the run the prompt belongs to.

Schema for the set of values users can provide when submitting this prompt.

When this prompt was submitted. This value will be null if the prompt has not been submitted.

Who submitted this this prompt. This value will be null if the prompt has not been submitted.

Mapping of parameter slug to value submitted to this prompt.

Airplane Support

Airplane API

CancelPromptRequest

Get information about an existing prompt.

runID

Submit a prompt with a set of parameter values.

SubmitPromptRequest

Execute a runbook and receive a session ID to track the runbook's execution.
Check on the status of your newly created session with [/sessions/get](/api/sessions#sessions-get).

Slug of the environment to execute the runbook in. Either an ID or a slug can be provided.

X-Airplane-Env-Slug

ID of the environment to execute the runbook in. Either an ID or a slug can be provided.

X-Airplane-Env-ID

ExecuteRunbookRequest

Cancel a run.
Check on the status of your run with [/runs/get](/api/runs#runs-get).

CancelRunRequest

taskID

Unique slug of the task to fetch runs for.

taskSlug

Fetch runs last updated after this time (RFC 3339 format).

since

Fetch runs last updated before this time (RFC 3339 format).

until

Number of results per call. Accepted values: 0 - 50. Default: 50.

limit

The offset used for this page of results.

page

Get information about an existing session.

Only fetch sessions for this specific runbook.

runbookID

Fetch sessions last updated after this time (RFC 3339 format).

updatedAfter

Fetch sessions last updated before this time (RFC 3339 format).

updatedBefore

Execute a task with a set of parameter values and receive a run ID to track the task's execution.
Check on the status of your newly created run with [/runs/get](/api/runs#runs-get).

Slug of the environment to execute the task in. Either an ID or a slug can be provided.

ID of the environment to execute the task in. Either an ID or a slug can be provided.