Search…
⌃K
Links

API Documentation

Authentication

Aviator uses basic key based authentication. You can view and manage your API key in the Aviator dashboard. We only support a single API token. Once a token is generated, you can reset it to invalidate your existing token and create a new one.
API keys that are used to fetch Aviator analytics are currently read-only, but in the future these may be used for other purposes. Please make sure to keep them secure.
Authentication to the API is performed via HTTP Basic Auth. Provide your API key as the bearer token:
curl -H "Authorization: Bearer <aviator_token>"
-H "Content-Type: application/json"
https://api.aviator.co/api/v1/...

API Objects

Repository

post
https://api.aviator.co/api/v1
/repo
Pause / unpause the merging of PRs on a repository.

Branches

post
https://api.aviator.co/api/v1
/branches
Pause / unpause the merging of PRs for specific base branches.
get
https://api.aviator.co/api/v1
/branches
Get base branches and their statuses (paused / unpaused)

PullRequest

post
https://api.aviator.co/api/v1
/pull_request
Queue or Dequeue a Pull Request
post
https://api.aviator.co/api/v1
/pull_request/backport
Request to backport a PR on the specified target branch.
get
/pull_request
Fetch information of a PR based on the branch name
get
pull_request/queued
Fetch information of PRs that are in the queued state

Analytics

get
https://api.aviator.co/api
/v1/analytics
Get list of analytics objects representing statistics on a daily basis.

Queue

get
https://api.aviator.co/api
/v1/queue/stats
Get live statistics about the state of the merge queue