YugabyteDB

YugabyteDB Universe node metadata (metamaster) API

The Universe node metadata (metamaster) API from YugabyteDB — 6 operation(s) for universe node metadata (metamaster).

GitHub OpenAPI

Operations 6

GET /api/v1/customers/{cUUID}/universes/{uniUUID}/master_lb_state Get the state of master load balancing ops #
GET /api/v1/customers/{cUUID}/universes/{uniUUID}/masters List a master node's addresses #
GET /api/v1/customers/{cUUID}/universes/{uniUUID}/redisservers List a REDIS server's addresses #
GET /api/v1/customers/{cUUID}/universes/{uniUUID}/yqlservers List a YQL server's addresses #
GET /api/v1/customers/{cUUID}/universes/{uniUUID}/ysqlservers List a YSQL server's addresses #
GET /metamaster/universe/{universeUUID} List a universe's master nodes #

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-universe-node-metadata-metamaster-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-universe-node-metadata-metamaster-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-universe-node-metadata-metamaster-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Yugabytedb Universe node metadata (metamaster) 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 Universe node metadata (metamaster) across 4 of this provider''s published API definitions: openapi_2.yaml, platform.swagger.json, yugabytedb-anywhere-v1-full.yaml, yugabytedb-anywhere-v1-universes.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: /
tags:
- name: Universe node metadata (metamaster)
paths:
  /api/v1/customers/{cUUID}/universes/{uniUUID}/master_lb_state:
    get:
      description: YbaApi Internal. Available since YBA version 2024.2.0
      operationId: getMasterLBState
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: uniUUID
        required: true
        schema:
          format: uuid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MasterLBStateResponse'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Get the state of master load balancing ops
      tags:
      - Universe node metadata (metamaster)
    servers:
    - url: /
  /api/v1/customers/{cUUID}/universes/{uniUUID}/masters:
    get:
      description: Available since YBA version 2.2.0.0.
      operationId: getMasterAddresses
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: uniUUID
        required: true
        schema:
          format: uuid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                type: string
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: List a master node's addresses
      tags:
      - Universe node metadata (metamaster)
    servers:
    - url: /
  /api/v1/customers/{cUUID}/universes/{uniUUID}/redisservers:
    get:
      description: Available since YBA version 2.2.0.0.
      operationId: getRedisServerAddresses
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: uniUUID
        required: true
        schema:
          format: uuid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                type: string
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: List a REDIS server's addresses
      tags:
      - Universe node metadata (metamaster)
    servers:
    - url: /
  /api/v1/customers/{cUUID}/universes/{uniUUID}/yqlservers:
    get:
      description: Available since YBA version 2.2.0.0.
      operationId: getYQLServerAddresses
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: uniUUID
        required: true
        schema:
          format: uuid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                type: string
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: List a YQL server's addresses
      tags:
      - Universe node metadata (metamaster)
    servers:
    - url: /
  /api/v1/customers/{cUUID}/universes/{uniUUID}/ysqlservers:
    get:
      description: Available since YBA version 2.2.0.0.
      operationId: getYSQLServerAddresses
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: uniUUID
        required: true
        schema:
          format: uuid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                type: string
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: List a YSQL server's addresses
      tags:
      - Universe node metadata (metamaster)
    servers:
    - url: /
  /metamaster/universe/{universeUUID}:
    get:
      operationId: getUniverseMasterNodes
      parameters:
      - in: path
        name: universeUUID
        required: true
        schema:
          format: uuid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MastersList'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: List a universe's master nodes
      tags:
      - Universe node metadata (metamaster)
    servers:
    - url: /
