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

YugabyteDB Node Agents API

The Node Agents API from YugabyteDB — 5 operation(s) for node agents.

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

Requests are made against a single base URL, /.

5 operations 5 paths 8 schemas 3 GET2 POST

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
Terms of Service
Resource Areas
1

Authentication & Security 1

YugabyteDB Node Agents 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 5

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

Node Agents 5
GET
/api/v1/customers/{cUUID}/node_agents
List Node Agents
ListNodeAgents 2 params → 200
POST
/api/v1/customers/{cUUID}/node_agents/page
List Node Agents (paginated)
PageListNodeAgents 2 params body → 200
GET
/api/v1/customers/{cUUID}/node_agents/{nUUID}
Get Node Agent
GetNodeAgent 2 params → 200
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/node_agents
Reinstall Node Agent
ReinstallNodeAgent 3 params body → 200
GET
/api/v1/node_agents/download
Download Node Agent Installer or Package
DownloadNodeAgentInstaller 3 params → 200

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are NodeAgentResp (19 properties), NodeAgent (13 properties), NodeAgentApiFilter (6 properties), NodeAgentPagedApiQuery (6 properties). Each schema is shown below with its type and property counts.

NodeAgent
object
Node agent details
13 properties
Config
object
5 properties 5 required
NodeAgentPagedApiQuery
object
6 properties 6 required
ReinstallNodeAgentForm
object
1 property
NodeAgentPagedApiResponse
object
4 properties 4 required
NodeAgentResp
object
Node agent details
19 properties
NodeAgentApiFilter
object
6 properties 6 required
YBAError
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yugabytedb-node-agents-api-openapi.yml Raw ↑
Where this information came from

This is an independent, third-party profile of YugabyteDB Node Agents 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.