CloudQuery Health Check API

openapi: 3.2.0
info:
  contact:
    email: support@cloudquery.io
    name: CloudQuery Support Team
    url: https://cloudquery.io
  description: 'Welcome to the CloudQuery Platform API documentation! This API can be used to interact with the CloudQuery platform. As a user, the API allows you to search the CloudQuery asset inventory, run SQL queries against the data warehouse, save and load searches, and much more. As an administrator, it allows you to manage your teams, syncs, and other objects.

    ### Authentication

    The API is secured using bearer tokens. To get started, you can generate an API key for your Platform deployment from your platform dashboard. For a step-by-step guide, see: https://www.cloudquery.io/docs/cli/managing-cloudquery/deployments/generate-api-key.

    The base URL for the API depends on where your CloudQuery Platform is hosted. If running locally, this is usually http://localhost:3000/api. In a production deployment it should be an HTTPS URL. For purposes of illustration, we will assume the platform instance is available at https://cloudquery.mycompany.com. In this case, the base API endpoint will be https://cloudquery.mycompany.com/api.

    ### Example Request

    To test your connection to the API, we can use the `/plugins` endpoint. For example:

    `curl -v -H "Authorization: Bearer $CLOUDQUERY_API_KEY" \ https://cloudquery.mycompany.com/api/plugins`'
  license:
    name: MIT
    url: https://spdx.org/licenses/MIT
  termsOfService: https://www.cloudquery.io/terms
  title: CloudQuery Platform OpenAPI Spec Healthcheck API
  version: 1.0.0
security:
- bearerAuth: []
- cookieAuth: []
tags:
- name: Health Check
paths:
  /:
    get:
      description: Index endpoint, returns 200
      operationId: PlatformIndex
      responses:
        '200':
          description: Response
          headers:
            Link:
              description: RFC 8631 compliant link relation information
              schema:
                type: string
                example: <https://platform-api-docs.cloudquery.io>; rel="service-doc"
        '400':
          content:
            application/json:
              schema:
                allOf:
                - additionalProperties: false
                  description: Basic Error
                  required:
                  - message
                  - status
                  properties:
                    message:
                      type: string
                    status:
                      type: integer
                  title: Basic Error
                  type: object
                - properties:
                    errors:
                      items:
                        type: string
                      type: array
                    field_errors:
                      additionalProperties:
                        type: string
                      type: object
                  type: object
          description: Bad request
      security: []
      tags:
      - Health Check
      summary: Platform index
      x-summary-source: derived
  /healthcheck:
    get:
      description: Health check endpoint, returns 200
      operationId: PlatformHealthCheck
      responses:
        '200':
          description: Response
        '400':
          $ref: '#/components/responses/PlatformBadRequest'
        '500':
          $ref: '#/components/responses/PlatformInternalError'
        '503':
          $ref: '#/components/responses/PlatformServiceUnavailable'
      security: []
      tags:
      - Health Check
      summary: Platform health check
      x-summary-source: derived
components:
  responses:
    PlatformInternalError:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PlatformBasicError'
      description: Internal Error
    PlatformServiceUnavailable:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PlatformBasicError'
      description: Service unavailable
    PlatformBadRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PlatformFieldError'
      description: Bad request
  schemas:
    PlatformFieldError:
      allOf:
      - $ref: '#/components/schemas/PlatformBasicError'
      - properties:
          errors:
            items:
              type: string
            type: array
          field_errors:
            additionalProperties:
              type: string
            type: object
        type: object
    PlatformBasicError:
      additionalProperties: false
      description: Basic Error
      required:
      - message
      - status
      properties:
        message:
          type: string
        status:
          type: integer
      title: Basic Error
      type: object
  securitySchemes:
    bearerAuth:
      scheme: bearer
      type: http
    basicAuth:
      scheme: basic
      type: http
    cookieAuth:
      scheme: cookie
      type: http
x-provenance:
  method: harvested
  publisher: CloudQuery
  source: https://platform-multi-tenant-api-docs.cloudquery.io/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)