Introduction — Docs - Rocketeers app

  [ Rocketeers ](/)   

[Login](https://rocketeersapp.com/login) 

  Documentation menu   

On this page

 [Docs](https://rocketeersapp.com/docs) / [Using the API](https://rocketeersapp.com/docs/api)

    Copy as Markdown 

Introduction
============

Read only access to your team's infrastructure data over a simple JSON API.

1. [Base URL](#content-base-url)
2. [Conventions](#content-conventions)
3. [Example request](#content-example-request)
4. [Resources](#content-resources)
5. [Next steps](#content-next-steps)

The Rocketeers API gives you read only access to your team's infrastructure data, projects, servers, sites, domains, databases and more, over a simple, predictable JSON interface.

[\#](#content-base-url "Permalink")Base URL
-------------------------------------------

All requests are made against:

 ```
https://rocketeersapp.com/api

```

[\#](#content-conventions "Permalink")Conventions
-------------------------------------------------

- **Read only.** Every endpoint is a `GET` request and returns `application/json`.
- **Team scoped.** Resource endpoints live under `GET /api/{team}/`, where `{team}` is your team's **slug**.
- **Ability scoped tokens.** Each token is granted specific read abilities (for example `projects:read`), and an endpoint returns `403` if the token lacks the required ability.

> Authentication is being finalized. For now, examples include a placeholder `Authorization` header. See **Authentication (coming soon)** for the full token guide.

[\#](#content-example-request "Permalink")Example request
---------------------------------------------------------

 ```
curl https://rocketeersapp.com/api/your-team/projects?per_page=20 \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Accept: application/json"

```

[\#](#content-resources "Permalink")Resources
---------------------------------------------

Each resource has its own reference page:

- [Projects](/docs/api/projects)
- [Finances](/docs/api/finances)
- [Servers](/docs/api/servers)
- [Sites](/docs/api/sites)
- [Clients](/docs/api/clients)
- [Domains](/docs/api/domains)
- [Storages](/docs/api/storages)
- [Databases](/docs/api/databases)
- [Repositories](/docs/api/repositories)
- [Daemons](/docs/api/daemons)
- [Schedulers](/docs/api/schedulers)
- [Incidents](/docs/api/incidents)
- [Errors](/docs/api/errors)
- [Tasks](/docs/api/tasks)

[\#](#content-next-steps "Permalink")Next steps
-----------------------------------------------

- Read the [Response format](/docs/api/response-format) page to understand the JSON envelope and pagination.
- Read [Error handling](/docs/api/error-handling) for the status codes you may encounter.

 [ Next   Response format](https://rocketeersapp.com/docs/api/response-format)