Gitar

Gitar Installation Health API

The Installation Health API from Gitar — 1 operation(s) for installation health.

GitHub OpenAPI

Operations 1

GET /installation/health Get installation health #

Documentation

📖
APIReference
https://docs.gitar.ai/api-reference/overview

Specifications

⚙
OpenAPI
https://artifacts.apis.io/gitar/openapi/gitar-installation-health-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/gitar:gitar-installation-health-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

gitar-installation-health-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Gitar External Installation Health API
  description: API for managing your Gitar installation and integrations
  contact:
    name: Gitar
    url: https://gitar.ai
    email: noreply@gitar.ai
  license:
    name: ''
  version: 1.0.0
servers:
- url: https://api.gitar.ai/v1
tags:
- name: Installation Health
paths:
  /installation/health:
    get:
      tags:
      - Installation Health
      operationId: getInstallationHealth
      responses:
        '200':
          description: Installation health status
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InstallationHealthResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseFailure'
        '403':
          description: Insufficient scopes
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseFailure'
        '404':
          description: No code hosting installation found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseFailure'
      security:
      - bearerAuth: []
      summary: Get installation health
      x-summary-source: derived
components:
  schemas:
    GithubHealth:
      type: object
      required:
      - status
      properties:
        status:
          type: string
    CodeHostingHealth:
      type: object
      properties:
        atlassian:confluence:
          oneOf:
          - type: 'null'
          - $ref: '#/components/schemas/AtlassianHealth'
        atlassian:jira:
          oneOf:
          - type: 'null'
          - $ref: '#/components/schemas/AtlassianHealth'
        azure_devops:
          oneOf:
          - type: 'null'
          - $ref: '#/components/schemas/AzureDevOpsHealth'
        bitbucket:
          oneOf:
          - type: 'null'
          - $ref: '#/components/schemas/BitbucketHealth'
        bitbucket_data_center:
          oneOf:
          - type: 'null'
          - $ref: '#/components/schemas/BitbucketDataCenterHealth'
        github:
          oneOf:
          - type: 'null'
          - $ref: '#/components/schemas/GithubHealth'
        gitlab:
          oneOf:
          - type: 'null'
          - $ref: '#/components/schemas/GitlabHealth'
        slack:
          oneOf:
          - type: 'null'
          - $ref: '#/components/schemas/SlackHealth'
    SlackHealth:
      type: object
      required:
      - status
      - team_id
      properties:
        failure_reason:
          type:
          - string
          - 'null'
        status:
          type: string
        team_id:
          type: string
    GitlabHealth:
      type: object
      required:
      - status
      properties:
        group:
          type:
          - string
          - 'null'
        host:
          type:
          - string
          - 'null'
        status:
          type: string
    ResponseFailure:
      type: object
      required:
      - message
      properties:
        error_code:
          type:
          - string
          - 'null'
        message:
          type: string
    BitbucketDataCenterHealth:
      type: object
      required:
      - status
      properties:
        status:
          type: string
    InstallationHealthResponse:
      type: object
      required:
      - code_hosting
      properties:
        code_hosting:
          $ref: '#/components/schemas/CodeHostingHealth'
    AtlassianHealth:
      type: object
      description: 'One Atlassian product (Jira or Confluence) installed via the Forge app.


        Installs are per site per product, so an org can have several. `status` aggregates the sites

        (`error` if any site is not connected), matching the `ok`/`error` vocabulary the other entries

        use, and `sites` carries the per-site detail.'
      required:
      - status
      - sites
      properties:
        sites:
          type: array
          items:
            $ref: '#/components/schemas/AtlassianSiteHealth'
        status:
          type: string
    AtlassianSiteHealth:
      type: object
      required:
      - cloud_id
      - status
      properties:
        cloud_id:
          type: string
        host:
          type:
          - string
          - 'null'
        status:
          type: string
          description: 'Per-site state, `ok` or `error`, same vocabulary as every other `status` in this response.

            The query only returns live installs bound to the org, so a removed or unbound site drops

            out of `sites` rather than showing up here.'
    AzureDevOpsHealth:
      type: object
      required:
      - status
      properties:
        status:
          type: string
    BitbucketHealth:
      type: object
      required:
      - status
      properties:
        status:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
x-provenance:
  method: harvested
  publisher: Gitar
  source: https://docs.gitar.ai/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)