YugabyteDB

YugabyteDB Region management API

The Region management API from YugabyteDB — 5 operation(s) for region management.

GitHub OpenAPI

Operations 7

POST /api/v1/customers/{cUUID}/providers/{pUUID}/provider_regions Create a new region #
PUT /api/v1/customers/{cUUID}/providers/{pUUID}/provider_regions/{rUUID} Modify a region #
GET /api/v1/customers/{cUUID}/providers/{pUUID}/regions List a provider's regions #
POST /api/v1/customers/{cUUID}/providers/{pUUID}/regions Create Region - deprecated #
DELETE /api/v1/customers/{cUUID}/providers/{pUUID}/regions/{rUUID} Delete a region #
PUT /api/v1/customers/{cUUID}/providers/{pUUID}/regions/{rUUID} Edit regions - deprecated #
GET /api/v1/customers/{cUUID}/regions List regions for all providers #

Documentation

📖
Documentation
https://docs.yugabyte.com/stable/yugabyte-cloud/managed-automation/managed-api/
📖
APIReference
https://api-docs.yugabyte.com/docs/managed-apis/
📖
GettingStarted
https://docs.yugabyte.com/stable/yugabyte-cloud/managed-automation/managed-api/managed-apikeys/
📖
Authentication
https://docs.yugabyte.com/stable/yugabyte-cloud/managed-automation/managed-api/managed-apikeys/
📖
Documentation
https://docs.yugabyte.com/stable/yugabyte-platform/anywhere-automation/anywhere-api/
📖
APIReference
https://api-docs.yugabyte.com/docs/yugabyte-platform/
📖
GettingStarted
https://docs.yugabyte.com/stable/yugabyte-platform/anywhere-automation/anywhere-api/
📖
Authentication
https://docs.yugabyte.com/stable/yugabyte-platform/anywhere-automation/anywhere-api/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/openapi/yugabytedb-region-management-api-openapi.yml

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

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/yugabytedb-region-management-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

yugabytedb-region-management-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Yugabytedb Region management API
  version: v1
  contact:
    name: https://docs.yugabyte.com
  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)
  x-refined-note:
  - x-source differs across the merged source definitions and was not carried
  - x-split-from differs across the merged source definitions and was not carried
  description: 'Operations tagged Region management across 4 of this provider''s published API definitions: openapi_2.yaml, platform.swagger.json, yugabytedb-anywhere-v1-full.yaml, yugabytedb-anywhere-v1-providers-infra.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: /
tags:
- name: Region management
paths:
  /api/v1/customers/{cUUID}/providers/{pUUID}/provider_regions:
    post:
      description: 'WARNING: This is a preview API that could change.'
      operationId: createProviderRegion
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: pUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Region'
        description: Specification of Region to be created
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Region'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Create a new region
      tags:
      - Region management
      x-codegen-request-body-name: region
    servers:
    - url: /
  /api/v1/customers/{cUUID}/providers/{pUUID}/provider_regions/{rUUID}:
    put:
      description: 'WARNING: This is a preview API that could change.'
      operationId: editProviderRegion
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: pUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: rUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Region'
        description: Specification of Region to be edited
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Region'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Modify a region
      tags:
      - Region management
      x-codegen-request-body-name: region
    servers:
    - url: /
  /api/v1/customers/{cUUID}/providers/{pUUID}/regions:
    get:
      operationId: getRegion
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: pUUID
        required: true
        schema:
          format: uuid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/Region'
                type: array
          description: successful operation
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPError'
          description: If there was a server or database issue when listing the regions
      security:
      - apiKeyAuth: []
      summary: List a provider's regions
      tags:
      - Region management
    post:
      deprecated: true
      description: <b style="color:#ff0000">Deprecated since YBA version 2.18.2.0.</b></p>Use /api/v1/customers/{cUUID}/provider/{pUUID}/provider_regions instead
      operationId: createRegion
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: pUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RegionFormData'
        description: region form data for new region to be created
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Region'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Create Region - deprecated
      tags:
      - Region management
      x-codegen-request-body-name: region
    servers:
    - url: /
  /api/v1/customers/{cUUID}/providers/{pUUID}/regions/{rUUID}:
    delete:
      operationId: deleteRegion
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: pUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: rUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Delete a region
      tags:
      - Region management
    put:
      deprecated: true
      description: <b style="color:#ff0000">Deprecated since YBA version 2.18.2.0.</b></p>Use /api/v1/customers/{cUUID}/provider/{pUUID}/provider_regions instead
      operationId: editRegion
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: pUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: rUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RegionFormData'
        description: region edit form data
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Edit regions - deprecated
      tags:
      - Region management
      x-codegen-request-body-name: region
    servers:
    - url: /
  /api/v1/customers/{cUUID}/regions:
    get:
      operationId: listAllRegions
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/Region'
                type: array
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: List regions for all providers
      tags:
      - Region management
    servers:
    - url: /
