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 Platform Instance API
  version: v1
servers:
- url: /
tags:
- name: Platform Instance
paths:
  /api/v1/settings/ha/config/{cUUID}/instance:
    post:
      description: Available since YBA version 2.20.0.
      operationId: createInstance
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PlatformInstanceFormData'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlatformInstance'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Create platform instance
      tags:
      - Platform Instance
      x-codegen-request-body-name: PlatformInstanceFormRequest
  /api/v1/settings/ha/config/{cUUID}/instance/local:
    get:
      operationId: getLocal
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      responses:
        default:
          content: {}
          description: successful operation
      security:
      - apiKeyAuth: []
      tags:
      - Platform Instance
      summary: Get local
      x-summary-source: derived
  /api/v1/settings/ha/config/{cUUID}/instance/{iUUID}:
    delete:
      operationId: deleteInstance
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: iUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      responses:
        default:
          content: {}
          description: successful operation
      security:
      - apiKeyAuth: []
      tags:
      - Platform Instance
      summary: Delete instance
      x-summary-source: derived
  /api/v1/settings/ha/config/{cUUID}/instance/{iUUID}/promote:
    post:
      description: Available since YBA version 2.20.0.
      operationId: promoteInstance
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: iUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: curLeader
        schema:
          default: 'null'
          type: string
      - in: query
        name: isForcePromote
        schema:
          default: true
          type: boolean
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RestorePlatformBackupFormData'
        required: true
      responses:
        default:
          content: {}
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Promote platform instance
      tags:
      - Platform Instance
      x-codegen-request-body-name: PlatformBackupRestoreRequest
components:
  schemas:
    PlatformInstanceFormData:
      example:
        address: address
        cleanAddress: cleanAddress
        is_local: true
        is_leader: true
      properties:
        address:
          type: string
        cleanAddress:
          type: string
        is_leader:
          type: boolean
        is_local:
          type: boolean
      required:
      - address
      - cleanAddress
      - is_leader
      - is_local
      type: object
    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
    RestorePlatformBackupFormData:
      example:
        backup_file: backup_file
      properties:
        backup_file:
          type: string
      required:
      - backup_file
      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'