Aptible

Aptible System API

The System API from Aptible — 1 operation(s) for system.

GitHub OpenAPI

Documentation

📖
Documentation
https://www.aptible.com/docs/getting-started/home

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/aptible/refs/heads/main/openapi/aptible-system-api-openapi.yml

Other Resources

🔗
SourceCode
https://github.com/aptible/cloud-api-clients
🔗
SourceCode
https://github.com/aptible/tool-server-openapi-spec

OpenAPI Specification

aptible-system-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Cloud System API
  version: 0.1.0
servers:
- url: /
tags:
- name: System
paths:
  /api/v1/system/health_check:
    get:
      operationId: get_healthcheck
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TextResponse'
          description: Successful Response
      summary: Get Healthcheck
      tags:
      - System
components:
  schemas:
    TextResponse:
      description: Generic text responses on api in payload, no flair
      example:
        payload: payload
        error: error
      properties:
        error:
          description: error message payload to bubble up to end user
          title: Error
          type: string
        payload:
          description: simple text response payload
          title: Payload
          type: string
      required:
      - payload
      title: TextResponse
      type: object
  securitySchemes:
    HTTPBearer:
      scheme: bearer
      type: http