YugabyteDB Availability Zones API

The Availability Zones API from YugabyteDB — 4 operation(s) for availability zones.

Operations 6

POST /api/v1/customers/{cUUID}/providers/{pUUID}/provider_regions/{rUUID}/region_zones Create an availability zone #
PUT /api/v1/customers/{cUUID}/providers/{pUUID}/provider_regions/{rUUID}/region_zones/{azUUID} Modify an availability zone #
GET /api/v1/customers/{cUUID}/providers/{pUUID}/regions/{rUUID}/zones List availability zones #
POST /api/v1/customers/{cUUID}/providers/{pUUID}/regions/{rUUID}/zones Create an availability zone - deprecated #
DELETE /api/v1/customers/{cUUID}/providers/{pUUID}/regions/{rUUID}/zones/{azUUID} Delete an availability zone #
PUT /api/v1/customers/{cUUID}/providers/{pUUID}/regions/{rUUID}/zones/{azUUID} Edit an Availabilty Zone - deprecated #

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

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-availability-zones-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.

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

OpenAPI Specification

yugabytedb-availability-zones-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Yugabytedb Availability Zones 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 Availability Zones 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: Availability Zones
paths:
  /api/v1/customers/{cUUID}/providers/{pUUID}/provider_regions/{rUUID}/region_zones:
    post:
      description: 'WARNING: This is a preview API that could change.'
      operationId: createZone
      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/AvailabilityZone'
        description: Availability Zone to create
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties:
                  $ref: '#/components/schemas/AvailabilityZone'
                type: object
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Create an availability zone
      tags:
      - Availability Zones
      x-codegen-request-body-name: azData
    servers:
    - url: /
  /api/v1/customers/{cUUID}/providers/{pUUID}/provider_regions/{rUUID}/region_zones/{azUUID}:
    put:
      description: 'WARNING: This is a preview API that could change.'
      operationId: editZone
      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: path
        name: azUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AvailabilityZone'
        description: Availability zone to edit
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AvailabilityZone'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Modify an availability zone
      tags:
      - Availability Zones
      x-codegen-request-body-name: azData
    servers:
    - url: /
  /api/v1/customers/{cUUID}/providers/{pUUID}/regions/{rUUID}/zones:
    get:
      operationId: listOfAZ
      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
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/AvailabilityZone'
                type: array
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: List availability zones
      tags:
      - Availability Zones
    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/:rUUID/region_zones instead
      operationId: createAZ
      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/AvailabilityZoneFormData'
        description: Availability zone form data
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties:
                  $ref: '#/components/schemas/AvailabilityZone'
                type: object
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Create an availability zone - deprecated
      tags:
      - Availability Zones
      x-codegen-request-body-name: azFormData
    servers:
    - url: /
  /api/v1/customers/{cUUID}/providers/{pUUID}/regions/{rUUID}/zones/{azUUID}:
    delete:
      operationId: deleteAZ
      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: path
        name: azUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPSuccess'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Delete an availability zone
      tags:
      - Availability Zones
    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/:rUUID/region_zones/:zUUID instead
      operationId: editAZ
      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: path
        name: azUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AvailabilityZoneFormData'
        description: Availability zone edit form data
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AvailabilityZone'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Edit an Availabilty Zone - deprecated
      tags:
      - Availability Zones
      x-codegen-request-body-name: azFormData
    servers:
    - url: /
