Resource overview

Connect to databases, APIs, and other external systems.
Resources in Airplane allow you to easily configure connections to external systems like databases and APIs and use them in your tasks and runbooks.
To create and manage resources, you must be a team admin. Visit Resources in the app to add a new resource.

Supported resources
For details on using each resource, refer to its specific documentation.

Managed Databases
Airplane Postgres

Databases
BigQuery
SQL Server
MongoDB
MySQL
Postgres
Redshift
Snowflake

APIs
GraphQL API
REST API

Messaging
Mailgun
SendGrid
SMTP
Don't see what you're looking for? Let us know by emailing hello@airplane.dev—we're constantly adding resources based on feedback!

Using resources in tasks
Resources can be attached to tasks and referenced from within the task.

SQL
When creating a SQL task you can choose a database resource to query against. The database is chosen from the UI or set in the task definition.

REST
When you create a REST task, you can select a REST API. The REST API's base URL will be used, as well as any headers specified on the resource.
The REST API is chosen from the UI or set in the task definition.

JavaScript, Python, and other tasks

Resource attachment
Resources must be attached to tasks before they can be accessed via environment variables or built-ins.
typescript
Copied
1
export default airplane.task(
2
  {
3
    slug: "my_task",
4
    resources: {
5
      // Where backend_db is the slug of a resource.
6
      db: "backend_db"
7
    },
8
  },
9
  async () => {...}
10
);

Environment variables
When attached to a task, resources are passed as a JSON-encoded string via the environment variable AIRPLANE_RESOURCES. This contains a mapping of resource alias to a resource object. For more information, see the Resource environment variables reference.

Built-ins
The JavaScript and Python SDKs offer built-in functions for common operations against resources. Once a resource is attached to a task, you can refer to the resource by alias in the built-in.
For example, after attaching the SQL resource with slug db, you can refer to it using a built-in to query the SQL database:
typescript
Copied
1
const run = await airplane.sql.query<{ id: string; name: string; email: string }>(
2
  "db", // Attached resource
3
  "select * from users where name ilike :name", // SQL query to execute
4
  { args: { name: `%${name}%` } }, // Query arguments
5
);

Using resources in multiple environments
Resources can be used in other environments by promoting them.
For example, say you have a Postgres database named postgres_db that you want to use in multiple environments. In Airplane, all resources must have a unique slug, even across environments. To use the same resource slug across multiple enviroments, you promote the resource from one environment to another.
When you promote a resource from one environment to another, the task slug remains the same, and you can update the resource's configuration that is specific to that environment.
For example, say you have a different database in your staging environment than your production environment. By promoting the resource, in this case from staging to production, the resource will have the same slug across both environments. Airplane will then choose the correct resource for the environment your task is currently runnning in.
See promoting between environments for more info.

Using resources in runbooks
Resources can be used in blocks within runbooks.
For example, once a database resource like Postgres has been configured, you can add a SQL block and run queries using it:
That's all you have to do—Airplane will handle securely passing the connection information to the agent running the query.
PrivacyTermsSupport