Appearance

Authentication ​

All requests to the Ybug API must be authenticated using a Bearer token sent in the Authorization header.

Generating a token ​

  1. Sign in to your Ybug Dashboard.
  2. Open Profile settings → API.
  3. Click Generate token and copy the value — it is shown only once.

Tokens are scoped to your user account and grant access to every team and project the user belongs to. Treat them like passwords: store them in a secret manager, never commit them to source control, and rotate them if leaked.

Using a token ​

Send the token as a Bearer credential on every request:

http
GET /v1/me HTTP/1.1
Host: api.ybug.io
Authorization: Bearer <YOUR_API_TOKEN>
bash
curl https://api.ybug.io/v1/me \
  -H "Authorization: Bearer <YOUR_API_TOKEN>"

Requests without a valid token return 401 Unauthorized. A valid token with insufficient plan or permissions returns 403 Forbidden.

Plan availability ​

The API is currently available on Company and Enterprise plans only.