Coolify Health API

The Health API from Coolify — 1 operation(s) for health.

OpenAPI Specification

coolify-health-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Coolify Applications Health API
  version: '0.1'
  description: Applications
servers:
- url: https://app.coolify.io/api/v1
  description: Coolify Cloud API. Change the host to your own instance if you are self-hosting.
tags:
- name: Health
paths:
  /health:
    get:
      summary: Healthcheck
      description: Healthcheck endpoint.
      operationId: healthcheck
      responses:
        '200':
          description: Healthcheck endpoint.
          content:
            text/html:
              schema:
                type: string
              example: OK
        '401':
          $ref: '#/components/responses/401'
        '400':
          $ref: '#/components/responses/400'
      tags:
      - Health
components:
  responses:
    '400':
      description: Invalid token.
      content:
        application/json:
          schema:
            properties:
              message:
                type: string
                example: Invalid token.
            type: object
    '401':
      description: Unauthenticated.
      content:
        application/json:
          schema:
            properties:
              message:
                type: string
                example: Unauthenticated.
            type: object
  securitySchemes:
    bearerAuth:
      type: http
      description: Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
      scheme: bearer