Request access
Sign inRequest access

Docs Start here

API

Endpoints, numbers, calls and usage are available over HTTPS with an API key. This page covers the basics; the interactive reference lists every operation.

Authentication

Create a key in the panel under Settings → API keys. The full key is shown once; store it somewhere safe. Send it as a bearer token. Keys act with member rights on the team that created them, so they can manage endpoints and numbers but not billing or team members.

Your first request

shell
curl https://api.relaydock.io/api/v1/endpoints \
  -H "Authorization: Bearer rdk_…"

The API keys tab in the panel shows the same request, and examples that create an endpoint and list calls, with your team ID filled in.

Conventions

  • Base URL. https://api.relaydock.io/api/v1
  • Team. X-RelayDock-Tenant: <team id> is optional with an API key; if you send it, it must be the key's team.
  • Pagination. Paged lists take limit and cursor and return items and next_cursor, which is null on the last page.
  • Errors. Errors are JSON with a stable code and a readable message; validation errors (422) add fields.
  • Rate limits. Too many requests return 429 rate_limited with a Retry-After header in seconds.
  • Versioning. /api/v1 changes only additively: new fields and operations, nothing removed.
json
{"code": "endpoint.not_found", "message": "Endpoint not found"}

Reference

The interactive reference lists every operation with its parameters and responses, and lets you try requests with your key. The same description is available as an OpenAPI document for code generators.