Hyperping Health Checks API

openapi: 3.2.0
info:
  title: Hyperping Healthchecks API
  x-refined-note:
  - x-logo differs across the merged source definitions and was not carried
  version: '1.0'
  description: 'Operations tagged Healthchecks across 2 of this provider''s published API definitions: hyperping-openapi.json, hyperping-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.hyperping.io
  description: Production API server
- url: https://api.hyperping.io/v1
  description: Hyperping API base (monitors, maintenance, status JSON). Other resources use sibling version segments (../v2, ../v3) on the same host.
security:
- bearerAuth: []
tags:
- name: Health Checks
  description: Cron job and scheduled task monitoring
paths:
  /v1/healthchecks:
    get:
      tags:
      - Health Checks
      summary: List all healthchecks
      description: Returns all healthcheck monitors for cron job monitoring.
      operationId: listHealthchecks
      responses:
        '200':
          description: List of healthchecks
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Healthcheck'
    post:
      tags:
      - Health Checks
      summary: Create a healthcheck
      description: Creates a new healthcheck. Supports simple (periodic interval) and cron (cron expression) modes.
      operationId: createHealthcheck
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HealthcheckCreate'
      responses:
        '201':
          description: Healthcheck created
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  healthcheck:
                    $ref: '#/components/schemas/Healthcheck'
    servers:
    - url: https://api.hyperping.io
      description: Production API server
  /v1/healthchecks/{uuid}:
    get:
      tags:
      - Health Checks
      summary: Get a healthcheck
      operationId: getHealthcheck
      parameters:
      - $ref: '#/components/parameters/HealthcheckUuid'
      responses:
        '200':
          description: Healthcheck details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Healthcheck'
    put:
      tags:
      - Health Checks
      summary: Update a healthcheck
      operationId: updateHealthcheck
      parameters:
      - $ref: '#/components/parameters/HealthcheckUuid'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HealthcheckCreate'
      responses:
        '200':
          description: Healthcheck updated
    delete:
      tags:
      - Health Checks
      summary: Delete a healthcheck
      operationId: deleteHealthcheck
      parameters:
      - $ref: '#/components/parameters/HealthcheckUuid'
      responses:
        '200':
          description: Healthcheck deleted
    servers:
    - url: https://api.hyperping.io
      description: Production API server
  /v1/healthchecks/{uuid}/pause:
    post:
      tags:
      - Health Checks
      summary: Pause a healthcheck
      description: Temporarily pause monitoring and alerting.
      operationId: pauseHealthcheck
      parameters:
      - $ref: '#/components/parameters/HealthcheckUuid'
      responses:
        '200':
          description: Healthcheck paused
    servers:
    - url: https://api.hyperping.io
      description: Production API server
  /v1/healthchecks/{uuid}/resume:
    post:
      tags:
      - Health Checks
      summary: Resume a healthcheck
      description: Resume a paused healthcheck.
      operationId: resumeHealthcheck
      parameters:
      - $ref: '#/components/parameters/HealthcheckUuid'
      responses:
        '200':
          description: Healthcheck resumed
    servers:
    - url: https://api.hyperping.io
      description: Production API server
  /healthchecks:
    servers:
    - url: https://api.hyperping.io/v2
    get:
      operationId: getHealthchecks
      tags:
      - Health Checks
      summary: List all healthchecks
      responses:
        '200':
          description: A list of healthchecks.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Healthcheck_2'
      x-operation-id-source: normalized
      x-operation-id-original: listHealthchecks
    post:
      operationId: postHealthchecks
      tags:
      - Health Checks
      summary: Create a new healthcheck
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HealthcheckInput'
      responses:
        '201':
          description: The created healthcheck.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Healthcheck_2'
      x-operation-id-source: normalized
      x-operation-id-original: createHealthcheck
  /healthchecks/{healthcheck_uuid}:
    servers:
    - url: https://api.hyperping.io/v2
    parameters:
    - $ref: '#/components/parameters/HealthcheckUuid_2'
    get:
      operationId: getHealthchecksByHealthcheckUuid
      tags:
      - Health Checks
      summary: Retrieve a healthcheck
      responses:
        '200':
          description: The requested healthcheck.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Healthcheck_2'
      x-operation-id-source: normalized
      x-operation-id-original: getHealthcheck
    put:
      operationId: putHealthchecksByHealthcheckUuid
      tags:
      - Health Checks
      summary: Update a healthcheck
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HealthcheckInput'
      responses:
        '200':
          description: The updated healthcheck.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Healthcheck_2'
      x-operation-id-source: normalized
      x-operation-id-original: updateHealthcheck
    delete:
      operationId: deleteHealthchecksByHealthcheckUuid
      tags:
      - Health Checks
      summary: Delete a healthcheck
      responses:
        '204':
          description: The healthcheck was deleted.
      x-operation-id-source: normalized
      x-operation-id-original: deleteHealthcheck
  /healthchecks/{healthcheck_uuid}/pause:
    servers:
    - url: https://api.hyperping.io/v2
    parameters:
    - $ref: '#/components/parameters/HealthcheckUuid_2'
    post:
      operationId: postHealthchecksByHealthcheckUuidPause
      tags:
      - Health Checks
      summary: Pause a healthcheck
      responses:
        '200':
          description: The paused healthcheck.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Healthcheck_2'
      x-operation-id-source: normalized
      x-operation-id-original: pauseHealthcheck
  /healthchecks/{healthcheck_uuid}/resume:
    servers:
    - url: https://api.hyperping.io/v2
    parameters:
    - $ref: '#/components/parameters/HealthcheckUuid_2'
    post:
      operationId: postHealthchecksByHealthcheckUuidResume
      tags:
      - Health Checks
      summary: Resume a healthcheck
      responses:
        '200':
          description: The resumed healthcheck.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Healthcheck_2'
      x-operation-id-source: normalized
      x-operation-id-original: resumeHealthcheck
