openapi: 3.2.0
info:
  contact:
    name: https://docs.yugabyte.com
  description: ALPHA - NOT FOR EXTERNAL USE
  license:
    name: Polyform Free Trial License 1.0.0
    url: https://github.com/yugabyte/yugabyte-db/blob/master/licenses/POLYFORM-FREE-TRIAL-LICENSE-1.0.0.txt
  termsOfService: TODO(chirag)
  title: YugabyteDB Anywhere Internal HA API
  version: v1
servers:
- url: /
tags:
- name: Internal HA
paths:
  /api/v1/settings/ha/internal/backups/{backupName}/validate:
    get:
      operationId: validateBackup
      parameters:
      - in: path
        name: backupName
        required: true
        schema:
          type: string
      - in: query
        name: request
        schema: {}
      responses:
        default:
          content: {}
          description: successful operation
      tags:
      - Internal HA
      summary: Validate backup
      x-summary-source: derived
  /api/v1/settings/ha/internal/config:
    get:
      operationId: getHAConfigByClusterKey
      parameters:
      - in: query
        name: request
        schema: {}
      responses:
        default:
          content: {}
          description: successful operation
      tags:
      - Internal HA
      summary: Get HA config by cluster key
      x-summary-source: derived
  /api/v1/settings/ha/internal/config/demote/{timestamp}:
    put:
      description: Available since YBA version 2.20.0.
      operationId: demoteLocalLeader
      parameters:
      - in: path
        name: timestamp
        required: true
        schema:
          format: int64
          type: integer
      - in: query
        name: promote
        schema:
          default: false
          type: boolean
      - in: query
        name: request
        schema: {}
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlatformInstance'
          description: successful operation
      summary: Demote local leader
      tags:
      - Internal HA
  /api/v1/settings/ha/internal/config/sync/{timestamp}:
    put:
      operationId: syncInstances
      parameters:
      - in: path
        name: timestamp
        required: true
        schema:
          format: int64
          type: integer
      - in: query
        name: request
        schema: {}
      responses:
        default:
          content: {}
          description: successful operation
      tags:
      - Internal HA
      summary: Sync instances
      x-summary-source: derived
  /api/v1/settings/ha/internal/upload:
    post:
      operationId: syncBackups
      parameters:
      - in: query
        name: request
        schema: {}
      responses:
        default:
          content: {}
          description: successful operation
      tags:
      - Internal HA
      summary: Sync backups
      x-summary-source: derived
components:
  schemas:
    PlatformInstance:
      example:
        address: address
        config_uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        instance_state: Awaiting Connection to Replicas
        ybaVersion: ybaVersion
        state: LEADER
        is_local: true
        uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        is_leader: true
        last_backup: 2022-12-12 13:07:18+00:00
      properties:
        address:
          type: string
        config_uuid:
          format: uuid
          type: string
        instance_state:
          enum:
          - Awaiting Connection to Replicas
          - Connected
          - Disconnected
          type: string
        is_leader:
          type: boolean
        is_local:
          type: boolean
        last_backup:
          description: Last backup time
          example: 2022-12-12 13:07:18+00:00
          format: date-time
          type: string
        state:
          enum:
          - LEADER
          - STAND_BY
          type: string
        uuid:
          format: uuid
          type: string
        ybaVersion:
          type: string
      required:
      - address
      - instance_state
      - is_leader
      - state
      - uuid
      - ybaVersion
      type: object
  securitySchemes:
    apiKeyAuth:
      description: API token passed as header
      in: header
      name: X-AUTH-YW-API-TOKEN
      type: apiKey
externalDocs:
  description: About YugabyteDB Anywhere
  url: https://docs.yugabyte.com/latest/yugabyte-platform/
x-original-swagger-version: '2.0'