components:
  schemas:
    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
    AvailabilityZoneData:
      description: Details of an availability zone, used by the API and UI to validate data against input constraints
      example:
        subnet: subnet
        code: code
        name: name
        secondarySubnet: secondarySubnet
      properties:
        code:
          description: AZ code
          type: string
        name:
          description: AZ name
          type: string
        secondarySubnet:
          description: AZ secondary subnet
          type: string
        subnet:
          description: AZ subnet
          type: string
      required:
      - code
      - name
      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
    AvailabilityZoneFormData:
      example:
        availabilityZones:
        - subnet: subnet
          code: code
          name: name
          secondarySubnet: secondarySubnet
        - subnet: subnet
          code: code
          name: name
          secondarySubnet: secondarySubnet
      properties:
        availabilityZones:
          description: List of availability zones
          items:
            $ref: '#/components/schemas/AvailabilityZoneData'
          type: array
      required:
      - availabilityZones
      type: object
    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
    YBPSuccess:
      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
    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
    YBPSuccess_2:
      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
    AvailabilityZoneFormData_2:
      properties:
        availabilityZones:
          description: List of availability zones
          items:
            $ref: '#/components/schemas/AvailabilityZoneData_2'
          type: array
      required:
      - availabilityZones
      type: object
    AvailabilityZone_2:
      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
    AvailabilityZoneData_2:
      description: Details of an availability zone, used by the API and UI to validate data against input constraints
      properties:
        code:
          description: AZ code
          type: string
        name:
          description: AZ name
          type: string
        subnet:
          description: AZ subnet
          type: string
      required:
      - code
      - name
      type: object
    AvailabilityZone_3:
      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
          example: true
        code:
          description: AZ code
          example: us-west1-a
          type: string
        config:
          additionalProperties:
            type: string
          description: AZ configuration values
          type: object
          example: {}
        details:
          $ref: '#/components/schemas/AvailabilityZoneDetails'
        kubeconfigPath:
          description: Path to Kubernetes configuration file
          readOnly: true
          type: string
          example: /var/lib/yugabyte/example
        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
          example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      required:
      - name
      type: object
    AvailabilityZoneData_3:
      description: Details of an availability zone, used by the API and UI to validate data against input constraints
      example:
        subnet: subnet
        code: code
        name: name
        secondarySubnet: secondarySubnet
      properties:
        code:
          description: AZ code
          type: string
          example: OK
        name:
          description: AZ name
          type: string
          example: example-name
        secondarySubnet:
          description: AZ secondary subnet
          type: string
          example: example-secondarySubnet
        subnet:
          description: AZ subnet
          type: string
          example: example-subnet
      required:
      - code
      - name
      type: object
    AvailabilityZoneFormData_3:
      example:
        availabilityZones:
        - subnet: subnet
          code: code
          name: name
          secondarySubnet: secondarySubnet
        - subnet: subnet
          code: code
          name: name
          secondarySubnet: secondarySubnet
      properties:
        availabilityZones:
          description: List of availability zones
          items:
            $ref: '#/components/schemas/AvailabilityZoneData_3'
          type: array
          example:
          - subnet: subnet
            code: code
            name: name
            secondarySubnet: secondarySubnet
      required:
      - availabilityZones
      type: object
    KubernetesRegionInfo_2:
      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
          example: example-certManagerClusterIssuer
        certManagerIssuer:
          description: <b style="color:#ff0000">Deprecated since YBA version 2024.2.3.0.</b>. Use certManagerIssuerKind and certManagerIssuerName instead
          type: string
          example: example-certManagerIssuer
        certManagerIssuerGroup:
          type: string
          example: example-certManagerIssuerGroup
        certManagerIssuerKind:
          type: string
          example: DEFAULT
        certManagerIssuerName:
          type: string
          example: example-certManagerIssuerName
        isKubernetesOperatorControlled:
          readOnly: true
          type: boolean
          example: true
        kubeConfig:
          readOnly: true
          type: string
          example: example-kubeConfig
        kubeConfigContent:
          type: string
          example: example-kubeConfigContent
        kubeConfigName:
          type: string
          example: example-kubeConfigName
        kubeDomain:
          type: string
          example: example.com
        kubeNamespace:
          type: string
          example: example-kubeNamespace
        kubePodAddressTemplate:
          type: string
          example: example-kubePodAddressTemplate
        kubernetesImagePullSecretName:
          type: string
          example: REDACTED
        kubernetesImageRegistry:
          type: string
          example: example-kubernetesImageRegistry
        kubernetesOperatorControlled:
          type: boolean
          example: true
        kubernetesProvider:
          type: string
          example: example-kubernetesProvider
        kubernetesPullSecret:
          readOnly: true
          type: string
          example: REDACTED
        kubernetesPullSecretContent:
          type: string
          example: REDACTED
        kubernetesPullSecretName:
          type: string
          example: REDACTED
        kubernetesServiceAccount:
          description: <b style="color:#ff0000">Deprecated since YBA version 2.17.3.0.</b> kubernetes service account is not needed.
          type: string
          example: example-kubernetesServiceAccount
        kubernetesStorageClass:
          type: string
          example: example-kubernetesStorageClass
        overrides:
          type: string
          example: example-overrides
      required:
      - kubernetesOperatorControlled
      type: object
    YBPSuccess_3:
      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
    AvailabilityZone_4:
      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
          example: true
        code:
          description: AZ code
          example: us-west1-a
          type: string
        config:
          additionalProperties:
            type: string
          description: AZ configuration values
          type: object
          example: {}
        details:
          $ref: '#/components/schemas/AvailabilityZoneDetails'
        kubeconfigPath:
          description: Path to Kubernetes configuration file
          readOnly: true
          type: string
          example: /var/lib/yugabyte/example
        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
          example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      required:
      - name
      type: object
    AvailabilityZoneData_4:
      description: Details of an availability zone, used by the API and UI to validate data against input constraints
      example:
        subnet: subnet
        code: code
        name: name
        secondarySubnet: secondarySubnet
      properties:
        code:
          description: AZ code
          type: string
          example: OK
        name:
          description: AZ name
          type: string
          example: example-name
        secondarySubnet:
          description: AZ secondary subnet
          type: string
          example: example-secondarySubnet
        subnet:
          description: AZ subnet
          type: string
          example: example-subnet
      required:
      - code
      - name
      type: object
    AvailabilityZoneFormData_4:
      example:
        availabilityZones:
        - subnet: subnet
          code

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