YugabyteDB Instance types API

The Instance types API from YugabyteDB — 5 operation(s) for instance types.

Documentation

Specifications

Other Resources

🔗
CLI
https://github.com/yugabyte/ybm-cli
🔗
Integrations
https://github.com/yugabyte/terraform-provider-ybm
🔗
TermsOfService
https://www.yugabyte.com/yugabytedb-managed-service-terms/
🔗
SDKs
https://github.com/yugabyte/platform-go-client
🔗
Integrations
https://github.com/yugabyte/terraform-provider-yba
🔗
Integrations
https://github.com/yugabyte/yugabyte-k8s-operator
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-ybuniverse.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-backup.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-backup-schedule.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-restore-job.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-storage-config.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-dr-config.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-pitr-config.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-release.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-support-bundle.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-ybcertificate.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-ybprovider.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-ybplatform.yaml

OpenAPI Specification

yugabytedb-instance-types-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: YugabyteDB Aeon REST Access Keys Instance types API
  description: The YugabyteDB Aeon REST API provides programmatic access to YugabyteDB's fully managed cloud database service. Developers and operators can use it to deploy and manage database clusters, configure read replicas, schedule and execute on-demand backups and restores, manage IP allow lists, and set up monitoring and alerts. Authentication is performed using API keys passed as bearer tokens in the Authorization header. All paths are scoped to an account and project, which can be obtained from the YugabyteDB Aeon UI profile page.
  version: v1
  contact:
    name: Yugabyte Support
    url: https://support.yugabyte.com
  termsOfService: https://www.yugabyte.com/yugabytedb-managed-service-terms/
  x-generated-from: documentation
  x-source-url: https://api-docs.yugabyte.com/docs/managed-apis/
  x-last-validated: '2026-05-03'
servers:
- url: https://cloud.yugabyte.com/api/public/v1
  description: YugabyteDB Aeon Production Server
