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 101 schemas. It is described by OpenAPI 3.1.0, at version v1.
Requests are made against a single base URL, https://cloud.yugabyte.com/api/public/v1.
12 operations
11 paths
101 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.
It accepts HTTP bearer tokens (bearerAuth).
By default, every request must be authenticated.
bearerAuth— API key obtained from the YugabyteDB Aeon UI under User Profile API Keys. Pass the key as a Bearer token in the Authorization 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
YugabyteDB Anywhere List Universes
DELETE
/api/v1/customers/{cUUID}/universes/{uniUUID}
YugabyteDB Anywhere Delete a Universe
GET
/api/v1/customers/{cUUID}/universes/{uniUUID}
YugabyteDB Anywhere Get a Universe
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/config_alertsdeprecated
YugabyteDB Anywhere Configure Alerts for a Universe
PUT
/api/v1/customers/{cUUID}/universes/{uniUUID}/mark_helm3_compatible
YugabyteDB Anywhere Flag a Universe as Helm 3-compatible - Deprecated
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/pause
YugabyteDB Anywhere Pause a Universe
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/resume
YugabyteDB Anywhere Resume a Paused Universe
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/set_key
YugabyteDB Anywhere Set a Universe's Key
PUT
/api/v1/customers/{cUUID}/universes/{uniUUID}/setup_universe_2dc
YugabyteDB Anywhere Reset Universe Version
PUT
/api/v1/customers/{cUUID}/universes/{uniUUID}/update_backup_state
YugabyteDB Anywhere Set a Universe's Backup Flag
PUT
/api/v1/customers/{cUUID}/universes/{uniUUID}/update_lb_config
YugabyteDB Anywhere Update Load Balancer Config
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/toggle_tlsdeprecated
Toggle a universe's TLS state
Schemas 101
The contract defines 101 schemas that model the data the API accepts and returns. The most detailed are UniverseDefinitionTaskParamsResp_2 (64 properties), UniverseDefinitionTaskParamsResp (64 properties), UserIntent_2 (55 properties), UserIntent (55 properties). Each schema is shown below with its type and property counts.
UniverseResourceDetails
object
11 properties
AllowedUniverseTasksResp
object
2 properties
QueryLogConfig
object
Query Log Configuration
3 properties
1 required
AvailabilityZone
object
Availability zone (AZ) for a region
9 properties
1 required
NodeDetailsResp
object
39 properties
1 required
EarlyoomConfig
object
State for earlyoom service
6 properties
MetricsExportConfig
object
Metrics Export Configuration
5 properties
1 required
UniverseQueryLogsExporterConfig
object
Universe Logs Exporter Config
7 properties
2 required
AZCloudInfo
object
1 property
YBPTask
object
2 properties
SpecificGFlags
object
GFlags for current cluster
4 properties
EncryptionAtRestConfig
object
Encryption at rest configuration
4 properties
RollMaxBatchSize
object
WARNING: This is a preview API that could change.Information about suggested number of servers to roll at a time
2 properties
AWSRegionCloudInfo
object
4 properties
RegionDetails
object
1 property
YCQLAuditConfig
object
YCQL Audit Logging Configuration
8 properties
8 required
CloudSpecificInfo
object
Node information reported by the cloud provider
18 properties
YBPSuccess
object
2 properties
AvailabilityZoneDetails
object
1 property
AZOverrides
object
WARNING: This is a preview API that could change. Availability zone level overrides
5 properties
YSQLAuditConfig
object
YSQL Audit Logging Configuration
11 properties
11 required
Cluster
object
7 properties
2 required
UniverseLogsExporterConfig
object
Universe Logs Exporter Config
2 properties
2 required
AdditionalServicesStateData
object
Additional services state
2 properties
AzureRegionCloudInfo
object
5 properties
UniverseResp
object
Universe-creation response
15 properties
PrevYBSoftwareConfig
object
5 properties
UpdateLoadBalancerConfig
object
5 properties
5 required
AuditLogConfig
object
Audit Log Configuration
4 properties
1 required
YSQLQueryLogConfig
object
YSQL Query Logging Configuration
10 properties
9 required
ExtraDependencies
object
Extra dependencies
1 property
PartitionInfo
object
WARNING: This is a preview API that could change. Information about Geo partition
5 properties
GCPRegionCloudInfo
object
2 properties
PlacementAZ
object
9 properties
Users
object
A user associated with a customer
12 properties
3 required
UniverseMetricsExporterConfig
object
Metrics Exporter Configuration
8 properties
2 required
Region
object
Region within a given provider. Typically, this maps to a single cloud provider region.
12 properties
1 required
DeviceInfo
object
Device information
8 properties
K8SNodeResourceSpec
object
2 properties
2 required
UniverseDefinitionTaskParamsResp
object
64 properties
5 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
UserIntent
object
55 properties
UserIntentOverrides
object
WARNING: This is a preview API that could change. User Intent overrides
2 properties
CloudVolumeEncryption
object
Volume encryption settings for AWS EBS volumes
2 properties
PerProcessFlags
object
1 property
1 required
CommunicationPorts
object
Communication ports
15 properties
PlacementCloud
object
4 properties
XClusterInfo
object
1 property
ProxyConfig
object
The Proxy Settings for the Universe
3 properties
PlacementRegion
object
5 properties
KubernetesRegionInfo
object
22 properties
1 required
RegionCloudInfo
object
4 properties
PlacementInfo
object
1 property
1 required
UniverseResourceDetails_2
object
11 properties
AllowedUniverseTasksResp_2
object
2 properties
QueryLogConfig_2
object
Query Log Configuration
3 properties
1 required
AvailabilityZone_2
object
Availability zone (AZ) for a region
9 properties
1 required
NodeDetailsResp_2
object
39 properties
1 required
EarlyoomConfig_2
object
State for earlyoom service
6 properties
MetricsExportConfig_2
object
Metrics Export Configuration
5 properties
1 required
UniverseQueryLogsExporterConfig_2
object
Universe Logs Exporter Config
7 properties
2 required
YBPTask_2
object
2 properties
SpecificGFlags_2
object
GFlags for current cluster
4 properties
EncryptionAtRestConfig_2
object
Encryption at rest configuration
4 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
AWSRegionCloudInfo_2
object
4 properties
YCQLAuditConfig_2
object
YCQL Audit Logging Configuration
8 properties
8 required
CloudSpecificInfo_2
object
Node information reported by the cloud provider
18 properties
YBPSuccess_2
object
2 properties
AZOverrides_2
object
WARNING: This is a preview API that could change. Availability zone level overrides
5 properties
YSQLAuditConfig_2
object
YSQL Audit Logging Configuration
11 properties
11 required
Cluster_2
object
7 properties
2 required
UniverseLogsExporterConfig_2
object
Universe Logs Exporter Config
2 properties
2 required
AdditionalServicesStateData_2
object
Additional services state
2 properties
AzureRegionCloudInfo_2
object
5 properties
UniverseResp_2
object
Universe-creation response
15 properties
PrevYBSoftwareConfig_2
object
5 properties
UpdateLoadBalancerConfig_2
object
5 properties
5 required
AuditLogConfig_2
object
Audit Log Configuration
4 properties
1 required
YSQLQueryLogConfig_2
object
YSQL Query Logging Configuration
10 properties
9 required
ExtraDependencies_2
object
Extra dependencies
1 property
PartitionInfo_2
object
WARNING: This is a preview API that could change. Information about Geo partition
5 properties
GCPRegionCloudInfo_2
object
2 properties
PlacementAZ_2
object
9 properties
Users_2
object
A user associated with a customer
12 properties
3 required
UniverseMetricsExporterConfig_2
object
Metrics Exporter Configuration
8 properties
2 required
Region_2
object
Region within a given provider. Typically, this maps to a single cloud provider region.
12 properties
1 required
DeviceInfo_2
object
Device information
8 properties
K8SNodeResourceSpec_2
object
2 properties
2 required
UniverseDefinitionTaskParamsResp_2
object
64 properties
5 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
UserIntent_2
object
55 properties
UserIntentOverrides_2
object
WARNING: This is a preview API that could change. User Intent overrides
2 properties
CloudVolumeEncryption_2
object
Volume encryption settings for AWS EBS volumes
2 properties
PerProcessFlags_2
object
1 property
1 required
CommunicationPorts_2
object
Communication ports
15 properties
PlacementCloud_2
object
4 properties
XClusterInfo_2
object
1 property
PlacementRegion_2
object
5 properties
KubernetesRegionInfo_2
object
22 properties
1 required
PlacementInfo_2
object
1 property
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