Version: v1.0

Tolgee REST API Specification

If you would like to get the OpenAPI specification in JSON format, you can download it here.

If you are more familiar with Swagger UI, follow this link here. There, you can also find internal API specifications that are not intended for public use.

Authentication

HTTP: Bearer Auth

Security Scheme Type:	http
HTTP Authorization Scheme:	bearer
Bearer format:	JWT

HTTP: Bearer Auth

Super JWT token is required for sensitive operations when user has set 2FA. You can obtain super JWT token via /v2/user/generate-super-token endpoint. But be careful! Super JWT Token has super powers!

Security Scheme Type:	http
HTTP Authorization Scheme:	bearer
Bearer format:	JWT

API Key: ApiKeyInHeader

Security Scheme Type:	apiKey
Header parameter name:	X-API-Key

API Key: ApiKeyInQueryParam

It's not recommended to use API key in query param, since it can be stored in logs.

Security Scheme Type:	apiKey
Header parameter name:	ak

• The Bearer Auth (JWT Token) is used internally by the Tolgee Platform frontend. Some of the endpoints require a Super JWT token, which requires two-factor authentication and is only valid for a short period of time.
• The project API endpoints /v2/projects/:projectId/... can be accessed with Project API key
• The non-project API endpoints have to be accessed with PAT (Personal access token)

The allowed authentication methods are specified for each endpoint.