How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
YugabyteDB

YugabyteDB Node instances API

The Node instances API from YugabyteDB — 10 operation(s) for node instances.

Documentation Provider Profile APIs.io OpenAPI GitHub

YugabyteDB Node instances API is one of 73 APIs that YugabyteDB publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Node instances. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, and authentication docs.

This API exposes 11 operations across 10 paths, and defines 34 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, /.

11 operations 10 paths 34 schemas 1 DELETE5 GET3 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://cloud.yugabyte.com/api/public/v1
Authentication
API Key
Contact
https://docs.yugabyte.com
License
Polyform Free Trial License 1.0.0
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

YugabyteDB Node instances API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-AUTH-YW-API-TOKEN (apiKeyAuth).

  • apiKeyAuth — API token passed as header

Paths & Operations 11

Across 10 paths, the API surfaces 11 operations — 1 DELETE, 5 GET, 3 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Node instances 11
GET
/api/v1/customers/{cUUID}/nodes
List all node instances of a customer
List 2 params → 200
GET
/api/v1/customers/{cUUID}/nodes/{nodeUUID}/list
Get a node instance
getNodeInstance 2 params → 200
DELETE
/api/v1/customers/{cUUID}/providers/{pUUID}/instances/{instanceIP}
Delete a node instance
deleteInstance 4 params → 200
POST
/api/v1/customers/{cUUID}/providers/{pUUID}/instances/{instanceIP}
Detached node action
detachedNodeAction 4 params body → 200
PUT
/api/v1/customers/{cUUID}/providers/{pUUID}/instances/{instanceIP}/state
Update node instance state
updateState 4 params body → 200
GET
/api/v1/customers/{cUUID}/providers/{pUUID}/nodes/list
List all of a provider's node instances
listByProvider 2 params → 200
PUT
/api/v1/customers/{cUUID}/universes/{universeUUID}/nodes/{nodeName}
Perform the specified action on the universe node
nodeAction 4 params body → 200
GET
/api/v1/customers/{cUUID}/universes/{universeUUID}/nodes/{nodeName}/details
Get node details
getNodeDetails 3 params → 200
POST
/api/v1/customers/{cUUID}/zones/{azUUID}/nodes
Create a node instance
createNodeInstance 3 params body → 200
GET
/api/v1/customers/{cUUID}/zones/{azUUID}/nodes/list
List all of a zone's node instances
listByZone 2 params → 200
POST
/api/v1/customers/{cUUID}/zones/{azUUID}/nodes/validate
Validate a node instance
validateNodeInstance 3 params → 200

Schemas 34

The contract defines 34 schemas that model the data the API accepts and returns. The most detailed are NodeDetailsResp_3 (39 properties), NodeDetailsResp_2 (39 properties), NodeDetailsResp (39 properties), CloudSpecificInfo (18 properties). Each schema is shown below with its type and property counts.

NodeActionFormData
object
3 properties 1 required
NodeInstance
object
A single node instance, attached to a provider and availability zone
10 properties 1 required
CloudSpecificInfo
object
Node information reported by the cloud provider
18 properties
NodeInstanceFormData
object
1 property 1 required
NodeDetailsResp
object
39 properties 1 required
NodeInstanceStateFormData
object
1 property
YBPSuccess
object
2 properties
YBPTask
object
2 properties
NodeInstanceData
object
Details of a node instance. Used by the API to validate data against input constraints.
7 properties 5 required
ValidationResult
object
Validation result of a node config
5 properties 5 required
NodeActionFormData_2
object
1 property 1 required
NodeInstanceFormData_2
object
1 property 1 required
YBPSuccess_2
object
2 properties
NodeInstance_2
object
A single node instance, attached to a provider and availability zone
8 properties 1 required
YBPTask_2
object
2 properties
NodeInstanceData_2
object
Details of a node instance. Used by the API to validate data against input constraints.
7 properties 6 required
NodeActionFormData_3
object
3 properties 1 required
NodeInstance_3
object
A single node instance, attached to a provider and availability zone
10 properties 1 required
CloudSpecificInfo_2
object
Node information reported by the cloud provider
18 properties
NodeInstanceFormData_3
object
1 property 1 required
NodeDetailsResp_2
object
39 properties 1 required
NodeInstanceStateFormData_2
object
1 property
YBPSuccess_3
object
2 properties
YBPTask_3
object
2 properties
ValidationResult_2
object
Validation result of a node config
5 properties 5 required
NodeActionFormData_4
object
3 properties 1 required
NodeInstance_4
object
A single node instance, attached to a provider and availability zone
10 properties 1 required
CloudSpecificInfo_3
object
Node information reported by the cloud provider
18 properties
NodeInstanceFormData_4
object
1 property 1 required
NodeDetailsResp_3
object
39 properties 1 required
NodeInstanceStateFormData_3
object
1 property
YBPSuccess_4
object
2 properties
YBPTask_4
object
2 properties
ValidationResult_3
object
Validation result of a node config
5 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yugabytedb-node-instances-api-openapi.yml Raw ↑

Other APIs YugabyteDB publishes across the network.

YugabyteDB Access Keys API
AE Profile APIs.io
YugabyteDB Accounts API
AE Profile APIs.io
YugabyteDB Alerts API
AE Profile APIs.io
YugabyteDB AllowLists API
AE Profile APIs.io
YugabyteDB Asynchronous Replication API
AE Profile APIs.io
YugabyteDB Audit API
AE Profile APIs.io
YugabyteDB Authentication API
AE Profile APIs.io
YugabyteDB Availability Zones API
AE Profile APIs.io
YugabyteDB Backup and Restore API
AE Profile APIs.io
YugabyteDB Backups API
AE Profile APIs.io
YugabyteDB Certificate Info API
AE Profile APIs.io
YugabyteDB Cloud providers API
AE Profile APIs.io
#Node instances
← Back to Y APIs
API Details
ID
yugabytedb:yugabytedb-node-instances-api
Base URL
https://cloud.yugabyte.com/api/public/v1
Docs
https://docs.yugabyte.com/stable/yugabyte-cloud/managed-automation/managed-api/
Provider
YugabyteDB
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=yugabytedb-node-instances-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/yugabytedb-node-instances-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of YugabyteDB Node instances API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.