security:
- bearerAuth: []
tags:
- name: Instance types
paths:
  /api/v1/customers/{cUUID}/providers/{pUUID}/instance_types:
    get:
      operationId: listOfInstanceType
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: path
        name: pUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - explode: true
        in: query
        name: zone
        schema:
          items:
            type: string
          type: array
        style: form
        example:
        - us-east-1a
      - in: query
        name: arch
        schema:
          default: 'null'
          type: string
        example: 'null'
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/InstanceTypeResp'
                type: array
              examples:
                ListOfInstanceType200Example:
                  summary: Default listOfInstanceType 200 response
                  x-microcks-default: true
                  value:
                  - numCores: 1.4658129805029452
                    idKey:
                      instanceTypeCode: instanceTypeCode
                      providerUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    providerCode: providerCode
                    memSizeGB: 6.027456183070403
                    instanceTypeCode: instanceTypeCode
                    instanceTypeDetails:
                      tenancy: Shared
                      arch: x86_64
                      volumeDetailsList:
                      - volumeSizeGB: 0
                        volumeType: EBS
                        mountPath: mountPath
                      - volumeSizeGB: 0
                        volumeType: EBS
                        mountPath: mountPath
                    active: true
                    providerUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          description: successful operation
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPError'
              examples:
                ListOfInstanceType500Example:
                  summary: Default listOfInstanceType 500 response
                  x-microcks-default: true
                  value:
                    success: false
                    requestUri: /customers/8918921-af3782-633de/universe/8173ab-fd2453/create
                    error: There was a problem creating the universe
                    httpMethod: POST
                    errorJson: '{ "foo" : "bar", "baz" : [1, 2, 3] }'
                    requestJson: '{ "foo" : "bar", "baz" : [1, 2, 3] }'
          description: If there was a server or database issue when listing the instance types
      security:
      - apiKeyAuth: []
      summary: YugabyteDB Anywhere List a Provider's Instance Types
      tags:
      - Instance types
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createInstanceType
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: path
        name: pUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: query
        name: request
        schema: {}
        example: example-request
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InstanceType'
            examples:
              CreateInstanceTypeRequestExample:
                summary: Default createInstanceType request
                x-microcks-default: true
                value:
                  numCores: 6.027456183070403
                  idKey:
                    instanceTypeCode: instanceTypeCode
                    providerUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                  memSizeGB: 0.8008281904610115
                  instanceTypeCode: instanceTypeCode
                  instanceTypeDetails:
                    tenancy: Shared
                    arch: x86_64
                    volumeDetailsList:
                    - volumeSizeGB: 0
                      volumeType: EBS
                      mountPath: mountPath
                    - volumeSizeGB: 0
                      volumeType: EBS
                      mountPath: mountPath
                  active: true
        description: Instance type data of the instance to be stored
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InstanceTypeResp'
              examples:
                CreateInstanceType200Example:
                  summary: Default createInstanceType 200 response
                  x-microcks-default: true
                  value:
                    numCores: 1.4658129805029452
                    idKey:
                      instanceTypeCode: instanceTypeCode
                      providerUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    providerCode: providerCode
                    memSizeGB: 6.027456183070403
                    instanceTypeCode: instanceTypeCode
                    instanceTypeDetails:
                      tenancy: Shared
                      arch: x86_64
                      volumeDetailsList:
                      - volumeSizeGB: 0
                        volumeType: EBS
                        mountPath: mountPath
                      - volumeSizeGB: 0
                        volumeType: EBS
                        mountPath: mountPath
                    active: true
                    providerUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: YugabyteDB Anywhere Create an Instance Type
      tags:
      - Instance types
      x-codegen-request-body-name: Instance type
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /api/v1/customers/{cUUID}/providers/{pUUID}/instance_types/{code}:
    delete:
      operationId: deleteInstanceType
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: path
        name: pUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: path
        name: code
        required: true
        schema:
          type: string
        example: OK
      - in: query
        name: request
        schema: {}
        example: example-request
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPSuccess'
              examples:
                DeleteInstanceType200Example:
                  summary: Default deleteInstanceType 200 response
                  x-microcks-default: true
                  value:
                    success: true
                    message: message
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: YugabyteDB Anywhere Delete an Instance Type
      tags:
      - Instance types
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    get:
      operationId: instanceTypeDetail
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: path
        name: pUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: path
        name: code
        required: true
        schema:
          type: string
        example: OK
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InstanceTypeResp'
              examples:
                InstanceTypeDetail200Example:
                  summary: Default instanceTypeDetail 200 response
                  x-microcks-default: true
                  value:
                    numCores: 1.4658129805029452
                    idKey:
                      instanceTypeCode: instanceTypeCode
                      providerUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    providerCode: providerCode
                    memSizeGB: 6.027456183070403
                    instanceTypeCode: instanceTypeCode
                    instanceTypeDetails:
                      tenancy: Shared
                      arch: x86_64
                      volumeDetailsList:
                      - volumeSizeGB: 0
                        volumeType: EBS
                        mountPath: mountPath
                      - volumeSizeGB: 0
                        volumeType: EBS
                        mountPath: mountPath
                    active: true
                    providerUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: YugabyteDB Anywhere Get Details of an Instance Type
      tags:
      - Instance types
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /api/v1/metadata/azu_types:
    get:
      operationId: getAZUTypes
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  enum:
                  - IO1
                  - IO2
                  - GP2
                  - GP3
                  - Scratch
                  - Persistent
                  - Hyperdisk_Balanced
                  - Hyperdisk_Extreme
                  - StandardSSD_LRS
                  - Premium_LRS
                  - PremiumV2_LRS
                  - UltraSSD_LRS
                  - Local
                  type: string
                type: array
              examples:
                GetAZUTypes200Example:
                  summary: Default getAZUTypes 200 response
                  x-microcks-default: true
                  value:
                  - IO1
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: YugabyteDB Anywhere List Supported Azure Disk Types
      tags:
      - Instance types
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /api/v1/metadata/ebs_types:
    get:
      operationId: getEBSTypes
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  enum:
                  - IO1
                  - IO2
                  - GP2
                  - GP3
                  - Scratch
                  - Persistent
                  - Hyperdisk_Balanced
                  - Hyperdisk_Extreme
                  - StandardSSD_LRS
                  - Premium_LRS
                  - PremiumV2_LRS
                  - UltraSSD_LRS
                  - Local
                  type: string
                type: array
              examples:
                GetEBSTypes200Example:
                  summary: Default getEBSTypes 200 response
                  x-microcks-default: true
                  value:
                  - IO1
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: YugabyteDB Anywhere List Supported EBS Volume Types
      tags:
      - Instance types
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /api/v1/metadata/gcp_types:
    get:
      operationId: getGCPTypes
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  enum:
                  - IO1
                  - IO2
                  - GP2
                  - GP3
                  - Scratch
                  - Persistent
                  - Hyperdisk_Balanced
                  - Hyperdisk_Extreme
                  - StandardSSD_LRS
                  - Premium_LRS
                  - PremiumV2_LRS
                  - UltraSSD_LRS
                  - Local
                  type: string
                type: array
              examples:
                GetGCPTypes200Example:
                  summary: Default getGCPTypes 200 response
                  x-microcks-default: true
                  value:
                  - IO1
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: YugabyteDB Anywhere List Supported GCP Disk Types
      tags:
      - Instance types
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    InstanceTypeKey:
      example:
        instanceTypeCode: instanceTypeCode
        providerUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      properties:
        instanceTypeCode:
          type: string
          example: OK
        providerUuid:
          format: uuid
          type: string
          example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      required:
      - instanceTypeCode
      - providerUuid
      type: object
    InstanceTypeDetails:
      example:
        tenancy: Shared
        arch: x86_64
        volumeDetailsList:
        - volumeSizeGB: 0
          volumeType: EBS
          mountPath: mountPath
        - volumeSizeGB: 0
          volumeType: EBS
          mountPath: mountPath
      properties:
        arch:
          description: Architecture for the instance.
          enum:
          - x86_64
          - aarch64
          type: string
          example: x86_64
        tenancy:
          description: Tenancy for the instance.
          enum:
          - Shared
          - Dedicated
          - Host
          type: string
          example: Shared
        volumeDetailsList:
          description: Volume Details for the instance.
          items:
            $ref: '#/components/schemas/VolumeDetails'
          type: array
          example:
          - volumeSizeGB: 0
            volumeType: EBS
            mountPath: mountPath
      type: object
    VolumeDetails:
      example:
        volumeSizeGB: 0
        volumeType: EBS
        mountPath: mountPath
      properties:
        mountPath:
          type: string
          example: /var/lib/yugabyte/example
        volumeSizeGB:
          format: int32
          type: integer
          example: 10
        volumeType:
          enum:
          - EBS
          - SSD
          - HDD
          - NVME
          type: string
          example: EBS
      required:
      - mountPath
      - volumeSizeGB
      - volumeType
      type: object
    YBPError:
      description: Generic error response from the YugabyteDB Anywhere API
      example:
        success: false
        requestUri: /customers/8918921-af3782-633de/universe/8173ab-fd2453/create
        error: There was a problem creating the universe
        httpMethod: POST
        errorJson: '{ "foo" : "bar", "baz" : [1, 2, 3] }'
        requestJson: '{ "foo" : "bar", "baz" : [1, 2, 3] }'
      properties:
        error:
          description: User-visible unstructured error message
          example: There was a problem creating the universe
          type: string
        errorJson:
          description: User visible structured error message as json object
          example: '{ "foo" : "bar", "baz" : [1, 2, 3] }'
          properties: {}
          type: object
        httpMethod:
          description: Method for HTTP call that resulted in this error
          example: POST
          type: string
        requestJson:
          description: User request JSON object
          example: '{ "foo" : "bar", "baz" : [1, 2, 3] }'
          properties: {}
          type: object
        requestUri:
          description: URI for HTTP request that resulted in this error
          example: /customers/8918921-af3782-633de/universe/8173ab-fd2453/create
          type: string
        success:
          description: Always set to false to indicate failure
          example: false
          type: boolean
      type: object
    YBPSuccess:
      example:
        success: true
        message: message
      properties:
        message:
          description: API response message.
          readOnly: true
          type: string
          example: Example message
        success:
          description: API operation status. A value of true indicates the operation was successful.
          readOnly: true
          type: boolean
          example: true
      type: object
    InstanceTypeResp:
      description: Details of a cloud instance type
      example:
        numCores: 1.4658129805029452
        idKey:
          instanceTypeCode: instanceTypeCode
          providerUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        providerCode: providerCode
        memSizeGB: 6.027456183070403
        instanceTypeCode: instanceTypeCode
        instanceTypeDetails:
          tenancy: Shared
          arch: x86_64
          volumeDetailsList:
          - volumeSizeGB: 0
            volumeType: EBS
            mountPath: mountPath
          - volumeSizeGB: 0
            volumeType: EBS
            mountPath: mountPath
        active: true
        providerUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      properties:
        active:
          description: True if the instance is active
          readOnly: true
          type: boolean
          example: true
        idKey:
          $ref: '#/components/schemas/InstanceTypeKey'
        instanceTypeCode:
          description: Instance type code
          readOnly: true
          type: string
          example: OK
        instanceTypeDetails:
          $ref: '#/components/schemas/InstanceTypeDetails'
        memSizeGB:
          description: The instance's memory size, in gigabytes
          format: double
          type: number
          example: 1.5
        numCores:
          description: The instance's number of CPU cores
          format: double
          type: number
          example: 1.5
        providerCode:
          description: Cloud provider code
          readOnly: true
          type: string
          example: OK
        providerUuid:
          description: Provider UUID
          format: uuid
          readOnly: true
          type: string
          example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      required:
      - idKey
      type: object
    InstanceType:
      description: Information about an instance
      example:
        numCores: 6.027456183070403
        idKey:
          instanceTypeCode: instanceTypeCode
          providerUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        memSizeGB: 0.8008281904610115
        instanceTypeCode: instanceTypeCode
        instanceTypeDetails:
          tenancy: Shared
          arch: x86_64
          volumeDetailsList:
          - volumeSizeGB: 0
            volumeType: EBS
            mountPath: mountPath
          - volumeSizeGB: 0
            volumeType: EBS
            mountPath: mountPath
        active: true
      properties:
        active:
          description: True if the instance is active
          readOnly: true
          type: boolean
          example: true
        idKey:
          $ref: '#/components/schemas/InstanceTypeKey'
        instanceTypeCode:
          description: Instance type code
          readOnly: true
          type: string
          example: OK
        instanceTypeDetails:
          $ref: '#/components/schemas/InstanceTypeDetails'
        memSizeGB:
          description: The instance's memory size, in gigabytes
          format: double
          type: number
          example: 1.5
        numCores:
          description: The instance's number of CPU cores
          format: double
          type: number
          example: 1.5
      required:
      - idKey
      type: object
    InstanceTypeKey_2:
      example:
        instanceTypeCode: instanceTypeCode
        providerUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      properties:
        instanceTypeCode:
          type: string
        providerUuid:
          format: uuid
          type: string
      required:
      - instanceTypeCode
      - providerUuid
      type: object
    InstanceTypeDetails_2:
      example:
        tenancy: Shared
        arch: x86_64
        volumeDetailsList:
        - volumeSizeGB: 0
          volumeType: EBS
          mountPath: mountPath
        - volumeSizeGB: 0
          volumeType: EBS
          mountPath: mountPath
      properties:
        arch:
          description: Architecture for the instance.
          enum:
          - x86_64
          - aarch64
          type: string
        tenancy:
          description: Tenancy for the instance.
          enum:
          - Shared
          - Dedicated
          - Host
          type: string
        volumeDetailsList:
          description: Volume Details for the instance.
          items:
            $ref: '#/components/schemas/VolumeDetails_2'
          type: array
      type: object
    VolumeDetails_2:
      example:
        volumeSizeGB: 0
        volumeType: EBS
        mountPath: mountPath
      properties:
        mountPath:
          type: string
        volumeSizeGB:
          format: int32
          type: integer
        volumeType:
          enum:
          - EBS
          - SSD
          - HDD
          - NVME
          type: string
      required:
      - mountPath
      - volumeSizeGB
      - volumeType
      type: object
    YBPSuccess_2:
      example:
        success: true
        message: message
      properties:
        message:
          description: API response message.
          readOnly: true
          type: string
        success:
          description: API operation status. A value of true indicates the operation was successful.
          readOnly: true
          type: boolean
      type: object
    InstanceTypeResp_2:
      description: Details of a cloud instance type
      example:
        numCores: 1.4658129805029452
        idKey:
          instanceTypeCode: instanceTypeCode
          providerUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        providerCode: providerCode
        memSizeGB: 6.027456183070403
        instanceTypeCode: instanceTypeCode
        instanceTypeDetails:
          tenancy: Shared
          arch: x86_64
          volumeDetailsList:
          - volumeSizeGB: 0
            volumeType: EBS
            mountPath: mountPath
          - volumeSizeGB: 0
            volumeType: EBS
            mountPath: mountPath
        active: true
        providerUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      properties:
        active:
          description: True if the instance is active
          readOnly: true
          type: boolean
        idKey:
          $ref: '#/components/schemas/InstanceTypeKey_2'
        instanceTypeCode:
          description: Instance type code
          readOnly: true
          type: string
        instanceTypeDetails:
          $ref: '#/components/schemas/InstanceTypeDetails_2'
        memSizeGB:
          description: The instance's memory size, in gigabytes
          format: double
          type: number
        numCores:
          description: The instance's number of CPU cores
          format: double
          type: number
        providerCode:
          description: Cloud provider code
          readOnly: true
          type: string
        providerUuid:
          description: Provider UUID
          format: uuid
          readOnly: true
          type: string
      required:
      - idKey
      type: object
    InstanceType_2:
      description: Information about an instance
      example:
        numCores: 6.027456183070403
        idKey:
          instanceTypeCode: instanceTypeCode
          providerUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        memSizeGB: 0.8008281904610115
        instanceTypeCode: instanceTypeCode
        instanceTypeDetails:
          tenancy: Shared
          arch: x86_64
          volumeDetailsList:
          - volumeSizeGB: 0
            volumeType: EBS
            mountPath: mountPath
          - volumeSizeGB: 0
            volumeType: EBS
            mountPath: mountPath
        active: true
      properties:
        active:
          description: True if the instance is active
          readOnly: true
          type: boolean
        idKey:
          $ref: '#/components/schemas/InstanceTypeKey_2'
        instanceTypeCode:
          description: Instance type code
          readOnly: true
          type: string
        instanceTypeDetails:
          $ref: '#/components/schemas/InstanceTypeDetails_2'
        memSizeGB:
          description: The instance's memory size, in gigabytes
          format: double
          type: number
        numCores:
          description: The instance's number of CPU cores
          format: double
          type: number
      required:
      - idKey
      type: object
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API key obtained from the YugabyteDB Aeon UI under User Profile > API Keys. Pass the key as a Bearer token in the Authorization header.
definitions:
  VolumeDetails:
    properties:
      mountPath:
        type: string
      volumeSizeGB:
        format: int32
        type: integer
      volumeType:
        enum:
        - EBS
        - SSD
        - HDD
        - NVME
        type: string
    required:
    - mountPath
    - volumeSizeGB
    - volumeType
    type: object
  YBPSuccess:
    properties:
      message:
        description: API response message.
        readOnly: true
        type: string
      success:
        description: API operation status. A value of true indicates the operation was successful.
        readOnly: true
        type: boolean
    type: object
  Provider:
    properties:
      active:
        description: Provider active status
        readOnly: true
        type: boolean
      airGapInstall:
        description: Transient property - only present in mutate API request
        type: boolean
      code:
        description: Provider cloud code
        type: string
      config:
        additionalProperties:
          type: string
        type: object
      customHostCidrs:
        description: Transient property - only present in mutate API request
        items:
          type: string
        type: array
      customerUUID:
        description: Customer uuid
        format: uuid
        readOnly: true
        type: string
      destVpcId:
        description: Transient property - only present in mutate API request
        type: string
      hostVpcId:
        description: Transient property - only present in mutate API request
        type: string
      hostVpcRegion:
        description: Transient property - only present in mutate API request
        type: string
      hostedZoneId:
        type: string
      hostedZoneName:
        type: string
      keyPairName:
        description: Transient property - only present in mutate API request
        type: string
      name:
        description: Provider name
        type: string
      ntpServers:
        description: Transient property - only present in mutate API request
        items:
          type: string
        type: array
      overrideKeyValidate:
        description: Transient property - only present in mutate API request
        type: boolean
      regions:
        items:
          $ref: '#/definitions/Region'
        type: array
      setUpChrony:
        description: Transient property - only present in mutate API request
        type: boolean
      showSetUpChrony:
        description: Transient property - only present in mutate API request
        type: boolean
      sshPort:
        description: Transient property - only present in mutate API request
        format: int32
        type: integer
      sshPrivateKeyContent:
        description: Transient property - only present in mutate API request
        type: string
      sshUser:
        description: Transient property - only present in mutate API request
        type: string
      uuid:
        description: Provider uuid
        format: uuid
        readOnly: true
        type: string
    required:
    - regions
    type: object
  InstanceTypeKey:
    properties:
      instanceTypeCode:
        type: string
      providerUuid:
        format: uuid
        type: string
    required:
    - instanceTypeCode
    - providerUuid
    type: object
  YBPError:
    description: Generic error response from the YugabyteDB Anywhere API
    properties:
      error:
        description: User-visible unstructured error message
        example: There was a problem creating the universe
        type: string
      errorJson:
        description: User visible error message as json object
        example: '{ "foo" : "bar", "baz" : [1, 2, 3] }'
        type: object
      success:
        description: Always set to false to indicate failure
        example: false
        type: boolean
    type: object
  AvailabilityZone:
    description: Availability zone (AZ) for a region
    properties:
      active:
        description: AZ status. This value is `true` for an active AZ.
        readOnly: true
        type: boolean
      code:
        description: AZ code
        example: us-west1-a
        type: string
      config:
        additionalProperties:
          type: string
        description: AZ configuration values
        type: object
      kubeconfigPath:
        description: Path to Kubernetes configuration file
        readOnly: true
        type: string
      name:
        description: AZ name
        example: us-west1-a
        type: string
      secondarySubnet:
        description: AZ secondary subnet
        example: secondary subnet id
        type: string
      subnet:
        description: AZ subnet
        example: subnet id
        type: string
      uuid:
        description: AZ UUID
        format: uuid
        readOnly: true
        type: string
    required:
    - name
    type: object
  Region:
    description: Region within a given provider. Typically, this maps to a single cloud provider region.
    properties:
      active:
        readOnly: true
        type: boolean
      architecture:
        enum:
        - x86_64
        - arm64
        type: string
      code:
        description: Cloud provider region code
        example: us-west-2
        type: string
      config:
        additionalProperties:
          type: string
        type: object
      latitude:
        description: The region's latitude
        example: 37.22
        format: double
        readOnly: true
        type: number
      longitude:
        description: The region's longitude
        example: -120.01
        format: double
        readOnly: true
        type: number
      name:
        description: Cloud provider region name
        example: US West (Oregon)
        readOnly: true
        type: string
      securityGroupId:
        type: string
      uuid:
        description: Region UUID
        format: uuid
        readOnly: true
        type: string
      vnetName:
        type: string
      ybImage:
        description: The AMI to 

# --- truncated at 32 KB (33 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/openapi/yugabytedb-instance-types-api-openapi.yml