Docs / Using the API

Introduction

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

  1. Base URL
  2. Conventions
  3. Example request
  4. Resources
  5. 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.

Base URL

All requests are made against:

https://rocketeersapp.com/api

Conventions

  • Read only. Every endpoint is a GET request and returns application/json.
  • Team scoped. Resource endpoints live under GET /api/{team}/<resource>, 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.

Example request

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

Resources

Each resource has its own reference page:

Next steps