YugabyteDB
YugabyteDB Node instances API

The Node instances API from YugabyteDB — 10 operation(s) for node instances.
Documentation GitHub OpenAPI
OpenAPI Specification

openapi: 3.1.0
info:
  title: YugabyteDB Aeon REST Access Keys Node instances API
  description: The YugabyteDB Aeon REST API provides programmatic access to YugabyteDB's fully managed cloud database service. Developers and operators can use it to deploy and manage database clusters, configure read replicas, schedule and execute on-demand backups and restores, manage IP allow lists, and set up monitoring and alerts. Authentication is performed using API keys passed as bearer tokens in the Authorization header. All paths are scoped to an account and project, which can be obtained from the YugabyteDB Aeon UI profile page.
  version: v1
  contact:
    name: Yugabyte Support
    url: https://support.yugabyte.com
  termsOfService: https://www.yugabyte.com/yugabytedb-managed-service-terms/
  x-generated-from: documentation
  x-source-url: https://api-docs.yugabyte.com/docs/managed-apis/
  x-last-validated: '2026-05-03'
servers:
- url: https://cloud.yugabyte.com/api/public/v1
  description: YugabyteDB Aeon Production Server
security:
- bearerAuth: []
tags:
- name: Node instances
paths:
  /api/v1/customers/{cUUID}/nodes:
    get:
      operationId: List
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: query
        name: nodeIp
        schema:
          default: 'null'
          type: string
        example: 'null'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NodeInstance'
              examples:
                List200Example:
                  summary: Default List 200 response
                  x-microcks-default: true
                  value:
                    manuallyDecommissioned: true
                    nodeName: universe_node1
                    instanceName: Mumbai instance
                    instanceTypeCode: c5large
                    inUse: true
                    zoneUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    details:
                      nodeName: universe_node1
                      instanceName: Mumbai instance
                      zone: south-east
                      instanceType: c5large
                      ip: 1.1.1.1
                      sshUser: centos
                      region: south-east
                    state: DECOMMISSIONED
                    nodeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    detailsJson: '{"ip":"1.1.1.1","sshUser":"centos"}'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: YugabyteDB Anywhere List All Node Instances of a Customer
      tags:
      - Node instances
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /api/v1/customers/{cUUID}/nodes/{nodeUUID}/list:
    get:
      operationId: getNodeInstance
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: path
        name: nodeUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NodeInstance'
              examples:
                GetNodeInstance200Example:
                  summary: Default getNodeInstance 200 response
                  x-microcks-default: true
                  value:
                    manuallyDecommissioned: true
                    nodeName: universe_node1
                    instanceName: Mumbai instance
                    instanceTypeCode: c5large
                    inUse: true
                    zoneUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    details:
                      nodeName: universe_node1
                      instanceName: Mumbai instance
                      zone: south-east
                      instanceType: c5large
                      ip: 1.1.1.1
                      sshUser: centos
                      region: south-east
                    state: DECOMMISSIONED
                    nodeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    detailsJson: '{"ip":"1.1.1.1","sshUser":"centos"}'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: YugabyteDB Anywhere Get a Node Instance
      tags:
      - Node instances
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /api/v1/customers/{cUUID}/providers/{pUUID}/instances/{instanceIP}:
    delete:
      operationId: deleteInstance
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: path
        name: pUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: path
        name: instanceIP
        required: true
        schema:
          type: string
        example: example-instanceIP
      - in: query
        name: request
        schema: {}
        example: example-request
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPSuccess'
              examples:
                DeleteInstance200Example:
                  summary: Default deleteInstance 200 response
                  x-microcks-default: true
                  value:
                    success: true
                    message: message
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: YugabyteDB Anywhere Delete a Node Instance
      tags:
      - Node instances
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: detachedNodeAction
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: path
        name: pUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: path
        name: instanceIP
        required: true
        schema:
          type: string
        example: example-instanceIP
      - in: query
        name: request
        schema: {}
        example: example-request
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NodeActionFormData'
            examples:
              DetachedNodeActionRequestExample:
                summary: Default detachedNodeAction request
                x-microcks-default: true
                value:
                  nodeAction: ADD
                  runOnlyPrechecks: true
                  force: true
        description: Node action data to be updated
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTask'
              examples:
                DetachedNodeAction200Example:
                  summary: Default detachedNodeAction 200 response
                  x-microcks-default: true
                  value:
                    taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    resourceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: YugabyteDB Anywhere Detached Node Action
      tags:
      - Node instances
      x-codegen-request-body-name: Node action
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /api/v1/customers/{cUUID}/providers/{pUUID}/instances/{instanceIP}/state:
    put:
      description: 'WARNING: This is a preview API that could change.'
      operationId: updateState
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: path
        name: pUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: path
        name: instanceIP
        required: true
        schema:
          type: string
        example: example-instanceIP
      - in: query
        name: request
        schema: {}
        example: example-request
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NodeInstanceStateFormData'
            examples:
              UpdateStateRequestExample:
                summary: Default updateState request
                x-microcks-default: true
                value:
                  state: DECOMMISSIONED
        description: Resultant node instance state to transition to
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTask'
              examples:
                UpdateState200Example:
                  summary: Default updateState 200 response
                  x-microcks-default: true
                  value:
                    taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    resourceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: YugabyteDB Anywhere Update Node Instance State
      tags:
      - Node instances
      x-codegen-request-body-name: NodeInstanceStateFormData
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /api/v1/customers/{cUUID}/providers/{pUUID}/nodes/list:
    get:
      operationId: listByProvider
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: path
        name: pUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/NodeInstance'
                type: array
              examples:
                ListByProvider200Example:
                  summary: Default listByProvider 200 response
                  x-microcks-default: true
                  value:
                  - manuallyDecommissioned: true
                    nodeName: universe_node1
                    instanceName: Mumbai instance
                    instanceTypeCode: c5large
                    inUse: true
                    zoneUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    details:
                      nodeName: universe_node1
                      instanceName: Mumbai instance
                      zone: south-east
                      instanceType: c5large
                      ip: 1.1.1.1
                      sshUser: centos
                      region: south-east
                    state: DECOMMISSIONED
                    nodeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    detailsJson: '{"ip":"1.1.1.1","sshUser":"centos"}'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: YugabyteDB Anywhere List All of a Provider's Node Instances
      tags:
      - Node instances
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /api/v1/customers/{cUUID}/universes/{universeUUID}/nodes/{nodeName}:
    put:
      operationId: nodeAction
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: path
        name: universeUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: path
        name: nodeName
        required: true
        schema:
          type: string
        example: example-nodeName
      - in: query
        name: request
        schema: {}
        example: example-request
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NodeActionFormData'
            examples:
              NodeActionRequestExample:
                summary: Default nodeAction request
                x-microcks-default: true
                value:
                  nodeAction: ADD
                  runOnlyPrechecks: true
                  force: true
        description: Details of the node action to be performed
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTask'
              examples:
                NodeAction200Example:
                  summary: Default nodeAction 200 response
                  x-microcks-default: true
                  value:
                    taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    resourceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: YugabyteDB Anywhere Perform the Specified Action on the Universe Node
      tags:
      - Node instances
      x-codegen-request-body-name: Node action
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /api/v1/customers/{cUUID}/universes/{universeUUID}/nodes/{nodeName}/details:
    get:
      operationId: getNodeDetails
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: path
        name: universeUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: path
        name: nodeName
        required: true
        schema:
          type: string
        example: example-nodeName
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NodeDetailsResp'
              examples:
                GetNodeDetails200Example:
                  summary: Default getNodeDetails 200 response
                  x-microcks-default: true
                  value:
                    nodeName: nodeName
                    nodeExporterPort: 6
                    allowedActions:
                    - ADD
                    - ADD
                    placementUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    ybControllerHttpPort: 6
                    dedicatedTo: MASTER
                    machineImage: machineImage
                    redisServerHttpPort: 3
                    masterState: ToStart
                    tserverRpcPort: 7
                    ysqlServerHttpPort: 7
                    yqlServerRpcPort: 8
                    otelCollectorMetricsPort: 6
                    isMaster: true
                    sshUserOverride: sshUserOverride
                    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
                    sshPortOverride: 7
                    cronsActive: true
                    state: Provisioned
                    nodeIdx: 5
                    masterRpcPort: 6
                    redisServerRpcPort: 3
                    lastVolumeUpdateTime: 2022-12-12 13:07:18+00:00
                    kubernetesOverrides: kubernetesOverrides
                    tserverHttpPort: 0
                    disksAreMountedByUUID: true
                    isRedisServer: true
                    ybPrebuiltAmi: true
                    internalYsqlServerRpcPort: 1
                    isTserver: true
                    nodeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    isYsqlServer: true
                    ybControllerRpcPort: 0
                    isYqlServer: true
                    azUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    masterHttpPort: 2
                    ysqlServerRpcPort: 3
                    autoSyncMasterAddrs: true
                    yqlServerHttpPort: 4
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: YugabyteDB Anywhere Get Node Details
      tags:
      - Node instances
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /api/v1/customers/{cUUID}/zones/{azUUID}/nodes:
    post:
      operationId: createNodeInstance
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: path
        name: azUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: query
        name: request
        schema: {}
        example: example-request
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NodeInstanceFormData'
            examples:
              CreateNodeInstanceRequestExample:
                summary: Default createNodeInstance request
                x-microcks-default: true
                value:
                  nodes:
                  - nodeName: universe_node1
                    instanceName: Mumbai instance
                    zone: south-east
                    instanceType: c5large
                    ip: 1.1.1.1
                    sshUser: centos
                    region: south-east
                  - nodeName: universe_node1
                    instanceName: Mumbai instance
                    zone: south-east
                    instanceType: c5large
                    ip: 1.1.1.1
                    sshUser: centos
                    region: south-east
                  - nodeName: universe_node1
                    instanceName: Mumbai instance
                    zone: south-east
                    instanceType: c5large
                    ip: 1.1.1.1
                    sshUser: centos
                    region: south-east
                  - nodeName: universe_node1
                    instanceName: Mumbai instance
                    zone: south-east
                    instanceType: c5large
                    ip: 1.1.1.1
                    sshUser: centos
                    region: south-east
                  - nodeName: universe_node1
                    instanceName: Mumbai instance
                    zone: south-east
                    instanceType: c5large
                    ip: 1.1.1.1
                    sshUser: centos
                    region: south-east
        description: Node instance data to be created
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties:
                  $ref: '#/components/schemas/NodeInstance'
                type: object
              examples:
                CreateNodeInstance200Example:
                  summary: Default createNodeInstance 200 response
                  x-microcks-default: true
                  value: {}
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: YugabyteDB Anywhere Create a Node Instance
      tags:
      - Node instances
      x-codegen-request-body-name: Node instance
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /api/v1/customers/{cUUID}/zones/{azUUID}/nodes/list:
    get:
      operationId: listByZone
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: path
        name: azUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/NodeInstance'
                type: array
              examples:
                ListByZone200Example:
                  summary: Default listByZone 200 response
                  x-microcks-default: true
                  value:
                  - manuallyDecommissioned: true
                    nodeName: universe_node1
                    instanceName: Mumbai instance
                    instanceTypeCode: c5large
                    inUse: true
                    zoneUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    details:
                      nodeName: universe_node1
                      instanceName: Mumbai instance
                      zone: south-east
                      instanceType: c5large
                      ip: 1.1.1.1
                      sshUser: centos
                      region: south-east
                    state: DECOMMISSIONED
                    nodeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    detailsJson: '{"ip":"1.1.1.1","sshUser":"centos"}'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: YugabyteDB Anywhere List All of a Zone's Node Instances
      tags:
      - Node instances
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /api/v1/customers/{cUUID}/zones/{azUUID}/nodes/validate:
    post:
      operationId: validateNodeInstance
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: path
        name: azUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: query
        name: request
        schema: {}
        example: example-request
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties:
                  $ref: '#/components/schemas/ValidationResult'
                type: object
              examples:
                ValidateNodeInstance200Example:
                  summary: Default validateNodeInstance 200 response
                  x-microcks-default: true
                  value: {}
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: YugabyteDB Anywhere Validate a Node Instance
      tags:
      - Node instances
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    NodeInstanceFormData:
      example:
        nodes:
        - nodeName: universe_node1
          instanceName: Mumbai instance
          zone: south-east
          instanceType: c5large
          ip: 1.1.1.1
          sshUser: centos
          region: south-east
        - nodeName: universe_node1
          instanceName: Mumbai instance
          zone: south-east
          instanceType: c5large
          ip: 1.1.1.1
          sshUser: centos
          region: south-east
        - nodeName: universe_node1
          instanceName: Mumbai instance
          zone: south-east
          instanceType: c5large
          ip: 1.1.1.1
          sshUser: centos
          region: south-east
        - nodeName: universe_node1
          instanceName: Mumbai instance
          zone: south-east
          instanceType: c5large
          ip: 1.1.1.1
          sshUser: centos
          region: south-east
        - nodeName: universe_node1
          instanceName: Mumbai instance
          zone: south-east
          instanceType: c5large
          ip: 1.1.1.1
          sshUser: centos
          region: south-east
      properties:
        nodes:
          description: Node instances
          items:
            $ref: '#/components/schemas/NodeInstanceData'
          maxItems: 2147483647
          minItems: 1
          type: array
          example:
          - nodeName: universe_node1
            instanceName: Mumbai instance
            zone: south-east
            instanceType: c5large
            ip: 1.1.1.1
            sshUser: centos
            region: south-east
      required:
      - nodes
      type: object
    ValidationResult:
      description: Validation result of a node config
      properties:
        description:
          type: string
          example: Example description
        required:
          type: boolean
          example: true
        type:
          enum:
          - NTP_SERVICE_STATUS
          - PROMETHEUS_SPACE
          - MOUNT_POINTS_WRITABLE
          - USER
          - USER_GROUP
          - HOME_DIR_SPACE
          - HOME_DIR_EXISTS
          - HOME_DIR_MATCHES
          - RAM_SIZE
          - INTERNET_CONNECTION
          - CPU_CORES
          - PROMETHEUS_NO_NODE_EXPORTER
          - TMP_DIR_SPACE
          - PAM_LIMITS_WRITABLE
          - PYTHON_VERSION
          - MOUNT_POINTS_VOLUME
          - CHRONYD_RUNNING
          - LOCALE_PRESENT
          - SSH_PORT
          - SUDO_ACCESS
          - OPENSSL
          - POLICYCOREUTILS
          - RSYNC
          - XXHASH
          - LIBATOMIC1
          - LIBNCURSES6
          - LIBATOMIC
          - AZCOPY
          - CHRONYC
          - GSUTIL
          - S3CMD
          - NODE_EXPORTER_RUNNING
          - NODE_EXPORTER_PORT
          - SWAPPINESS
          - ULIMIT_CORE
          - ULIMIT_OPEN_FILES
          - ULIMIT_USER_PROCESSES
          - SSH_ACCESS
          - NODE_AGENT_ACCESS
          - MASTER_HTTP_PORT
          - MASTER_RPC_PORT
          - TSERVER_HTTP_PORT
          - TSERVER_RPC_PORT
          - YB_CONTROLLER_HTTP_PORT
          - YB_CONTROLLER_RPC_PORT
          - REDIS_SERVER_HTTP_PORT
          - REDIS_SERVER_RPC_PORT
          - YB_HOME_DIR_CLEAN
          - DATA_DIR_CLEAN
          - YCQL_SERVER_HTTP_PORT
          - YCQL_SERVER_RPC_PORT
          - YSQL_SERVER_HTTP_PORT
          - YSQL_SERVER_RPC_PORT
          - VM_MAX_MAP_COUNT
          - NTP_SKEW
          type: string
          example: NTP_SERVICE_STATUS
        valid:
          type: boolean
          example: true
        value:
          type: string
          example: example-value
      required:
      - description
      - required
      - type
      - valid
      - value
      type: object
    NodeInstanceData:
      description: Details of a node instance. Used by the API to validate data against input constraints.
      example:
        nodeName: universe_node1
        instanceName: Mumbai instance
        zone: south-east
        instanceType: c5large
        ip: 1.1.1.1
        sshUser: centos
        region: south-east
      properties:
        instanceName:
          description: Node instance name
          example: Mumbai instance
          type: string
        instanceType:
          description: Node instance type
          example: c5large
          type: string
        ip:
          description: IP address
          example: 1.1.1.1
          type: string
        nodeName:
          description: Node name in a universe
          example: universe_node1
          readOnly: true
          type: string
        region:
          description: Region
          example: south-east
          type: string
        sshUser:
          description: SSH user
          example: centos
          type: string
        zone:
          description: Zone
          example: south-east
          type: string
      required:
      - instanceName
      - instanceType
      - ip
      - region
      - zone
      type: object
    NodeActionFormData:
      example:
        nodeAction: ADD
        runOnlyPrechecks: true
        force: true
      properties:
        force:
          description: Should ignore master unavailability and proceed with the node action
          type: boolean
          example: true
        nodeAction:
          description: Action to perform on the node.
          enum:
          - ADD
          - REMOVE
          - START
          - STOP
          - DELETE
          - QUERY
          - RELEASE
          - REBOOT
          - START_MASTER
          - PRECHECK_DETACHED
          - HARD_REBOOT
          - REPROVISION
          - REPLACE
          - DECOMMISSION
          type: string
          example: ADD
        runOnlyPrechecks:
          description: YbaApi Internal. Run only prechecks during task run
          type: boolean
          example: true
      required:
      - nodeAction
      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
          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:
          descriptio

# --- truncated at 32 KB (66 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/openapi/yugabytedb-node-instances-api-openapi.yml
YugabyteDB Node instances API

Documentation

Specifications

Other Resources

OpenAPI Specification
