Public API Reference

The Railway public API is built with GraphQL and is the same API that powers the Railway dashboard.

Endpoint

The public API is accessible at the following endpoint:

https://backboard.railway.app/graphql/v2

Authentication

To use the API, you will need an API token. You can create one by visiting the tokens page in your account settings.

curl --request POST \
  --url https://backboard.railway.app/graphql/v2 \
  --header 'Authorization: Bearer <API_TOKEN_GOES_HERE>' \
  --header 'Content-Type: application/json' \
  --data '{"query":"query { me { name email } }"}'

Team token

Team tokens are tied to a team and will have access to all the team's resources. This token cannot be used to access your personal resources on Railway so feel free to share it with your teammates.

Personal token

Non-team tokens will be tied to your Railway account and will have access to all your resources. Do not share this token with anyone else.

Project token

Project tokens are scoped to a specific environment within a project and can only be used to authenticate requests to that environment.

Schema

The Railway API supports introspection meaning you can use popular tools like Postman or Insomnia to query the schema. Simply set up your connection with the endpoint and Authorization token, and fetch the schema.

API Collection File

We provide a collection file which can be imported into your preferred API client. Once imported, you should only need to add your API token to get connected and start executing queries in the collection. Click here to download it.

GraphiQL Playground

Use our GraphiQL playground to view the schema and test your queries.

Rate Limits

In order to protect the Railway API from spam and misusage, we have established some basic rate limits. The current limit is 1000 requests per hour to the API. To help you keep track of your usage, Railway sends a few headers with the response on each request.

Support

For more information on how to use the Public API and for examples of queries, view the Public API guide.

If you run into problems using the API or have any suggestions, feel free to join our Discord server where you can interact with the engineers working on the API directly.