Skip to navigation
API Referencedatabases

Create a new database cluster

Creates a new managed database cluster for the authenticated account.

Authentication

X-API-Client-IDstring
API Client ID
X-API-Client-Secretstring
API Client Secret

Request

This endpoint expects an object.
dbClusterNamestringRequired
Database cluster name. Must comply with Kubernetes naming rules.
regionIdstringRequiredformat: "uuid"
Identifier of the region the cluster will run in.
tierstringRequiredDefaults to standard

Infrastructure tier that determines per-node CPU and memory.

availabilityTypeenumRequiredDefaults to data-redundancy
Availability mode for the cluster.
Allowed values:
userClusterIdstringOptionalformat: "uuid"
Identifier of an existing infrastructure cluster to deploy the database on. Omit to provision new infrastructure.
sshKeystringOptional

SSH key authorized for access to the cluster. Required when creating a new cluster; omit only when deploying onto an existing userClusterId.

offeringIdstringOptionalformat: "uuid"
Identifier of the database offering to use.
offeringNamestringOptional

Name of the database offering. Alternative to offeringId for selecting an offering.

storageGbintegerOptional
Storage capacity allocated to the cluster, in gigabytes.
networkConfigobjectOptional

Network the cluster will attach to. Required when creating a new cluster; omit only when deploying onto an existing userClusterId.

restoreobjectOptional

Restore-from-backup configuration. Provide to bootstrap the new cluster from an existing backup.

Response

Database cluster creation initiated

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
500
Internal Server Error