YugabyteDB Universe management API
The Universe management API from YugabyteDB — 11 operation(s) for universe management.
YugabyteDB Universe 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 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 12 operations across 11 paths, and defines 169 schemas. It is described by OpenAPI 3.2.0, at version v1.
Requests are made against a single base URL, /.
12 operations
11 paths
169 schemas
1 DELETE2 GET5 POST4 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
YugabyteDB Universe 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 12
Across 11 paths, the API surfaces 12 operations — 1 DELETE, 2 GET, 5 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.
Universe management 12
GET
/api/v1/customers/{cUUID}/universes
List universes
DELETE
/api/v1/customers/{cUUID}/universes/{uniUUID}
Delete a universe
GET
/api/v1/customers/{cUUID}/universes/{uniUUID}
Get a universe
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/config_alertsdeprecated
Configure alerts for a universe
PUT
/api/v1/customers/{cUUID}/universes/{uniUUID}/mark_helm3_compatible
Flag a universe as Helm 3-compatible - deprecated
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/pause
Pause a universe
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/resume
Resume a paused universe
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/set_key
Set a universe's key
PUT
/api/v1/customers/{cUUID}/universes/{uniUUID}/setup_universe_2dc
Reset universe version
PUT
/api/v1/customers/{cUUID}/universes/{uniUUID}/update_backup_state
Set a universe's backup flag
PUT
/api/v1/customers/{cUUID}/universes/{uniUUID}/update_lb_config
Update load balancer config
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/toggle_tlsdeprecated
Toggle a universe's TLS state
Schemas 169
The contract defines 169 schemas that model the data the API accepts and returns. The most detailed are UniverseDefinitionTaskParamsResp (64 properties), UniverseDefinitionTaskParamsResp_4 (64 properties), UniverseDefinitionTaskParamsResp_3 (64 properties), UserIntent_3 (55 properties). Each schema is shown below with its type and property counts.
PlacementRegion
object
5 properties
PerProcessFlags
object
1 property
1 required
AuditLogConfig
object
Audit Log Configuration
4 properties
1 required
CloudVolumeEncryption
object
Volume encryption settings for AWS EBS volumes
2 properties
AWSRegionCloudInfo
object
4 properties
YCQLAuditConfig
object
YCQL Audit Logging Configuration
8 properties
8 required
Users
object
A user associated with a customer
12 properties
3 required
UniverseDefinitionTaskParamsResp
object
64 properties
5 required
UniverseLogsExporterConfig
object
Universe Logs Exporter Config
2 properties
2 required
K8SNodeResourceSpec
object
2 properties
2 required
YSQLAuditConfig
object
YSQL Audit Logging Configuration
11 properties
11 required
ExtraDependencies
object
Extra dependencies
1 property
UniverseMetricsExporterConfig
object
Metrics Exporter Configuration
8 properties
2 required
DeviceInfo
object
Device information
8 properties
SpecificGFlags
object
GFlags for current cluster
4 properties
QueryLogConfig
object
Query Log Configuration
3 properties
1 required
EncryptionAtRestConfig
object
Encryption at rest configuration
4 properties
XClusterInfo
object
1 property
AzureRegionCloudInfo
object
5 properties
ProxyConfig
object
The Proxy Settings for the Universe
3 properties
UserIntentOverrides
object
WARNING: This is a preview API that could change. User Intent overrides
2 properties
AZCloudInfo
object
1 property
CloudSpecificInfo
object
Node information reported by the cloud provider
18 properties
UpdateLoadBalancerConfig
object
5 properties
5 required
Region
object
Region within a given provider. Typically, this maps to a single cloud provider region.
12 properties
1 required
PerProcessDetails
object
WARNING: This is a preview API that could change. User intent Properties that can be overriden on per-process basis.
2 properties
KubernetesRegionInfo
object
22 properties
1 required
Cluster
object
7 properties
2 required
UniverseResp
object
Universe-creation response
15 properties
PrevYBSoftwareConfig
object
5 properties
YBPTask
object
2 properties
AdditionalServicesStateData
object
Additional services state
2 properties
MetricsExportConfig
object
Metrics Export Configuration
5 properties
1 required
PlacementAZ
object
9 properties
AZOverrides
object
WARNING: This is a preview API that could change. Availability zone level overrides
5 properties
PartitionInfo
object
WARNING: This is a preview API that could change. Information about Geo partition
5 properties
UniverseResourceDetails
object
11 properties
GCPRegionCloudInfo
object
2 properties
RegionCloudInfo
object
4 properties
UserIntent
object
55 properties
AvailabilityZoneDetails
object
1 property
RollMaxBatchSize
object
WARNING: This is a preview API that could change.Information about suggested number of servers to roll at a time
2 properties
AllowedUniverseTasksResp
object
2 properties
RegionDetails
object
1 property
AvailabilityZone
object
Availability zone (AZ) for a region
9 properties
1 required
UniverseQueryLogsExporterConfig
object
Universe Logs Exporter Config
7 properties
2 required
PlacementCloud
object
4 properties
EarlyoomConfig
object
State for earlyoom service
6 properties
CommunicationPorts
object
Communication ports
15 properties
PlacementInfo
object
1 property
1 required
YSQLQueryLogConfig
object
YSQL Query Logging Configuration
10 properties
9 required
YBPSuccess
object
2 properties
NodeDetailsResp
object
39 properties
1 required
PlacementInfo_2
object
1 property
1 required
UniverseDefinitionTaskParamsResp_2
object
37 properties
1 required
ExtraDependencies_2
object
Extra dependencies
1 property
DeviceInfo_2
object
Device information
7 properties
EncryptionAtRestConfig_2
object
Encryption at rest configuration
4 properties
CloudSpecificInfo_2
object
Node information reported by the cloud provider
14 properties
Region_2
object
Region within a given provider. Typically, this maps to a single cloud provider region.
12 properties
1 required
Cluster_2
object
6 properties
2 required
UniverseResp_2
object
Universe-creation response
11 properties
YBPTask_2
object
2 properties
PlacementAZ_2
object
7 properties
UniverseResourceDetails_2
object
11 properties
UserIntent_2
object
32 properties
AvailabilityZone_2
object
Availability zone (AZ) for a region
8 properties
1 required
PlacementCloud_2
object
4 properties
DummyBody
object
Dummy value to work around platform bug PLAT-2076
1 property
CommunicationPorts_2
object
Communication ports
11 properties
PlacementRegion_2
object
4 properties
YBPSuccess_2
object
2 properties
NodeDetailsResp_2
object
29 properties
PlacementRegion_3
object
5 properties
PerProcessFlags_2
object
1 property
1 required
AuditLogConfig_2
object
Audit Log Configuration
4 properties
1 required
CloudVolumeEncryption_2
object
Volume encryption settings for AWS EBS volumes
2 properties
AWSRegionCloudInfo_2
object
4 properties
YCQLAuditConfig_2
object
YCQL Audit Logging Configuration
8 properties
8 required
Users_2
object
A user associated with a customer
12 properties
3 required
UniverseDefinitionTaskParamsResp_3
object
64 properties
5 required
UniverseLogsExporterConfig_2
object
Universe Logs Exporter Config
2 properties
2 required
K8SNodeResourceSpec_2
object
2 properties
2 required
YSQLAuditConfig_2
object
YSQL Audit Logging Configuration
11 properties
11 required
ExtraDependencies_3
object
Extra dependencies
1 property
UniverseMetricsExporterConfig_2
object
Metrics Exporter Configuration
8 properties
2 required
DeviceInfo_3
object
Device information
8 properties
SpecificGFlags_2
object
GFlags for current cluster
4 properties
QueryLogConfig_2
object
Query Log Configuration
3 properties
1 required
EncryptionAtRestConfig_3
object
Encryption at rest configuration
4 properties
XClusterInfo_2
object
1 property
AzureRegionCloudInfo_2
object
5 properties
UserIntentOverrides_2
object
WARNING: This is a preview API that could change. User Intent overrides
2 properties
CloudSpecificInfo_3
object
Node information reported by the cloud provider
18 properties
UpdateLoadBalancerConfig_2
object
5 properties
5 required
Region_3
object
Region within a given provider. Typically, this maps to a single cloud provider region.
12 properties
1 required
PerProcessDetails_2
object
WARNING: This is a preview API that could change. User intent Properties that can be overriden on per-process basis.
2 properties
KubernetesRegionInfo_2
object
22 properties
1 required
Cluster_3
object
7 properties
2 required
UniverseResp_3
object
Universe-creation response
15 properties
PrevYBSoftwareConfig_2
object
5 properties
YBPTask_3
object
2 properties
AdditionalServicesStateData_2
object
Additional services state
2 properties
MetricsExportConfig_2
object
Metrics Export Configuration
5 properties
1 required
PlacementAZ_3
object
9 properties
AZOverrides_2
object
WARNING: This is a preview API that could change. Availability zone level overrides
5 properties
PartitionInfo_2
object
WARNING: This is a preview API that could change. Information about Geo partition
5 properties
UniverseResourceDetails_3
object
11 properties
GCPRegionCloudInfo_2
object
2 properties
UserIntent_3
object
55 properties
RollMaxBatchSize_2
object
WARNING: This is a preview API that could change.Information about suggested number of servers to roll at a time
2 properties
AllowedUniverseTasksResp_2
object
2 properties
AvailabilityZone_3
object
Availability zone (AZ) for a region
9 properties
1 required
UniverseQueryLogsExporterConfig_2
object
Universe Logs Exporter Config
7 properties
2 required
PlacementCloud_3
object
4 properties
EarlyoomConfig_2
object
State for earlyoom service
6 properties
CommunicationPorts_3
object
Communication ports
15 properties
PlacementInfo_3
object
1 property
1 required
YSQLQueryLogConfig_2
object
YSQL Query Logging Configuration
10 properties
9 required
YBPSuccess_3
object
2 properties
NodeDetailsResp_3
object
39 properties
1 required
PlacementRegion_4
object
5 properties
PerProcessFlags_3
object
1 property
1 required
AuditLogConfig_3
object
Audit Log Configuration
4 properties
1 required
CloudVolumeEncryption_3
object
Volume encryption settings for AWS EBS volumes
2 properties
AWSRegionCloudInfo_3
object
4 properties
YCQLAuditConfig_3
object
YCQL Audit Logging Configuration
8 properties
8 required
Users_3
object
A user associated with a customer
12 properties
3 required
UniverseDefinitionTaskParamsResp_4
object
64 properties
5 required
UniverseLogsExporterConfig_3
object
Universe Logs Exporter Config
2 properties
2 required
K8SNodeResourceSpec_3
object
2 properties
2 required
YSQLAuditConfig_3
object
YSQL Audit Logging Configuration
11 properties
11 required
ExtraDependencies_4
object
Extra dependencies
1 property
UniverseMetricsExporterConfig_3
object
Metrics Exporter Configuration
8 properties
2 required
DeviceInfo_4
object
Device information
8 properties
SpecificGFlags_3
object
GFlags for current cluster
4 properties
QueryLogConfig_3
object
Query Log Configuration
3 properties
1 required
EncryptionAtRestConfig_4
object
Encryption at rest configuration
4 properties
XClusterInfo_3
object
1 property
AzureRegionCloudInfo_3
object
5 properties
UserIntentOverrides_3
object
WARNING: This is a preview API that could change. User Intent overrides
2 properties
CloudSpecificInfo_4
object
Node information reported by the cloud provider
18 properties
UpdateLoadBalancerConfig_3
object
5 properties
5 required
Region_4
object
Region within a given provider. Typically, this maps to a single cloud provider region.
12 properties
1 required
PerProcessDetails_3
object
WARNING: This is a preview API that could change. User intent Properties that can be overriden on per-process basis.
2 properties
KubernetesRegionInfo_3
object
22 properties
1 required
Cluster_4
object
7 properties
2 required
UniverseResp_4
object
Universe-creation response
15 properties
PrevYBSoftwareConfig_3
object
5 properties
YBPTask_4
object
2 properties
AdditionalServicesStateData_3
object
Additional services state
2 properties
MetricsExportConfig_3
object
Metrics Export Configuration
5 properties
1 required
PlacementAZ_4
object
9 properties
AZOverrides_3
object
WARNING: This is a preview API that could change. Availability zone level overrides
5 properties
PartitionInfo_3
object
WARNING: This is a preview API that could change. Information about Geo partition
5 properties
UniverseResourceDetails_4
object
11 properties
GCPRegionCloudInfo_3
object
2 properties
UserIntent_4
object
55 properties
RollMaxBatchSize_3
object
WARNING: This is a preview API that could change.Information about suggested number of servers to roll at a time
2 properties
AllowedUniverseTasksResp_3
object
2 properties
AvailabilityZone_4
object
Availability zone (AZ) for a region
9 properties
1 required
UniverseQueryLogsExporterConfig_3
object
Universe Logs Exporter Config
7 properties
2 required
PlacementCloud_4
object
4 properties
EarlyoomConfig_3
object
State for earlyoom service
6 properties
CommunicationPorts_4
object
Communication ports
15 properties
PlacementInfo_4
object
1 property
1 required
YSQLQueryLogConfig_3
object
YSQL Query Logging Configuration
10 properties
9 required
YBPSuccess_4
object
2 properties
NodeDetailsResp_4
object
39 properties
1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from YugabyteDB 12
Other APIs YugabyteDB publishes across the network.
YugabyteDB Access Keys API
YugabyteDB Accounts API
YugabyteDB Alerts API
YugabyteDB AllowLists API
YugabyteDB Asynchronous Replication API
YugabyteDB Audit API
YugabyteDB Authentication API
YugabyteDB Availability Zones API
YugabyteDB Backup and Restore API
YugabyteDB Backups API
YugabyteDB Certificate Info API
YugabyteDB Cloud providers API
#Universe management
Where this information came from
This is an independent, third-party profile of YugabyteDB Universe 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.