components:
  schemas:
    KubernetesRegionInfo:
      example:
        kubeNamespace: kubeNamespace
        kubernetesImagePullSecretName: kubernetesImagePullSecretName
        kubernetesPullSecretContent: kubernetesPullSecretContent
        certManagerIssuer: certManagerIssuer
        isKubernetesOperatorControlled: true
        kubernetesOperatorControlled: true
        kubeConfig: kubeConfig
        kubeDomain: kubeDomain
        overrides: overrides
        certManagerIssuerName: certManagerIssuerName
        kubernetesPullSecret: kubernetesPullSecret
        kubeConfigName: kubeConfigName
        certManagerIssuerKind: certManagerIssuerKind
        kubePodAddressTemplate: kubePodAddressTemplate
        kubernetesProvider: kubernetesProvider
        kubeConfigContent: kubeConfigContent
        kubernetesPullSecretName: kubernetesPullSecretName
        certManagerIssuerGroup: certManagerIssuerGroup
        kubernetesImageRegistry: kubernetesImageRegistry
        certManagerClusterIssuer: certManagerClusterIssuer
        kubernetesStorageClass: kubernetesStorageClass
        kubernetesServiceAccount: kubernetesServiceAccount
      properties:
        certManagerClusterIssuer:
          description: <b style="color:#ff0000">Deprecated since YBA version 2024.2.3.0.</b>. Use certManagerIssuerKind and certManagerIssuerName instead
          type: string
        certManagerIssuer:
          description: <b style="color:#ff0000">Deprecated since YBA version 2024.2.3.0.</b>. Use certManagerIssuerKind and certManagerIssuerName instead
          type: string
        certManagerIssuerGroup:
          type: string
        certManagerIssuerKind:
          type: string
        certManagerIssuerName:
          type: string
        isKubernetesOperatorControlled:
          readOnly: true
          type: boolean
        kubeConfig:
          readOnly: true
          type: string
        kubeConfigContent:
          type: string
        kubeConfigName:
          type: string
        kubeDomain:
          type: string
        kubeNamespace:
          type: string
        kubePodAddressTemplate:
          type: string
        kubernetesImagePullSecretName:
          type: string
        kubernetesImageRegistry:
          type: string
        kubernetesOperatorControlled:
          type: boolean
        kubernetesProvider:
          type: string
        kubernetesPullSecret:
          readOnly: true
          type: string
        kubernetesPullSecretContent:
          type: string
        kubernetesPullSecretName:
          type: string
        kubernetesServiceAccount:
          description: <b style="color:#ff0000">Deprecated since YBA version 2.17.3.0.</b> kubernetes service account is not needed.
          type: string
        kubernetesStorageClass:
          type: string
        overrides:
          type: string
      required:
      - kubernetesOperatorControlled
      type: object
    AvailabilityZone:
      description: Availability zone (AZ) for a region
      example:
        subnet: subnet id
        code: us-west1-a
        name: us-west1-a
        active: true
        details:
          cloudInfo:
            kubernetes:
              kubeNamespace: kubeNamespace
              kubernetesImagePullSecretName: kubernetesImagePullSecretName
              kubernetesPullSecretContent: kubernetesPullSecretContent
              certManagerIssuer: certManagerIssuer
              isKubernetesOperatorControlled: true
              kubernetesOperatorControlled: true
              kubeConfig: kubeConfig
              kubeDomain: kubeDomain
              overrides: overrides
              certManagerIssuerName: certManagerIssuerName
              kubernetesPullSecret: kubernetesPullSecret
              kubeConfigName: kubeConfigName
              certManagerIssuerKind: certManagerIssuerKind
              kubePodAddressTemplate: kubePodAddressTemplate
              kubernetesProvider: kubernetesProvider
              kubeConfigContent: kubeConfigContent
              kubernetesPullSecretName: kubernetesPullSecretName
              certManagerIssuerGroup: certManagerIssuerGroup
              kubernetesImageRegistry: kubernetesImageRegistry
              certManagerClusterIssuer: certManagerClusterIssuer
              kubernetesStorageClass: kubernetesStorageClass
              kubernetesServiceAccount: kubernetesServiceAccount
        kubeconfigPath: kubeconfigPath
        config:
          key: config
        uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        secondarySubnet: secondary subnet id
      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
        details:
          $ref: '#/components/schemas/AvailabilityZoneDetails'
        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. This must be specified for existing AZs on update
          format: uuid
          type: string
      required:
      - name
      type: object
    RegionFormData:
      example:
        securityGroupId: securityGroupId
        hostVpcId: hostVpcId
        code: code
        destVpcId: destVpcId
        ybImage: ybImage
        latitude: 0.8008281904610115
        name: name
        vnetName: vnetName
        hostVpcRegion: hostVpcRegion
        longitude: 6.027456183070403
      properties:
        code:
          type: string
        destVpcId:
          type: string
        hostVpcId:
          type: string
        hostVpcRegion:
          type: string
        latitude:
          format: double
          type: number
        longitude:
          format: double
          type: number
        name:
          type: string
        securityGroupId:
          type: string
        vnetName:
          type: string
        ybImage:
          type: string
      required:
      - code
      - destVpcId
      - hostVpcId
      - hostVpcRegion
      - latitude
      - longitude
      - name
      - securityGroupId
      - vnetName
      - ybImage
      type: object
    AWSRegionCloudInfo:
      example:
        securityGroupId: securityGroupId
        vnet: vnet
        ybImage: ybImage
        arch: x86_64
      properties:
        arch:
          description: <b style="color:#ff0000">Deprecated since YBA version 2.20.0.</b> Use provider.imageBundle instead
          enum:
          - x86_64
          - aarch64
          type: string
        securityGroupId:
          type: string
        vnet:
          type: string
        ybImage:
          description: <b style="color:#ff0000">Deprecated since YBA version 2.20.0.</b> Use provider.imageBundle instead
          type: string
      type: object
    AZCloudInfo:
      example:
        kubernetes:
          kubeNamespace: kubeNamespace
          kubernetesImagePullSecretName: kubernetesImagePullSecretName
          kubernetesPullSecretContent: kubernetesPullSecretContent
          certManagerIssuer: certManagerIssuer
          isKubernetesOperatorControlled: true
          kubernetesOperatorControlled: true
          kubeConfig: kubeConfig
          kubeDomain: kubeDomain
          overrides: overrides
          certManagerIssuerName: certManagerIssuerName
          kubernetesPullSecret: kubernetesPullSecret
          kubeConfigName: kubeConfigName
          certManagerIssuerKind: certManagerIssuerKind
          kubePodAddressTemplate: kubePodAddressTemplate
          kubernetesProvider: kubernetesProvider
          kubeConfigContent: kubeConfigContent
          kubernetesPullSecretName: kubernetesPullSecretName
          certManagerIssuerGroup: certManagerIssuerGroup
          kubernetesImageRegistry: kubernetesImageRegistry
          certManagerClusterIssuer: certManagerClusterIssuer
          kubernetesStorageClass: kubernetesStorageClass
          kubernetesServiceAccount: kubernetesServiceAccount
      properties:
        kubernetes:
          $ref: '#/components/schemas/KubernetesRegionInfo'
      type: object
    Region:
      description: Region within a given provider. Typically, this maps to a single cloud provider region.
      example:
        securityGroupId: securityGroupId
        code: us-west-2
        ybImage: TODO
        latitude: 37.22
        name: US West (Oregon)
        active: true
        details:
          cloudInfo:
            kubernetes:
              kubeNamespace: kubeNamespace
              kubernetesImagePullSecretName: kubernetesImagePullSecretName
              kubernetesPullSecretContent: kubernetesPullSecretContent
              certManagerIssuer: certManagerIssuer
              isKubernetesOperatorControlled: true
              kubernetesOperatorControlled: true
              kubeConfig: kubeConfig
              kubeDomain: kubeDomain
              overrides: overrides
              certManagerIssuerName: certManagerIssuerName
              kubernetesPullSecret: kubernetesPullSecret
              kubeConfigName: kubeConfigName
              certManagerIssuerKind: certManagerIssuerKind
              kubePodAddressTemplate: kubePodAddressTemplate
              kubernetesProvider: kubernetesProvider
              kubeConfigContent: kubeConfigContent
              kubernetesPullSecretName: kubernetesPullSecretName
              certManagerIssuerGroup: certManagerIssuerGroup
              kubernetesImageRegistry: kubernetesImageRegistry
              certManagerClusterIssuer: certManagerClusterIssuer
              kubernetesStorageClass: kubernetesStorageClass
              kubernetesServiceAccount: kubernetesServiceAccount
            gcp:
              instanceTemplate: instanceTemplate
              ybImage: ybImage
            aws:
              securityGroupId: securityGroupId
              vnet: vnet
              ybImage: ybImage
              arch: x86_64
            azu:
              securityGroupId: securityGroupId
              vnet: vnet
              ybImage: ybImage
              azuNetworkRGOverride: azuNetworkRGOverride
              azuRGOverride: azuRGOverride
        vnetName: vnetName
        zones:
        - subnet: subnet id
          code: us-west1-a
          name: us-west1-a
          active: true
          details:
            cloudInfo:
              kubernetes:
                kubeNamespace: kubeNamespace
                kubernetesImagePullSecretName: kubernetesImagePullSecretName
                kubernetesPullSecretContent: kubernetesPullSecretContent
                certManagerIssuer: certManagerIssuer
                isKubernetesOperatorControlled: true
                kubernetesOperatorControlled: true
                kubeConfig: kubeConfig
                kubeDomain: kubeDomain
                overrides: overrides
                certManagerIssuerName: certManagerIssuerName
                kubernetesPullSecret: kubernetesPullSecret
                kubeConfigName: kubeConfigName
                certManagerIssuerKind: certManagerIssuerKind
                kubePodAddressTemplate: kubePodAddressTemplate
                kubernetesProvider: kubernetesProvider
                kubeConfigContent: kubeConfigContent
                kubernetesPullSecretName: kubernetesPullSecretName
                certManagerIssuerGroup: certManagerIssuerGroup
                kubernetesImageRegistry: kubernetesImageRegistry
                certManagerClusterIssuer: certManagerClusterIssuer
                kubernetesStorageClass: kubernetesStorageClass
                kubernetesServiceAccount: kubernetesServiceAccount
          kubeconfigPath: kubeconfigPath
          config:
            key: config
          uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          secondarySubnet: secondary subnet id
        - subnet: subnet id
          code: us-west1-a
          name: us-west1-a
          active: true
          details:
            cloudInfo:
              kubernetes:
                kubeNamespace: kubeNamespace
                kubernetesImagePullSecretName: kubernetesImagePullSecretName
                kubernetesPullSecretContent: kubernetesPullSecretContent
                certManagerIssuer: certManagerIssuer
                isKubernetesOperatorControlled: true
                kubernetesOperatorControlled: true
                kubeConfig: kubeConfig
                kubeDomain: kubeDomain
                overrides: overrides
                certManagerIssuerName: certManagerIssuerName
                kubernetesPullSecret: kubernetesPullSecret
                kubeConfigName: kubeConfigName
                certManagerIssuerKind: certManagerIssuerKind
                kubePodAddressTemplate: kubePodAddressTemplate
                kubernetesProvider: kubernetesProvider
                kubeConfigContent: kubeConfigContent
                kubernetesPullSecretName: kubernetesPullSecretName
                certManagerIssuerGroup: certManagerIssuerGroup
                kubernetesImageRegistry: kubernetesImageRegistry
                certManagerClusterIssuer: certManagerClusterIssuer
                kubernetesStorageClass: kubernetesStorageClass
                kubernetesServiceAccount: kubernetesServiceAccount
          kubeconfigPath: kubeconfigPath
          config:
            key: config
          uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          secondarySubnet: secondary subnet id
        config:
          key: config
        uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        longitude: -120.01
      properties:
        active:
          readOnly: true
          type: boolean
        code:
          description: Cloud provider region code
          example: us-west-2
          type: string
        config:
          additionalProperties:
            type: string
          type: object
        details:
          $ref: '#/components/schemas/RegionDetails'
        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:
          description: <b style="color:#ff0000">Deprecated since YBA version 2.17.2.0.</b> Moved to regionDetails.cloudInfo aws/azure securityGroupId property
          type: string
        uuid:
          description: Region UUID
          format: uuid
          readOnly: true
          type: string
        vnetName:
          description: <b style="color:#ff0000">Deprecated since YBA version 2.17.2.0.</b> Moved to regionDetails.cloudInfo aws/azure vnet property
          type: string
        ybImage:
          description: <b style="color:#ff0000">Deprecated since YBA version 2.17.2.0.</b> Moved to details.cloudInfo aws/gcp/azure ybImage property
          example: TODO
          type: string
        zones:
          items:
            $ref: '#/components/schemas/AvailabilityZone'
          type: array
      required:
      - zones
      type: object
    GCPRegionCloudInfo:
      example:
        instanceTemplate: instanceTemplate
        ybImage: ybImage
      properties:
        instanceTemplate:
          description: The instance template to be used for nodes created in this region.
          type: string
        ybImage:
          description: <b style="color:#ff0000">Deprecated since YBA version 2.20.0.</b> Use provider.imageBundle instead
          type: string
      type: object
    RegionCloudInfo:
      example:
        kubernetes:
          kubeNamespace: kubeNamespace
          kubernetesImagePullSecretName: kubernetesImagePullSecretName
          kubernetesPullSecretContent: kubernetesPullSecretContent
          certManagerIssuer: certManagerIssuer
          isKubernetesOperatorControlled: true
          kubernetesOperatorControlled: true
          kubeConfig: kubeConfig
          kubeDomain: kubeDomain
          overrides: overrides
          certManagerIssuerName: certManagerIssuerName
          kubernetesPullSecret: kubernetesPullSecret
          kubeConfigName: kubeConfigName
          certManagerIssuerKind: certManagerIssuerKind
          kubePodAddressTemplate: kubePodAddressTemplate
          kubernetesProvider: kubernetesProvider
          kubeConfigContent: kubeConfigContent
          kubernetesPullSecretName: kubernetesPullSecretName
          certManagerIssuerGroup: certManagerIssuerGroup
          kubernetesImageRegistry: kubernetesImageRegistry
          certManagerClusterIssuer: certManagerClusterIssuer
          kubernetesStorageClass: kubernetesStorageClass
          kubernetesServiceAccount: kubernetesServiceAccount
        gcp:
          instanceTemplate: instanceTemplate
          ybImage: ybImage
        aws:
          securityGroupId: securityGroupId
          vnet: vnet
          ybImage: ybImage
          arch: x86_64
        azu:
          securityGroupId: securityGroupId
          vnet: vnet
          ybImage: ybImage
          azuNetworkRGOverride: azuNetworkRGOverride
          azuRGOverride: azuRGOverride
      properties:
        aws:
          $ref: '#/components/schemas/AWSRegionCloudInfo'
        azu:
          $ref: '#/components/schemas/AzureRegionCloudInfo'
        gcp:
          $ref: '#/components/schemas/GCPRegionCloudInfo'
        kubernetes:
          $ref: '#/components/schemas/KubernetesRegionInfo'
      type: object
    AvailabilityZoneDetails:
      example:
        cloudInfo:
          kubernetes:
            kubeNamespace: kubeNamespace
            kubernetesImagePullSecretName: kubernetesImagePullSecretName
            kubernetesPullSecretContent: kubernetesPullSecretContent
            certManagerIssuer: certManagerIssuer
            isKubernetesOperatorControlled: true
            kubernetesOperatorControlled: true
            kubeConfig: kubeConfig
            kubeDomain: kubeDomain
            overrides: overrides
            certManagerIssuerName: certManagerIssuerName
            kubernetesPullSecret: kubernetesPullSecret
            kubeConfigName: kubeConfigName
            certManagerIssuerKind: certManagerIssuerKind
            kubePodAddressTemplate: kubePodAddressTemplate
            kubernetesProvider: kubernetesProvider
            kubeConfigContent: kubeConfigContent
            kubernetesPullSecretName: kubernetesPullSecretName
            certManagerIssuerGroup: certManagerIssuerGroup
            kubernetesImageRegistry: kubernetesImageRegistry
            certManagerClusterIssuer: certManagerClusterIssuer
            kubernetesStorageClass: kubernetesStorageClass
            kubernetesServiceAccount: kubernetesServiceAccount
      properties:
        cloudInfo:
          $ref: '#/components/schemas/AZCloudInfo'
      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
    RegionDetails:
      example:
        cloudInfo:
          kubernetes:
            kubeNamespace: kubeNamespace
            kubernetesImagePullSecretName: kubernetesImagePullSecretName
            kubernetesPullSecretContent: kubernetesPullSecretContent
            certManagerIssuer: certManagerIssuer
            isKubernetesOperatorControlled: true
            kubernetesOperatorControlled: true
            kubeConfig: kubeConfig
            kubeDomain: kubeDomain
            overrides: overrides
            certManagerIssuerName: certManagerIssuerName
            kubernetesPullSecret: kubernetesPullSecret
            kubeConfigName: kubeConfigName
            certManagerIssuerKind: certManagerIssuerKind
            kubePodAddressTemplate: kubePodAddressTemplate
            kubernetesProvider: kubernetesProvider
            kubeConfigContent: kubeConfigContent
            kubernetesPullSecretName: kubernetesPullSecretName
            certManagerIssuerGroup: certManagerIssuerGroup
            kubernetesImageRegistry: kubernetesImageRegistry
            certManagerClusterIssuer: certManagerClusterIssuer
            kubernetesStorageClass: kubernetesStorageClass
            kubernetesServiceAccount: kubernetesServiceAccount
          gcp:
            instanceTemplate: instanceTemplate
            ybImage: ybImage
          aws:
            securityGroupId: securityGroupId
            vnet: vnet
            ybImage: ybImage
            arch: x86_64
          azu:
            securityGroupId: securityGroupId
            vnet: vnet
            ybImage: ybImage
            azuNetworkRGOverride: azuNetworkRGOverride
            azuRGOverride: azuRGOverride
      properties:
        cloudInfo:
          $ref: '#/components/schemas/RegionCloudInfo'
      type: object
    AzureRegionCloudInfo:
      example:
        securityGroupId: securityGroupId
        vnet: vnet
        ybImage: ybImage
        azuNetworkRGOverride: azuNetworkRGOverride
        azuRGOverride: azuRGOverride
      properties:
        azuNetworkRGOverride:
          type: string
        azuRGOverride:
          type: string
        securityGroupId:
          type: string
        vnet:
          type: string
        ybImage:
          description: <b style="color:#ff0000">Deprecated since YBA version 2.20.0.</b> Use provider.imageBundle instead
          type: string
      type: object
    Region_2:
      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 be used in this region.
          example: TODO
          type: string
        zones:
          items:
            $ref: '#/components/schemas/AvailabilityZon

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