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

# Health Check

> Verify API availability and service status.

**Authentication** - Requires `X-Api-Key` header



## OpenAPI

````yaml /api-reference/openapi.json get /v1/health
openapi: 3.1.0
info:
  title: Rilevera Customer Alert API
  description: >-
    Programmatically sync alert data from your security platforms into Rilevera
    for comprehensive security monitoring and analysis.


    **Base URL:** `https://api.rilevera.com`
  version: 1.0.0
  contact:
    name: Rilevera Support
    email: support@rilevera.com
servers:
  - url: https://api.rilevera.com
    description: Production API
security:
  - ApiKeyAuth: []
tags:
  - name: Alerts
    description: Alert synchronization endpoints
  - name: Health
    description: Service health monitoring
paths:
  /v1/health:
    get:
      tags:
        - Health
      summary: Health Check
      description: |-
        Verify API availability and service status.

        **Authentication** - Requires `X-Api-Key` header
      operationId: healthCheck
      responses:
        '200':
          description: Service is healthy
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthResponse'
              example:
                status: healthy
                service: customer_alert_sync
                timestamp: '2024-01-15T10:30:00.000000Z'
        '401':
          description: Unauthorized - Missing, invalid, or expired API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden - The API key lacks the required permissions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    HealthResponse:
      type: object
      properties:
        status:
          type: string
          description: Service health status
        service:
          type: string
          description: Service name
        timestamp:
          type: string
          format: date-time
          description: Current server timestamp
    ErrorResponse:
      type: object
      required:
        - userMessage
        - errorType
        - requestId
      properties:
        userMessage:
          type: string
          description: Description of the error
        errorType:
          type: string
          description: Error type identifier
        requestId:
          type:
            - string
            - 'null'
          description: Request ID. Include it when you contact support.
        title:
          type: string
          description: Short error title, when available
        additionalContext:
          type: string
          description: Additional detail about the error, when available
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key
      description: Your Rilevera API key. Contact your administrator to obtain one.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.