> ## Documentation Index
> Fetch the complete documentation index at: https://gecko.security/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Check API health

> Returns the current API health status and the list of public `v1` endpoints. This endpoint does not require authentication.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/health
openapi: 3.1.0
info:
  title: Gecko SAST Scanner API
  version: v1
  description: >-
    Use the Gecko API to launch scans and read scan, repository, and
    vulnerability data for your active team.
servers:
  - url: https://app.gecko.security
    description: Production
security:
  - ApiKeyAuth: []
tags:
  - name: Scans
    description: Launch scans and read scan-level data.
  - name: Repositories
    description: Read repository inventory and repository vulnerability data.
  - name: Vulnerabilities
    description: Read vulnerability data across your active team.
  - name: Utility
    description: Service health and utility endpoints.
paths:
  /api/v1/health:
    get:
      tags:
        - Utility
      summary: Check API health
      description: >-
        Returns the current API health status and the list of public `v1`
        endpoints. This endpoint does not require authentication.
      operationId: getApiV1Health
      responses:
        '200':
          description: The API is healthy.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthResponse'
              example:
                version: v1
                status: healthy
                timestamp: '2026-03-10T16:00:00.000Z'
                service: Gecko SAST Scanner API
                endpoints:
                  scans: /api/v1/scans
                  vulnerabilities: /api/v1/vulnerabilities
                  scanVulnerabilities: /api/v1/scans/{scanId}/vulnerabilities
                  repositories: /api/v1/repositories
                  repositoryVulnerabilities: /api/v1/repositories/{repositoryId}/vulnerabilities
                  scanEndpoints: /api/v1/scans/{scanId}/endpoints
                  scanWiki: /api/v1/scans/{scanId}/wiki
        '503':
          description: The API health check failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthErrorResponse'
              example:
                version: v1
                status: unhealthy
                error: Service check failed
                timestamp: '2026-03-10T16:00:00.000Z'
      security: []
components:
  schemas:
    HealthResponse:
      type: object
      required:
        - version
        - status
        - timestamp
        - service
        - endpoints
      properties:
        version:
          type: string
          const: v1
        status:
          type: string
          const: healthy
        timestamp:
          type: string
          format: date-time
        service:
          type: string
        endpoints:
          type: object
          required:
            - scans
            - vulnerabilities
            - scanVulnerabilities
            - repositories
            - repositoryVulnerabilities
            - scanEndpoints
            - scanWiki
          properties:
            scans:
              type: string
            vulnerabilities:
              type: string
            scanVulnerabilities:
              type: string
            repositories:
              type: string
            repositoryVulnerabilities:
              type: string
            scanEndpoints:
              type: string
            scanWiki:
              type: string
    HealthErrorResponse:
      type: object
      required:
        - version
        - status
        - error
        - timestamp
      properties:
        version:
          type: string
          const: v1
        status:
          type: string
          const: unhealthy
        error:
          type: string
        timestamp:
          type: string
          format: date-time
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: Team-scoped Gecko API key. Keys start with `gk_`.

````