REST API

The REST API resource allows tasks to connect to a HTTP service; it typically embodies a base URL as well as e.g. headers that should be included on HTTP requests. For a high-level introduction to resources, see the resources page.

Creating a REST API resource

To create a new REST API resource, visit resources for your team, click the "New" button, and select the REST API resource type. Enter your connection details in the form:

Name should be a human-readable name for your resource.

Base URL should be the the URL of the REST server you want to connect to. It may contain a path. (It should not end in a slash—tasks that use this resource will have a leading slash in the path.)

Any headers defined at the resource level will be included on all requests that use this resource, unless they are overridden by the task or session block.

Private networking

To connect to a REST API inside a private VPC, you can self-host the agent and run the agent within your own VPC. Since tasks and REST requests run on agents, these tasks will run from within your network and be able to connect.

Field reference

When this resource is attached to a task, its fields are available in the JSON environment variable AIRPLANE_RESOURCES under the alias it was attached with. The available fields are documented below.

idstring

The ID of the resource.

slugstring

The slug of the resource as defined in the resource settings page.

namestring

The name of the resource.

kindstring(value: rest)

The kind of the resource.

baseURLstring

The base URL of the REST API.

headersobject

Mapping of header name to value.