openapi: 3.1.0
info:
  title: 1Password Connect Server Accounts Health API
  description: The 1Password Connect Server API provides secure access to 1Password items and vaults in your company's apps and cloud infrastructure through a private REST API. Connect Servers bridge the gap between 1Password and your infrastructure by enabling programmatic access to secrets stored in shared vaults. You can create, read, update, and delete items, manage vaults, and retrieve files attached to items.
  version: 1.8.1
  contact:
    name: 1Password Support
    url: https://support.1password.com/
  termsOfService: https://1password.com/legal/terms-of-service/
  license:
    name: MIT
    url: https://github.com/1Password/connect/blob/main/LICENSE
servers:
- url: http://localhost:8080
  description: Local Connect Server (default port 8080)
security:
- bearerAuth: []
tags:
- name: Health
  description: Operations for checking the health and status of the Connect server.
paths:
  /heartbeat:
    get:
      operationId: getHeartbeat
      summary: 1Password Check Server Status
      description: Returns a simple response to indicate that the Connect server is active and responding to requests. This endpoint does not require authentication.
      tags:
      - Health
      security: []
      responses:
        '200':
          description: Server is active
          content:
            text/plain:
              schema:
                type: string
                example: .
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /health:
    get:
      operationId: getHealth
      summary: 1Password Get Server Health
      description: Returns detailed information about the state of the Connect server and its service dependencies, including the 1Password service connectivity status.
      tags:
      - Health
      security: []
      responses:
        '200':
          description: Server is healthy
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerHealth'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    ServerHealth:
      type: object
      description: Represents the health status of the Connect server and its dependencies.
      properties:
        name:
          type: string
          description: The name of the Connect server.
        version:
          type: string
          description: The version of the Connect server.
        dependencies:
          type: array
          description: The health status of server dependencies.
          items:
            type: object
            properties:
              service:
                type: string
                description: The name of the dependency service.
              status:
                type: string
                description: The status of the dependency.
                enum:
                - ACTIVE
                - INACTIVE
                - ERROR
              message:
                type: string
                description: Additional information about the dependency status.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: A Connect server access token generated from 1Password. Each request must include this token in the Authorization header.
externalDocs:
  description: 1Password Connect Server API Reference
  url: https://developer.1password.com/docs/connect/api-reference/