components:
  schemas:
    MastersList:
      example:
        masters:
        - cloudInfo:
            mount_roots: mount_roots
            kubernetesNamespace: kubernetesNamespace
            public_ip: public_ip
            secondary_subnet_id: secondary_subnet_id
            private_dns: private_dns
            useTimeSync: true
            kubernetesPodName: kubernetesPodName
            root_volume: root_volume
            secondary_private_ip: secondary_private_ip
            private_ip: private_ip
            cloud: cloud
            lun_indexes:
            - 6
            - 6
            assignPublicIP: true
            az: az
            subnet_id: subnet_id
            public_dns: public_dns
            region: region
            instance_type: instance_type
          masterRpcPort: 0
        - cloudInfo:
            mount_roots: mount_roots
            kubernetesNamespace: kubernetesNamespace
            public_ip: public_ip
            secondary_subnet_id: secondary_subnet_id
            private_dns: private_dns
            useTimeSync: true
            kubernetesPodName: kubernetesPodName
            root_volume: root_volume
            secondary_private_ip: secondary_private_ip
            private_ip: private_ip
            cloud: cloud
            lun_indexes:
            - 6
            - 6
            assignPublicIP: true
            az: az
            subnet_id: subnet_id
            public_dns: public_dns
            region: region
            instance_type: instance_type
          masterRpcPort: 0
      properties:
        masters:
          items:
            $ref: '#/components/schemas/MasterNode'
          type: array
      required:
      - masters
      type: object
    MasterNode:
      example:
        cloudInfo:
          mount_roots: mount_roots
          kubernetesNamespace: kubernetesNamespace
          public_ip: public_ip
          secondary_subnet_id: secondary_subnet_id
          private_dns: private_dns
          useTimeSync: true
          kubernetesPodName: kubernetesPodName
          root_volume: root_volume
          secondary_private_ip: secondary_private_ip
          private_ip: private_ip
          cloud: cloud
          lun_indexes:
          - 6
          - 6
          assignPublicIP: true
          az: az
          subnet_id: subnet_id
          public_dns: public_dns
          region: region
          instance_type: instance_type
        masterRpcPort: 0
      properties:
        cloudInfo:
          $ref: '#/components/schemas/CloudSpecificInfo'
        masterRpcPort:
          format: int32
          type: integer
      required:
      - cloudInfo
      - masterRpcPort
      type: object
    MasterLBStateResponse:
      description: Master tablet load balancer status
      example:
        isEnabled: true
        isIdle: true
        estTimeToBalanceSecs: 0
      properties:
        estTimeToBalanceSecs:
          description: YbaApi Internal Estimate of time for which master tablet load balancer will be active
          format: int64
          type: integer
        isEnabled:
          description: YbaApi Internal Whether master tablet load balancer is enabled
          type: boolean
        isIdle:
          description: YbaApi Internal Whether master tablet load balancer is inactive
          type: boolean
      required:
      - isEnabled
      type: object
    CloudSpecificInfo:
      description: Node information reported by the cloud provider
      example:
        mount_roots: mount_roots
        kubernetesNamespace: kubernetesNamespace
        public_ip: public_ip
        secondary_subnet_id: secondary_subnet_id
        private_dns: private_dns
        useTimeSync: true
        kubernetesPodName: kubernetesPodName
        root_volume: root_volume
        secondary_private_ip: secondary_private_ip
        private_ip: private_ip
        cloud: cloud
        lun_indexes:
        - 6
        - 6
        assignPublicIP: true
        az: az
        subnet_id: subnet_id
        public_dns: public_dns
        region: region
        instance_type: instance_type
      properties:
        assignPublicIP:
          description: True if the node has a public IP address assigned
          type: boolean
        az:
          description: The node's availability zone
          type: string
        cloud:
          description: The node's cloud provider
          type: string
        instance_type:
          description: The node's instance type
          type: string
        kubernetesNamespace:
          description: Kubernetes namespace
          type: string
        kubernetesPodName:
          description: Pod name in Kubernetes
          type: string
        lun_indexes:
          description: Mounted disks LUN indexes
          items:
            format: int32
            type: integer
          type: array
        mount_roots:
          description: Mount roots
          type: string
        private_dns:
          description: The node's private DNS
          type: string
        private_ip:
          description: The node's private IP address
          type: string
        public_dns:
          description: The node's public DNS name
          type: string
        public_ip:
          description: The node's public IP address
          type: string
        region:
          description: The node's region
          type: string
        root_volume:
          description: Root volume ID or name
          type: string
        secondary_private_ip:
          description: Secondary Private IP
          type: string
        secondary_subnet_id:
          description: Secondary Subnet IP
          type: string
        subnet_id:
          description: ID of the subnet on which this node is deployed
          type: string
        useTimeSync:
          description: True if `use time sync` is enabled
          type: boolean
      type: object
    DummyBody:
      description: Dummy value to work around platform bug PLAT-2076
      properties:
        dummy:
          format: int32
          type: integer
      type: object
    MastersList_2:
      properties:
        masters:
          items:
            $ref: '#/components/schemas/MasterNode_2'
          type: array
      required:
      - masters
      type: object
    MasterNode_2:
      properties:
        cloudInfo:
          $ref: '#/components/schemas/CloudSpecificInfo_2'
        masterRpcPort:
          format: int32
          type: integer
      required:
      - cloudInfo
      - masterRpcPort
      type: object
    CloudSpecificInfo_2:
      description: Node information reported by the cloud provider
      properties:
        assignPublicIP:
          description: True if the node has a public IP address assigned
          type: boolean
        az:
          description: The node's availability zone
          type: string
        cloud:
          description: The node's cloud provider
          type: string
        instance_type:
          description: The node's instance type
          type: string
        mount_roots:
          description: Mount roots
          type: string
        private_dns:
          description: The node's private DNS
          type: string
        private_ip:
          description: The node's private IP address
          type: string
        public_dns:
          description: The node's public DNS name
          type: string
        public_ip:
          description: The node's public IP address
          type: string
        region:
          description: The node's region
          type: string
        secondary_private_ip:
          description: Secondary Private IP
          type: string
        secondary_subnet_id:
          description: Secondary Subnet IP
          type: string
        subnet_id:
          description: ID of the subnet on which this node is deployed
          type: string
        useTimeSync:
          description: True if `use time sync` is enabled
          type: boolean
      type: object
    MastersList_3:
      example:
        masters:
        - cloudInfo:
            mount_roots: mount_roots
            kubernetesNamespace: kubernetesNamespace
            public_ip: public_ip
            secondary_subnet_id: secondary_subnet_id
            private_dns: private_dns
            useTimeSync: true
            kubernetesPodName: kubernetesPodName
            root_volume: root_volume
            secondary_private_ip: secondary_private_ip
            private_ip: private_ip
            cloud: cloud
            lun_indexes:
            - 6
            - 6
            assignPublicIP: true
            az: az
            subnet_id: subnet_id
            public_dns: public_dns
            region: region
            instance_type: instance_type
          masterRpcPort: 0
        - cloudInfo:
            mount_roots: mount_roots
            kubernetesNamespace: kubernetesNamespace
            public_ip: public_ip
            secondary_subnet_id: secondary_subnet_id
            private_dns: private_dns
            useTimeSync: true
            kubernetesPodName: kubernetesPodName
            root_volume: root_volume
            secondary_private_ip: secondary_private_ip
            private_ip: private_ip
            cloud: cloud
            lun_indexes:
            - 6
            - 6
            assignPublicIP: true
            az: az
            subnet_id: subnet_id
            public_dns: public_dns
            region: region
            instance_type: instance_type
          masterRpcPort: 0
      properties:
        masters:
          items:
            $ref: '#/components/schemas/MasterNode_3'
          type: array
          example:
          - cloudInfo:
              mount_roots: mount_roots
              kubernetesNamespace: kubernetesNamespace
              public_ip: public_ip
              secondary_subnet_id: secondary_subnet_id
              private_dns: private_dns
              useTimeSync: true
              kubernetesPodName: kubernetesPodName
              root_volume: root_volume
              secondary_private_ip: secondary_private_ip
              private_ip: private_ip
              cloud: cloud
              lun_indexes:
              - 6
              - 6
              assignPublicIP: true
              az: az
              subnet_id: subnet_id
              public_dns: public_dns
              region: region
              instance_type: instance_type
            masterRpcPort: 0
      required:
      - masters
      type: object
    MasterNode_3:
      example:
        cloudInfo:
          mount_roots: mount_roots
          kubernetesNamespace: kubernetesNamespace
          public_ip: public_ip
          secondary_subnet_id: secondary_subnet_id
          private_dns: private_dns
          useTimeSync: true
          kubernetesPodName: kubernetesPodName
          root_volume: root_volume
          secondary_private_ip: secondary_private_ip
          private_ip: private_ip
          cloud: cloud
          lun_indexes:
          - 6
          - 6
          assignPublicIP: true
          az: az
          subnet_id: subnet_id
          public_dns: public_dns
          region: region
          instance_type: instance_type
        masterRpcPort: 0
      properties:
        cloudInfo:
          $ref: '#/components/schemas/CloudSpecificInfo_3'
        masterRpcPort:
          format: int32
          type: integer
          example: 5433
      required:
      - cloudInfo
      - masterRpcPort
      type: object
    MasterLBStateResponse_2:
      description: Master tablet load balancer status
      example:
        isEnabled: true
        isIdle: true
        estTimeToBalanceSecs: 0
      properties:
        estTimeToBalanceSecs:
          description: YbaApi Internal Estimate of time for which master tablet load balancer will be active
          format: int64
          type: integer
          example: 1000
        isEnabled:
          description: YbaApi Internal Whether master tablet load balancer is enabled
          type: boolean
          example: true
        isIdle:
          description: YbaApi Internal Whether master tablet load balancer is inactive
          type: boolean
          example: true
      required:
      - isEnabled
      type: object
    CloudSpecificInfo_3:
      description: Node information reported by the cloud provider
      example:
        mount_roots: mount_roots
        kubernetesNamespace: kubernetesNamespace
        public_ip: public_ip
        secondary_subnet_id: secondary_subnet_id
        private_dns: private_dns
        useTimeSync: true
        kubernetesPodName: kubernetesPodName
        root_volume: root_volume
        secondary_private_ip: secondary_private_ip
        private_ip: private_ip
        cloud: cloud
        lun_indexes:
        - 6
        - 6
        assignPublicIP: true
        az: az
        subnet_id: subnet_id
        public_dns: public_dns
        region: region
        instance_type: instance_type
      properties:
        assignPublicIP:
          description: True if the node has a public IP address assigned
          type: boolean
          example: true
        az:
          description: The node's availability zone
          type: string
          example: example-az
        cloud:
          description: The node's cloud provider
          type: string
          example: example-cloud
        instance_type:
          description: The node's instance type
          type: string
          example: DEFAULT
        kubernetesNamespace:
          description: Kubernetes namespace
          type: string
          example: example-kubernetesNamespace
        kubernetesPodName:
          description: Pod name in Kubernetes
          type: string
          example: example-kubernetesPodName
        lun_indexes:
          description: Mounted disks LUN indexes
          items:
            format: int32
            type: integer
          type: array
          example:
          - 100
        mount_roots:
          description: Mount roots
          type: string
          example: example-mount_roots
        private_dns:
          description: The node's private DNS
          type: string
          example: example-private_dns
        private_ip:
          description: The node's private IP address
          type: string
          example: 10.0.0.1
        public_dns:
          description: The node's public DNS name
          type: string
          example: example-public_dns
        public_ip:
          description: The node's public IP address
          type: string
          example: 10.0.0.1
        region:
          description: The node's region
          type: string
          example: us-east-1
        root_volume:
          description: Root volume ID or name
          type: string
          example: example-root_volume
        secondary_private_ip:
          description: Secondary Private IP
          type: string
          example: 10.0.0.1
        secondary_subnet_id:
          description: Secondary Subnet IP
          type: string
          example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        subnet_id:
          description: ID of the subnet on which this node is deployed
          type: string
          example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        useTimeSync:
          description: True if `use time sync` is enabled
          type: boolean
          example: true
      type: object
    MastersList_4:
      example:
        masters:
        - cloudInfo:
            mount_roots: mount_roots
            kubernetesNamespace: kubernetesNamespace
            public_ip: public_ip
            secondary_subnet_id: secondary_subnet_id
            private_dns: private_dns
            useTimeSync: true
            kubernetesPodName: kubernetesPodName
            root_volume: root_volume
            secondary_private_ip: secondary_private_ip
            private_ip: private_ip
            cloud: cloud
            lun_indexes:
            - 6
            - 6
            assignPublicIP: true
            az: az
            subnet_id: subnet_id
            public_dns: public_dns
            region: region
            instance_type: instance_type
          masterRpcPort: 0
        - cloudInfo:
            mount_roots: mount_roots
            kubernetesNamespace: kubernetesNamespace
            public_ip: public_ip
            secondary_subnet_id: secondary_subnet_id
            private_dns: private_dns
            useTimeSync: true
            kubernetesPodName: kubernetesPodName
            root_volume: root_volume
            secondary_private_ip: secondary_private_ip
            private_ip: private_ip
            cloud: cloud
            lun_indexes:
            - 6
            - 6
            assignPublicIP: true
            az: az
            subnet_id: subnet_id
            public_dns: public_dns
            region: region
            instance_type: instance_type
          masterRpcPort: 0
      properties:
        masters:
          items:
            $ref: '#/components/schemas/MasterNode_4'
          type: array
          example:
          - cloudInfo:
              mount_roots: mount_roots
              kubernetesNamespace: kubernetesNamespace
              public_ip: public_ip
              secondary_subnet_id: secondary_subnet_id
              private_dns: private_dns
              useTimeSync: true
              kubernetesPodName: kubernetesPodName
              root_volume: root_volume
              secondary_private_ip: secondary_private_ip
              private_ip: private_ip
              cloud: cloud
              lun_indexes:
              - 6
              - 6
              assignPublicIP: true
              az: az
              subnet_id: subnet_id
              public_dns: public_dns
              region: region
              instance_type: instance_type
            masterRpcPort: 0
      required:
      - masters
      type: object
    MasterNode_4:
      example:
        cloudInfo:
          mount_roots: mount_roots
          kubernetesNamespace: kubernetesNamespace
          public_ip: public_ip
          secondary_subnet_id: secondary_subnet_id
          private_dns: private_dns
          useTimeSync: true
          kubernetesPodName: kubernetesPodName
          root_volume: root_volume
          secondary_private_ip: secondary_private_ip
          private_ip: private_ip
          cloud: cloud
          lun_indexes:
          - 6
          - 6
          assignPublicIP: true
          az: az
          subnet_id: subnet_id
          public_dns: public_dns
          region: region
          instance_type: instance_type
        masterRpcPort: 0
      properties:
        cloudInfo:
          $ref: '#/components/schemas/CloudSpecificInfo_4'
        masterRpcPort:
          format: int32
          type: integer
          example: 5433
      required:
      - cloudInfo
      - masterRpcPort
      type: object
    MasterLBStateResponse_3:
      description: Master tablet load balancer status
      example:
        isEnabled: true
        isIdle: true
        estTimeToBalanceSecs: 0
      properties:
        estTimeToBalanceSecs:
          description: YbaApi Internal Estimate of time for which master tablet load balancer will be active
          format: int64
          type: integer
          example: 1000
        isEnabled:
          description: YbaApi Internal Whether master tablet load balancer is enabled
          type: boolean
          example: true
        isIdle:
          description: YbaApi Internal Whether master tablet load balancer is inactive
          type: boolean
          example: true
      required:
      - isEnabled
      type: object
    CloudSpecificInfo_4:
      description: Node information reported by the cloud provider
      example:
        mount_roots: mount_roots
        kubernetesNamespace: kubernetesNamespace
        public_ip: public_ip
        secondary_subnet_id: secondary_subnet_id
        private_dns: private_dns
        useTimeSync: true
        kubernetesPodName: kubernetesPodName
        root_volume: root_volume
        secondary_private_ip: secondary_private_ip
        private_ip: private_ip
        cloud: cloud
        lun_indexes:
        - 6
        - 6
        assignPublicIP: true
        az: az
        subnet_id: subnet_id
        public_dns: public_dns
        region: region
        instance_type: instance_type
      properties:
        assignPublicIP:
          description: True if the node has a public IP address assigned
          type: boolean
          example: true
        az:
          description: The node's availability zone
          type: string
          example: example-az
        cloud:
          description: The node's cloud provider
          type: string
          example: example-cloud
        instance_type:
          description: The node's instance type
          type: string
          example: DEFAULT
        kubernetesNamespace:
          description: Kubernetes namespace
          type: string
          example: example-kubernetesNamespace
        kubernetesPodName:
          description: Pod name in Kubernetes
          type: string
          example: example-kubernetesPodName
        lun_indexes:
          description: Mounted disks LUN indexes
          items:
            format: int32
            type: integer
          type: array
          example:
          - 100
        mount_roots:
          description: Mount roots
          type: string
          example: example-mount_roots
        private_dns:
          description: The node's private DNS
          type: string
          example: example-private_dns
        private_ip:
          description: The node's private IP address
          type: string
          example: 10.0.0.1
        public_dns:
          description: The node's public DNS name
          type: string
          example: example-public_dns
        public_ip:
          description: The node's public IP address
          type: string
          example: 10.0.0.1
        region:
          description: The node's region
          type: string
          example: us-east-1
        root_volume:
          description: Root volume ID or name
          type: string
          example: example-root_volume
        secondary_private_ip:
          description: Secondary Private IP
          type: string
          example: 10.0.0.1
        secondary_subnet_id:
          description: Secondary Subnet IP
          type: string
          example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        subnet_id:
          description: ID of the subnet on which this node is deployed
          type: string
          example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        useTimeSync:
          description: True if `use time sync` is enabled
          type: boolean
          example: true
      type: object
  securitySchemes:
    apiKeyAuth:
      description: API token passed as header
      in: header
      name: X-AUTH-YW-API-TOKEN
      type: apiKey
externalDocs:
  description: About YugabyteDB Anywhere
  url: https://docs.yugabyte.com/latest/yugabyte-platform/
x-refined-from:
- openapi_2.yaml
- platform.swagger.json
- yugabytedb-anywhere-v1-full.yaml
- yugabytedb-anywhere-v1-universes.yaml