Quickstart

This guide gets you ready to use the Depfloy API. We'll cover the endpoint, required headers, how to authenticate, and how to make your first request.

Endpoint

The Depfloy API is available at:

https://app.depfloy.com/api/v1

Headers

The following headers are required on every request:

Authorization: Bearer {API_KEY}
Content-Type: application/json
Accept: application/json

Authentication

Depfloy uses Bearer Token authentication. Create a token under Settings → API Tokens — the value is shown only once at creation, so copy it somewhere safe immediately.

curl https://app.depfloy.com/api/v1/projects \
  -H "Authorization: Bearer {API_KEY}" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json"

Each token carries its own permission set, independent of the role you have on any organization. Grant only the permissions a specific integration needs — see API Tokens for the full create / revoke flow.

Rate limits

API requests are limited to 60 per minute per token. If you exceed the limit, requests are answered with 429 Too Many Requests. Back off and retry, or stagger your requests.

What's next?

• Create an API token — if you haven't already.
• Errors — status codes and error response shapes.
• Pagination — how to walk paginated list endpoints.
• Servers, Projects, Deployments — the core resource endpoints.