components:
  parameters:
    HealthcheckUuid:
      name: uuid
      in: path
      required: true
      schema:
        type: string
      description: Healthcheck UUID
      example: tok_abc123def456
    HealthcheckUuid_2:
      name: healthcheck_uuid
      in: path
      required: true
      description: The unique identifier of the healthcheck.
      schema:
        type: string
  schemas:
    HealthcheckCreate:
      type: object
      required:
      - name
      - grace_period_value
      - grace_period_type
      properties:
        name:
          type: string
          example: Daily Backup Job
        period_value:
          type: integer
          description: Expected ping interval (simple mode)
        period_type:
          type: string
          enum:
          - seconds
          - minutes
          - hours
          - days
        grace_period_value:
          type: integer
          example: 5
        grace_period_type:
          type: string
          enum:
          - seconds
          - minutes
          - hours
          - days
        cron:
          type: string
          description: Cron expression (cron mode)
          example: 0 2 * * *
        timezone:
          type: string
          default: UTC
    Healthcheck:
      type: object
      properties:
        uuid:
          type: string
          example: tok_abc123def456
        publicUuid:
          type: string
          readOnly: true
          description: Public identifier (hc_). Use it to show the healthcheck on a status page. Unlike uuid, which is also the token of the ping URL, it is safe to share.
          example: hc_Kq3vX9mPzL2wR8tY5nB7cD4f
        name:
          type: string
          example: Daily Backup Job
        pingUrl:
          type: string
          example: https://hc.hyperping.io/tok_abc123def456
        period:
          type: integer
          description: Expected interval in seconds
        periodValue:
          type:
          - integer
          - 'null'
        periodType:
          type:
          - string
          - 'null'
          enum:
          - seconds
          - minutes
          - hours
          - days
          - null
        gracePeriod:
          type: integer
          description: Grace period in seconds
        gracePeriodValue:
          type: integer
        gracePeriodType:
          type: string
          enum:
          - seconds
          - minutes
          - hours
          - days
        cron:
          type:
          - string
          - 'null'
          example: 0 2 * * *
        timezone:
          type: string
          example: America/New_York
    Healthcheck_2:
      type: object
      properties:
        uuid:
          type: string
        name:
          type: string
        period:
          type: integer
          description: Expected ping period in seconds.
        grace:
          type: integer
          description: Grace period in seconds before alerting.
        status:
          type: string
          enum:
          - up
          - down
          - paused
        last_ping_at:
          type: string
          format: date-time
        created_at:
          type: string
          format: date-time
    HealthcheckInput:
      type: object
      required:
      - name
      - period
      properties:
        name:
          type: string
        period:
          type: integer
          description: Expected ping period in seconds.
        grace:
          type: integer
          description: Grace period in seconds before alerting.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API key from https://app.hyperping.io/project/developers
externalDocs:
  description: Hyperping API Documentation
  url: https://hyperping.com/docs/api/overview
x-refined-from:
- hyperping-openapi.json
- hyperping-openapi.yml