Skip to main content

​
Base URL

https://api.gitar.ai/v1

​
Authentication

All endpoints require a Bearer token in the Authorization header.

​
Creating an API Token

1

Navigate to Organization Settings

Go to app.gitar.ai and open your organization settings.
2

Create New Token

Click Create API Token in the API section.
3

Configure Token

Set the following options:
  • Alias (optional): Descriptive name (e.g., “Health Monitor”)
  • Duration: Token expiration (default: 30 days)
  • Scopes: Required permissions
4

Copy and Store Securely

Copy your token immediately — it won’t be shown again. Store it securely in your CI/CD secrets or environment variables.

​
Available Scopes

ScopeDescription
Integrations ReadRead access to integration status and installation health

​
Quick Example: Check Installation Health

curl https://api.gitar.ai/v1/external/installation/health \
  -H "Authorization: Bearer $GITAR_API_TOKEN"

​
Response Format

All API responses are JSON. Successful responses include the requested data: 
{
  "code_hosting": {
    "gitlab": {
      "status": "ok",
      "host": "gitlab.example.com",
      "group": "my-org"
    },
    "github": {
      "status": "ok"
    }
  }
}
Error responses include a message: 
{
  "message": "Not Found"
}

​
Rate Limits

API requests are rate limited per organization. If you exceed the limit, you’ll receive a 429 Too Many Requests response. Contact developers@gitar.ai if you need higher limits.

​
Next Steps

Installation Health

Check the health status of your GitLab installation