Overview

Creating an API Token

Navigate to Organization Settings

Go to app.gitar.ai and open Settings → API Tokens.

Create New Token

Select Create Token on the API Tokens page.

Configure Token

Set the following options:

Alias (optional): Descriptive name, for example Health Monitor
Duration: Token expiration (default: 30 days)

Copy and Store Securely

Copy your token immediately. It is not shown again. Store it securely in your CI/CD secrets or environment variables.

Quick Example: Check Installation Health

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

import requests
import os

response = requests.get(
    "https://api.gitar.ai/v1/external/installation/health",
    headers={
        "Authorization": f"Bearer {os.environ['GITAR_API_TOKEN']}"
    }
)

data = response.json()
for platform, info in data["code_hosting"].items():
    print(f"{platform}: {info['status']}")

const response = await fetch("https://api.gitar.ai/v1/external/installation/health", {
  headers: {
    "Authorization": `Bearer ${process.env.GITAR_API_TOKEN}`
  }
});

const { code_hosting } = await response.json();
if (code_hosting.gitlab) console.log(`GitLab: ${code_hosting.gitlab.status}`);
if (code_hosting.github) console.log(`GitHub: ${code_hosting.github.status}`);

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"
}

API Reference

GitLab API

Installation API

Base URL

Authentication

Creating an API Token

Quick Example: Check Installation Health

Response Format

Next Steps

Onboard GitLab Project

Installation Health

​Base URL

​Authentication

​Creating an API Token

​Quick Example: Check Installation Health

​Response Format

​Next Steps

Onboard GitLab Project

Installation Health

Base URL

Authentication

Creating an API Token

Quick Example: Check Installation Health

Response Format

Next Steps