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 Universe database management API

The Universe database management API from YugabyteDB — 6 operation(s) for universe database management.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

Tagged areas include Universe database management. 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 6 operations across 6 paths, and defines 36 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, /.

6 operations 6 paths 36 schemas 6 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
License
Polyform Free Trial License 1.0.0
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

YugabyteDB Universe database management 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 6

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

Universe database management 6
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/create_db_credentials
Create a database user for a universe
createUserInDB 3 params body → 200
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/run_query
Run a YSQL query in a universe
runYsqlQueryUniverse 3 params body → 200
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/update_db_credentials
Set a universe's database credentials
setDatabaseCredentials 3 params body → 200
POST
/api/v1/customers/{cUUID}/universes/{univUUID}/configure/ycql
Configure YCQL
configureYCQL 3 params body → 200
POST
/api/v1/customers/{cUUID}/universes/{univUUID}/configure/ysql
Configure YSQL
configureYSQL 3 params body → 200
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/run_in_shell
Run a shell command
runInShell 2 params → 200

Schemas 36

The contract defines 36 schemas that model the data the API accepts and returns. The most detailed are CommunicationPorts_2 (15 properties), CommunicationPorts_3 (15 properties), CommunicationPorts (15 properties), DatabaseUserFormData_3 (8 properties). Each schema is shown below with its type and property counts.

PerProcessFlags
object
1 property 1 required
YBPTask
object
2 properties
RunQueryFormData
object
4 properties 4 required
CommunicationPorts
object
Communication ports
15 properties
SpecificGFlags
object
GFlags for current cluster
4 properties
ConfigureYCQLFormData
object
YCQL properties
4 properties
DatabaseSecurityFormData
object
Database security properties
7 properties
ConfigureYSQLFormData
object
YSQL properties
6 properties
YBPSuccess
object
2 properties
DatabaseUserFormData
object
8 properties 7 required
RoleAttribute
object
1 property 1 required
YBPSuccess_2
object
2 properties
RunQueryFormData_2
object
3 properties 3 required
YBPError
object
Generic error response from the YugabyteDB Anywhere API
3 properties
PerProcessFlags_2
object
1 property 1 required
YBPTask_2
object
2 properties
RunQueryFormData_3
object
4 properties 4 required
CommunicationPorts_2
object
Communication ports
15 properties
SpecificGFlags_2
object
GFlags for current cluster
4 properties
ConfigureYCQLFormData_2
object
YCQL properties
4 properties
DatabaseSecurityFormData_2
object
Database security properties
7 properties
ConfigureYSQLFormData_2
object
YSQL properties
6 properties
YBPSuccess_3
object
2 properties
DatabaseUserFormData_2
object
8 properties 7 required
RoleAttribute_2
object
1 property 1 required
PerProcessFlags_3
object
1 property 1 required
YBPTask_3
object
2 properties
RunQueryFormData_4
object
4 properties 4 required
CommunicationPorts_3
object
Communication ports
15 properties
SpecificGFlags_3
object
GFlags for current cluster
4 properties
ConfigureYCQLFormData_3
object
YCQL properties
4 properties
DatabaseSecurityFormData_3
object
Database security properties
7 properties
ConfigureYSQLFormData_3
object
YSQL properties
6 properties
YBPSuccess_4
object
2 properties
DatabaseUserFormData_3
object
8 properties 7 required
RoleAttribute_3
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yugabytedb-universe-database-management-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
#Universe database management
← Back to Y APIs
API Details
ID
yugabytedb:yugabytedb-universe-database-management-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-universe-database-management-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/yugabytedb-universe-database-management-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 Universe database management 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.