Перейти к основному содержимому
API docs by Redocly

Managed Databases API (v1.0)

Managing databases: creating and scaling database clusters up, restoring from backup, managing users, and more

Access Control Lists

Access control lists (ACLs) in a Kafka cluster define actions on topics, consumer groups, and the cluster that users can perform. Use these endpoints to grant or restrict permissions by pattern and scope.

List Access Control Lists

Returns a list of Kafka Access Control Lists.

Authorizations:
iam_token_project_scoped
query Parameters
id
string

Filter the list result by the id.

project_id
string

Filter the list result by the project_id.

datastore_id
string

Filter the list result by the datastore_id.

pattern
string

Filter the list result by the pattern.

pattern_type
string

Filter the list result by the pattern_type.

status
string

Filter the list result by the status.

user_id
string

Filter the list result by the user_id.

Responses

Response samples

Content type
application/json
{
  • "acls": [
    ]
}

Create Access Control List

Creates a new Kafka Access Control List.

Authorizations:
iam_token_project_scoped
Request Body schema: application/json
required
required
object (ACLCreate)
allow_read
required
boolean

Allows to connect as a consumer.

allow_write
required
boolean

Allows to connect as a producer.

datastore_id
required
string <UUID>

Unique identifier of the associated cluster for which the Access Control List will be created.

pattern
string <= 249 characters ^[a-zA-Z0-9\._\-]+$

Name or prefix of a topic to which you provide access. Must be skipped when pattern_type is all.

pattern_type
required
string
Enum: "literal" "prefixed" "all"

Access Control List pattern type. When pattern_type is all, skip pattern.

user_id
required
string <UUID>

Unique identifier of the associated user for which the Access Control List was created.

Responses

Request samples

Content type
application/json
{
  • "acl": {
    }
}

Response samples

Content type
application/json
{
  • "acl": {
    }
}

Delete Access Control List

Deletes a Kafka Access Control List.

Authorizations:
iam_token_project_scoped
path Parameters
acl_id
required
string

Access Control List identifier.

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get Access Control List

Returns a Kafka Access Control list.

Authorizations:
iam_token_project_scoped
path Parameters
acl_id
required
string

Access Control List identifier.

Responses

Response samples

Content type
application/json
{
  • "acl": {
    }
}

Update Access Control List

Updates a Kafka Access Control List.

Authorizations:
iam_token_project_scoped
path Parameters
acl_id
required
string

Access Control List identifier.

Request Body schema: application/json
required
required
object (ACLUpdate)
allow_read
boolean

Allows to connect as a consumer.

allow_write
boolean

Allows to connect as a producer.

Responses

Request samples

Content type
application/json
{
  • "acl": {
    }
}

Response samples

Content type
application/json
{
  • "acl": {
    }
}

Actions

Information on actions performed in a cluster, used to track status, timing, and context of changes.

List actions

Returns a list of cluster actions.

Authorizations:
iam_token_project_scoped
query Parameters
id
string

Filter the list result by the id.

name
string

Filter the list result by the name.

status
string

Filter the list result by the status.

project_id
string

Filter the list result by the project_id.

request_id
string

Filter the list result by the request_id.

datastore_id
string

Filter the list result by the datastore_id.

Responses

Response samples

Content type
application/json
{
  • "actions": [
    ]
}

Get action

Returns a specific cluster action.

Authorizations:
iam_token_project_scoped
path Parameters
action_id
required
string

Action identifier.

Responses

Response samples

Content type
application/json
{
  • "action": {
    }
}

Available extensions

Available extensions that can be used to extend the functionality of a database within a cluster.

List available extensions

Returns a list of available extensions.

Authorizations:
iam_token_project_scoped
query Parameters
id
string

Filter the list result by the id.

name
string

Filter the list result by the name.

datastore_type_id
string

Filter the list result by the datastore_type_id.

Responses

Response samples

Content type
application/json
{
  • "available-extensions": [
    ]
}

Create available extension Deprecated

Creates a new available extension.

Authorizations:
iam_token_project_scoped
Request Body schema: application/json
required
required
object (AvailableExtensionCreate)
datastore_type_ids
required
Array of strings <UUID> [ items <UUID > ]

List of cluster types that support the extension. Retrieved from the datastore-type resource.

dependency_ids
Array of strings <UUID> [ items <UUID > ]

List of extensions that depend on this extension.

name
required
string [ 1 .. 255 ] characters

Name of the available extension.

Responses

Request samples

Content type
application/json
{
  • "available-extension": {
    }
}

Response samples

Content type
application/json
{
  • "available-extension": {
    }
}

Delete available extension Deprecated

Deletes an available extension and all related records.

Authorizations:
iam_token_project_scoped
path Parameters
available_extension_id
required
string

Available extension identifier.

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get available extension

Returns an available extension.

Authorizations:
iam_token_project_scoped
path Parameters
available_extension_id
required
string

Available extension identifier.

Responses

Response samples

Content type
application/json
{
  • "available-extension": {
    }
}

Update available extension Deprecated

Updates an available extension.

Authorizations:
iam_token_project_scoped
path Parameters
available_extension_id
required
string

Available extension identifier.

Request Body schema: application/json
required
required
object (AvailableExtensionUpdate)
datastore_type_ids
required
Array of strings <UUID> [ items <UUID > ]

List of cluster types that support the extension. Retrieved from the datastore-type resource.

dependency_ids
Array of strings <UUID> [ items <UUID > ]

List of extensions that depend on this extension.

Responses

Request samples

Content type
application/json
{
  • "available-extension": {
    }
}

Response samples

Content type
application/json
{
  • "available-extension": {
    }
}

Capabilities

The set of capabilities available in the region, grouped by feature type. Each capability indicates whether a feature is supported.

List capabilities

Returns a list of service capabilities.

Authorizations:
iam_token_project_scoped

Responses

Response samples

Content type
application/json
{
  • "capabilities": [
    ]
}

Configuration parameters

Configuration parameters are tunable settings of a cluster that can be changed to adjust its behavior, performance, and security.

List configuration parameters

Returns a list of configuration parameters.

Authorizations:
iam_token_project_scoped
query Parameters
id
string

Filter the list result by the id.

datastore_type_id
string

Filter the list result by the datastore_type_id.

name
string

Filter the list result by the name.

ram
string

Filter the list result by the ram.

vcpus
string

Filter the list result by the vcpus.

disk
string

Filter the list result by the disk.

Responses

Response samples

Content type
application/json
{
  • "configuration-parameters": [
    ]
}

Create configuration parameter Deprecated

Creates new configuration parameter.

Authorizations:
iam_token_project_scoped
Request Body schema: application/json
required
required
object (ConfigurationParameterCreate)
can_be_empty
required
boolean

Indicates whether the configuration parameter can have an empty value.

Array of (number or null) or (string or null) or (boolean or null) unique

Available choices for the configuration parameter.

datastore_type_id
required
string <UUID>

Unique identifier of the cluster type for which the configuration parameter is available.

default_value_template
string or null

Jinja template describing a default value of the configuration parameter.

factor
integer >= 1

Factor of the configuration parameter. A number that divides configuration parameter value evenly.

Array of (number or null) or (string or null) or (boolean or null) unique

List of invalid values for configuration parameter. If a value is in the list of invalid_values, an error is returned.

is_available_for_customer
required
boolean

Indicates whether the configuration parameter is available for a customer.

is_changeable
required
boolean

Indicates whether the configuration parameter can be changed.

is_multiple_choice_available
required
boolean

Indicates whether the configuration parameter can have multiple choices.

is_restart_required
required
boolean

Indicates whether the database needs a restart to apply changes.

max_template
string

Jinja template describing a maximum value of the configuration parameter.

min_template
string

Jinja template describing a minimum value of the configuration parameter.

name
required
string

Name of the configuration parameter.

type
required
string
Enum: "int" "float" "str" "bool"

Type of the configuration parameter.

unit
required
string

Units of the configuration parameter.

Responses

Request samples

Content type
application/json
{
  • "configuration-parameter": {
    }
}

Response samples

Content type
application/json
{
  • "configuration-parameter": {
    }
}

Delete configuration parameter Deprecated

Deletes a configuration parameter.

Authorizations:
iam_token_project_scoped
path Parameters
configuration_parameter_id
required
string

Configuration parameter identifier.

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get configuration parameter

Returns a configuration parameter.

Authorizations:
iam_token_project_scoped
path Parameters
configuration_parameter_id
required
string

Configuration parameter identifier.

Responses

Response samples

Content type
application/json
{
  • "configuration-parameter": {
    }
}

Databases

Managing databases within a cluster. Use these endpoints for CRUD operations and to inspect their metadata and status.

List databases

Returns a list of databases in a cluster.

Authorizations:
iam_token_project_scoped
query Parameters
id
string

Filter the list result by the id.

project_id
string

Filter the list result by the project_id.

name
string

Filter the list result by the name.

datastore_id
string

Filter the list result by the datastore_id.

status
string

Filter the list result by the status.

Responses

Response samples

Content type
application/json
{
  • "databases": [
    ]
}

Create database

Creates a new database in a cluster.

Authorizations:
iam_token_project_scoped
Request Body schema: application/json
required
required
object (DatabaseCreate)
datastore_id
required
string <UUID>

Unique identifier of the associated cluster for which the database will be created.

lc_collate
string

LC_COLLATE setting for the PostgreSQL cluster. Determined when you create a database and you cannot change it afterwards. The default value is C.

lc_ctype
string

LC_CTYPE setting for the PostgreSQL cluster. Determined when you create a database and you cannot change it afterwards. The default value is C.

name
required
string [ 1 .. 63 ] characters ^[A-Za-z_][A-Za-z0-9_]*$

Name of the database.

owner_id
string <UUID>

Unique identifier of the database owner.

Responses

Request samples

Content type
application/json
{
  • "database": {
    }
}

Response samples

Content type
application/json
{
  • "database": {
    }
}

Delete database

Deletes a database.

Authorizations:
iam_token_project_scoped
path Parameters
database_id
required
string

Database identifier.

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get database

Returns a database.

Authorizations:
iam_token_project_scoped
path Parameters
database_id
required
string

Database identifier.

Responses

Response samples

Content type
application/json
{
  • "database": {
    }
}

Update database

Updates database parameters.

Authorizations:
iam_token_project_scoped
path Parameters
database_id
required
string

Database identifier.

Request Body schema: application/json
required
required
object (DatabaseUpdate)
owner_id
required
string <UUID>

Unique identifier of the database owner.

Responses

Request samples

Content type
application/json
{
  • "database": {
    }
}

Response samples

Content type
application/json
{
  • "database": {
    }
}

Clusters

Managing clusters. Provides endpoints for CRUD operations and for performing operational actions such as rotating passwords, fetching logs/metrics, adjusting configuration, scaling, and toggling protection mode.

List clusters

Returns list of clusters.

Authorizations:
iam_token_project_scoped
query Parameters
id
string

Filter the list result by the id.

project_id
string

Filter the list result by the project_id.

name
string

Filter the list result by the name.

status
string

Filter the list result by the status.

enabled
string

Filter the list result by the enabled.

type_id
string

Filter the list result by the type_id.

flavor_id
string

Filter the list result by the flavor_id.

subnet_id
string

Filter the list result by the subnet_id.

allow_restore
string

Filter the list result by the allow_restore.

is_maintenance
string

Filter the list result by the is_maintenance.

is_protected
string

Filter the list result by the is_protected.

deleted
string

Filter the list result by the deleted.

Responses

Response samples

Content type
application/json
{
  • "datastores": [
    ]
}

Create cluster

Creates a new cluster.

Authorizations:
iam_token_project_scoped
Request Body schema: application/json
required
required
object (DatastoreCreate)
backup_retention_days
integer >= 1

Number of days for which backups are stored before they are deleted.

config
object

Configuration parameters for the cluster. You can retrieve information about available configuration parameters with the configuration-parameters resource.

object (DatastoreCreateDisk)
object (DatastoreCreateFlavor)
flavor_id
string <UUID>

Unique identifier of the flavor for the cluster. Can be skipped when flavor is set.

object (DatastoreCreateFloatingIPs)
object (DatastoreEnableLogPlatform)
name
required
string [ 1 .. 255 ] characters ^[A-Za-z0-9_-]*$

Name of the cluster.

node_count
required
integer >= 1

Number of nodes in the cluster.

object

Connection pooler settings. Available for PostgreSQL, PostgreSQL for 1C, PostgreSQL TimescaleDB.

project_id
string <UUID>

Unique identifier of the associated project.

redis_password
string [ 1 .. 255 ] characters

Cluster password.

object

Parameters for restoring a cluster from a backup, including the source cluster ID and target restore time.

security_groups
Array of strings <UUID> non-empty unique [ items <UUID > ]

List of security groups for the cluster.

subnet_id
required
string <UUID>

Unique identifier of the associated OpenStack network.

type_id
required
string <UUID>

Unique identifier of the cluster type. Retrieved from the datastore-type resource.

Responses

Request samples

Content type
application/json
{
  • "datastore": {
    }
}

Response samples

Content type
application/json
{
  • "datastore": {
    }
}

Get clusters count

Returns the number of clusters grouped by their type.

Authorizations:
iam_token_project_scoped
query Parameters
id
string

Filter the list result by the id.

project_id
string

Filter the list result by the project_id.

name
string

Filter the list result by the name.

status
string

Filter the list result by the status.

enabled
string

Filter the list result by the enabled.

type_id
string

Filter the list result by the type_id.

flavor_id
string

Filter the list result by the flavor_id.

subnet_id
string

Filter the list result by the subnet_id.

allow_restore
string

Filter the list result by the allow_restore.

is_maintenance
string

Filter the list result by the is_maintenance.

is_protected
string

Filter the list result by the is_protected.

deleted
string

Filter the list result by the deleted.

Responses

Response samples

Content type
application/json
{
  • "kafka": 2,
  • "mysql_semisync": 0,
  • "mysql_sync": 2,
  • "postgresql": 1,
  • "redis": 1
}

Delete cluster

Deletes cluster with all related entities.

Authorizations:
iam_token_project_scoped
path Parameters
datastore_id
required
string

Cluster identifier.

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get cluster

Returns a cluster.

Authorizations:
iam_token_project_scoped
path Parameters
datastore_id
required
string

Cluster identifier.

Responses

Response samples

Content type
application/json
{
  • "datastore": {
    }
}

Update cluster

Updates cluster parameters.

Authorizations:
iam_token_project_scoped
path Parameters
datastore_id
required
string

Cluster identifier.

Request Body schema: application/json
required
object (DatastoreUpdate)
name
required
string [ 1 .. 255 ] characters ^[A-Za-z0-9_-]*$

Name of the cluster.

Responses

Request samples

Content type
application/json
{
  • "datastore": {
    }
}

Response samples

Content type
application/json
{
  • "datastore": {
    }
}

Change cluster configuration parameters

Changes cluster configuration parameters. Send None as value to reset parameter to default value.

Authorizations:
iam_token_project_scoped
path Parameters
datastore_id
required
string

Cluster identifier.

Request Body schema: application/json
required
config
object

Responses

Request samples

Content type
application/json
{
  • "config": { }
}

Response samples

Content type
application/json
{
  • "datastore": {
    }
}

Get cluster databases metrics

Returns all metrics of the cluster databases.

Authorizations:
iam_token_project_scoped
path Parameters
datastore_id
required
string

Cluster identifier.

query Parameters
start
string

Filter the list result by the start.

end
string

Filter the list result by the end.

Responses

Response samples

Content type
application/json
{
  • "metrics": {
    }
}

Update cluster firewall rules

Updates cluster firewall rules.

Authorizations:
iam_token_project_scoped
path Parameters
datastore_id
required
string

Cluster identifier.

Request Body schema: application/json
required
required
object (DatastoreUpdateFirewall)
ips
required
Array of strings[ items [ 1 .. 255 ] characters ]

List of IP addresses that will have access to the cluster.

Responses

Request samples

Content type
application/json
{
  • "firewall": {
    }
}

Response samples

Content type
application/json
{
  • "datastore": {
    }
}

Disable cluster logs export

Disables cluster logs export.

Authorizations:
iam_token_project_scoped
path Parameters
datastore_id
required
string

Cluster identifier.

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Enable cluster logs export

Enables cluster logs export.

Authorizations:
iam_token_project_scoped
path Parameters
datastore_id
required
string

Cluster identifier.

Request Body schema: application/json
required
required
object

Export parameters of the cluster logs.

log_group
string

Responses

Request samples

Content type
application/json
{
  • "log_platform": {
    }
}

Response samples

Content type
application/json
{
  • "datastore": {
    }
}

Get cluster logs

Returns all cluster logs. Applied only for MySQL clusters.

Authorizations:
iam_token_project_scoped
path Parameters
datastore_id
required
string

Cluster identifier.

query Parameters
job
string

Filter the list result by the job.

start
string

Filter the list result by the start.

end
string

Filter the list result by the end.

limit
string

Filter the list result by the limit.

ips
string

Filter the list result by the ips.

databases
string

Filter the list result by the databases.

Responses

Response samples

Content type
application/json
{
  • "logs": {
    }
}

Get cluster metrics

Returns all metrics of the cluster.

Authorizations:
iam_token_project_scoped
path Parameters
datastore_id
required
string

Cluster identifier.

query Parameters
start
string

Filter the list result by the start.

end
string

Filter the list result by the end.

Responses

Response samples

Content type
application/json
{
  • "metrics": {
    }
}

Update cluster password

Updates cluster password. Applied only for Redis clusters.

Authorizations:
iam_token_project_scoped
path Parameters
datastore_id
required
string

Cluster identifier.

Request Body schema: application/json
required
required
object (DatastoreUpdatePassword)
redis_password
required
string [ 1 .. 255 ] characters

Cluster password.

Responses

Request samples

Content type
application/json
{
  • "password": {
    }
}

Response samples

Content type
application/json
{
  • "datastore": {
    }
}

Update cluster pooler settings

Updates cluster pooler settings.

Authorizations:
iam_token_project_scoped
path Parameters
datastore_id
required
string

Cluster identifier.

Request Body schema: application/json
required
required
object

Connection pooler settings. Available for PostgreSQL, PostgreSQL for 1C, PostgreSQL TimescaleDB.

mode
string
Enum: "session" "transaction" "statement"

Pooling mode. The default value is transaction.

size
integer [ 1 .. 500 ]

Pool size. The default value is 30. The available values are from 1 to 500.

Responses

Request samples

Content type
application/json
{
  • "pooler": {
    }
}

Response samples

Content type
application/json
{
  • "datastore": {
    }
}

Set protection mode

Enables or disables protection mode for the cluster. When enabled, the cluster cannot be deleted. Sending true enables it; sending false disables it via the same endpoint.

Authorizations:
iam_token_project_scoped
path Parameters
datastore_id
required
string

Cluster identifier.

Request Body schema: application/json
required
protection
boolean

Indicates whether the cluster is in protection mode. If true, the cluster cannot be deleted.

Responses

Request samples

Content type
application/json
{
  • "protection": true
}

Response samples

Content type
application/json
{
  • "datastore": {
    }
}

Resize cluster

Changes cluster infrastructure configuration.

Authorizations:
iam_token_project_scoped
path Parameters
datastore_id
required
string

Cluster identifier.

Request Body schema: application/json
required
required
object (DatastoreResize)
object (DatastoreResizeDisk)
object (DatastoreResizeFlavor)
flavor_id
string <UUID>

Unique identifier of the flavor for the cluster. Can be skipped when flavor is set.

node_count
integer >= 1

Number of nodes in the cluster.

Responses

Request samples

Content type
application/json
{
  • "resize": {
    }
}

Response samples

Content type
application/json
{
  • "datastore": {
    }
}

Update cluster security groups

Updates cluster security groups.

Authorizations:
iam_token_project_scoped
path Parameters
datastore_id
required
string

Cluster identifier.

Request Body schema: application/json
required
security_groups
required
Array of strings <UUID> non-empty unique [ items <UUID > ]

List of security groups for the cluster.

Responses

Request samples

Content type
application/json
{
  • "security_groups": [
    ]
}

Response samples

Content type
application/json
{
  • "datastore": {
    }
}

Cluster types

Available database engines that can be used to create a cluster (e.g., PostgreSQL, MySQL, etc.).

List cluster types

Returns a list of available cluster types.

Authorizations:
iam_token_project_scoped

Responses

Response samples

Content type
application/json
{
  • "datastore-types": [
    ]
}

Get cluster type

Returns cluster type.

Authorizations:
iam_token_project_scoped
path Parameters
datastore_type_id
required
string

Cluster type identifier.

Responses

Response samples

Content type
application/json
{
  • "datastore-type": {
    }
}

Extensions

Managing database extensions — optional features/plugins enabled per database. Provides endpoints to list used extensions, enable or disable them for a database, and inspect their version and status.

List extensions

Returns a list of extensions.

Authorizations:
iam_token_project_scoped
query Parameters
id
string

Filter the list result by the id.

project_id
string

Filter the list result by the project_id.

available_extension_id
string

Filter the list result by the available_extension_id.

datastore_id
string

Filter the list result by the datastore_id.

database_id
string

Filter the list result by the database_id.

status
string

Filter the list result by the status.

Responses

Response samples

Content type
application/json
{
  • "extensions": [
    ]
}

Create extension

Creates a new extension.

Authorizations:
iam_token_project_scoped
Request Body schema: application/json
required
required
object (ExtensionCreate)
available_extension_id
required
string <UUID>

Unique identifier of the available extension. Retrieved from the available-extensions resource.

database_id
required
string <UUID>

Unique identifier of the associated database for which the extension will be created.

datastore_id
required
string <UUID>

Unique identifier of the associated cluster for which the extension will be created.

Responses

Request samples

Content type
application/json
{
  • "extension": {
    }
}

Response samples

Content type
application/json
{
  • "extension": {
    }
}

Delete extension

Deletes an extension.

Authorizations:
iam_token_project_scoped
path Parameters
extension_id
required
string

Extension identifier.

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get extension

Returns an extension.

Authorizations:
iam_token_project_scoped
path Parameters
extension_id
required
string

Extension identifier.

Responses

Response samples

Content type
application/json
{
  • "extension": {
    }
}

Flavors

Predefined compute configurations (vCPU, RAM, disk) used for cluster nodes. Provides endpoints to list available flavors, view details for specific flavor.

List flavors

Returns a list of flavors.

Authorizations:
iam_token_project_scoped
query Parameters
id
string

Filter the list result by the id.

name
string

Filter the list result by the name.

fl_size
string

Filter the list result by the fl_size.

Responses

Response samples

Content type
application/json
{
  • "flavors": [
    ]
}

Create flavor Deprecated

Creates a new flavor.

Authorizations:
iam_token_project_scoped
Request Body schema: application/json
required
required
object (FlavorCreate)
datastore_type_ids
required
Array of strings <UUID> [ items <UUID > ]

List of cluster types that flavor should be available to. Retrieved from the datastore-type resource.

description
string

Description of the flavor.

disk
required
integer >= 0

Volume size in GB.

fl_size
required
string
Enum: "standard" "high_freq" "dedicated_host"

Type of the flavor.

object (FlavorCreateHost)
is_public
boolean
Default: true

Indicates whether the flavor is available for all customers.

name
required
string [ 1 .. 255 ] characters

Name of the flavor.

ram
required
integer >= 1

Amount of RAM in MB.

subtype
string
Enum: "STANDARD" "CPU" "MEMORY"

Subtype of the flavor.

template
string

Template to create the flavor from. This field is deprecated and has no effect.

vcpus
required
integer >= 1

Number of vCPUs.

Responses

Request samples

Content type
application/json
{
  • "flavor": {
    }
}

Response samples

Content type
application/json
{
  • "flavor": {
    }
}

Delete flavor Deprecated

Deletes a flavor.

Authorizations:
iam_token_project_scoped
path Parameters
flavor_id
required
string

Flavor identifier.

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get flavor

Returns a flavor.

Authorizations:
iam_token_project_scoped
path Parameters
flavor_id
required
string

Flavor identifier.

Responses

Response samples

Content type
application/json
{
  • "flavor": {
    }
}

Update flavor Deprecated

Updates a flavor.

Authorizations:
iam_token_project_scoped
path Parameters
flavor_id
required
string

Flavor identifier.

Request Body schema: application/json
required
object (FlavorUpdate)
description
string or null

Description of the flavor.

name
string [ 1 .. 255 ] characters

Name of the flavor.

Responses

Request samples

Content type
application/json
{
  • "flavor": {
    }
}

Response samples

Content type
application/json
{
  • "flavor": {
    }
}

Delete flavor host Deprecated

Deletes a flavor host.

Authorizations:
iam_token_project_scoped
path Parameters
flavor_id
required
string

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Update flavor host Deprecated

Updates flavor host.

Authorizations:
iam_token_project_scoped
path Parameters
flavor_id
required
string
Request Body schema: application/json
required
required
object (FlavorUpdateHost)
line
required
string [ 1 .. 255 ] characters

Flavor host line.

processor
required
string [ 1 .. 255 ] characters

Flavor host CPU model.

total_count
required
integer >= 0

Total number of flavor hosts.

Responses

Request samples

Content type
application/json
{
  • "host": {
    }
}

Response samples

Content type
application/json
{
  • "flavor": {
    }
}

Floating ips

Managing Floating IPs — externally routable addresses assignable to a node port for public access. Provides endpoints to associate or dissociate them with clusters.

Delete floating IP

Deassociates and deletes a floating IP from provided instance.

Authorizations:
iam_token_project_scoped
Request Body schema: application/json
required
required
object (FloatingIPRemove)
instance_id
required
string <UUID>

Instance identifier to disassociate floating IP from.

Responses

Request samples

Content type
application/json
{
  • "floating_ip": {
    }
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Create floating IP

Creates and associates a floating IP with provided instance.

Authorizations:
iam_token_project_scoped
Request Body schema: application/json
required
required
object (FloatingIPCreate)
instance_id
required
string <UUID>

Instance identifier to associate floating IP with.

Responses

Request samples

Content type
application/json
{
  • "floating_ip": {
    }
}

Response samples

Content type
application/json
{
  • "error": {
    }
}

Grants

Managing privileges assigned to users/roles on a database. Provides endpoints to grant or revoke permissions and to inspect current user access.

List database grants

Returns a list of database grants.

Authorizations:
iam_token_project_scoped
query Parameters
id
string

Filter the list result by the id.

project_id
string

Filter the list result by the project_id.

datastore_id
string

Filter the list result by the datastore_id.

database_id
string

Filter the list result by the database_id.

user_id
string

Filter the list result by the user_id.

status
string

Filter the list result by the status.

Responses

Response samples

Content type
application/json
{
  • "grants": [
    ]
}

Create database grant

Creates a new database grant.

Authorizations:
iam_token_project_scoped
Request Body schema: application/json
required
required
object (GrantCreate)
database_id
required
string <UUID>

Unique identifier of the associated database for which the grant will be created.

datastore_id
required
string <UUID>

Unique identifier of the associated cluster for which the grant will be created.

user_id
required
string <UUID>

Unique identifier of the associated user for which the grant was created.

Responses

Request samples

Content type
application/json
{
  • "grant": {
    }
}

Response samples

Content type
application/json
{
  • "grant": {
    }
}

Delete grant

Deletes a database grant.

Authorizations:
iam_token_project_scoped
path Parameters
grant_id
required
string

Grant identifier.

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get grant

Returns a database grant.

Authorizations:
iam_token_project_scoped
path Parameters
grant_id
required
string

Grant identifier.

Responses

Response samples

Content type
application/json
{
  • "grant": {
    }
}

Limits

Platform limits for cluster configuration, including per-cluster-type min/max bounds (vCPU, RAM, local disk) and multiplier rules.

List limits

Returns a list of cluster limits.

Authorizations:
iam_token_project_scoped

Responses

Response samples

Content type
application/json
{
  • "limits": [
    ]
}

Logical replication slots

Managing logical replication slots for PostgreSQL clusters. Provides endpoints to create, list, and drop slots, and to inspect status/current activity.

Slots retain WAL until consumed — use with care to avoid disk growth.

List logical replication slots

Returns a list of logical replication slots.

Authorizations:
iam_token_project_scoped
query Parameters
id
string

Filter the list result by the id.

project_id
string

Filter the list result by the project_id.

name
string

Filter the list result by the name.

datastore_id
string

Filter the list result by the datastore_id.

database_id
string

Filter the list result by the database_id.

status
string

Filter the list result by the status.

in_use
string

Filter the list result by the in_use.

Responses

Response samples

Content type
application/json
{
  • "logical-replication-slots": [
    ]
}

Create logical replication slot

Creates a new logical replication slot.

Authorizations:
iam_token_project_scoped
Request Body schema: application/json
required
required
object (LogicalRepplicationSlotCreate)
database_id
required
string <UUID>

Unique identifier of the associated database for which the logical replication slot will be created.

datastore_id
required
string <UUID>

Unique identifier of the associated cluster for which the logical replication slot will be created.

name
required
string [ 1 .. 255 ] characters

Name of the logical replication slot.

Responses

Request samples

Content type
application/json
{
  • "logical-replication-slot": {
    }
}

Response samples

Content type
application/json
{
  • "logical-replication-slot": {
    }
}

Delete logical replication slot

Deletes a logical replication slot.

Authorizations:
iam_token_project_scoped
path Parameters
logical_replication_slot_id
required
string

Logical replication slot identifier.

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get logical replication slot

Returns a logical replication slot.

Authorizations:
iam_token_project_scoped
path Parameters
logical_replication_slot_id
required
string

Logical replication slot identifier.

Responses

Response samples

Content type
application/json
{
  • "logical-replication-slot": {
    }
}

Prometheus metrics tokens

Managing Prometheus metrics access tokens for customer managed monitoring. Provides endpoints to issue and revoke tokens, and to view list or specific token.

List prometheus metrics tokens

Returns a list of prometheus metric tokens.

Authorizations:
iam_token_project_scoped
query Parameters
id
string

Filter the list result by the id.

project_id
string

Filter the list result by the project_id.

name
string

Filter the list result by the name.

value
string

Filter the list result by the value.

Responses

Response samples

Content type
application/json
{
  • "prometheus-metrics-tokens": [
    ]
}

Issue prometheus metrics token

Creates a new prometheus metrics token.

Authorizations:
iam_token_project_scoped
Request Body schema: application/json
required
required
object (PrometheusMetricsTokenCreate)
name
required
string [ 1 .. 255 ] characters

Name of the prometheus metrics token.

Responses

Request samples

Content type
application/json
{
  • "prometheus-metrics-token": {
    }
}

Response samples

Content type
application/json
{
  • "prometheus-metrics-token": {
    }
}

Revoke prometheus metrics token

Deletes a prometheus metrics token.

Authorizations:
iam_token_project_scoped
path Parameters
prometheus_metrics_token_id
required
string

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get prometheus metrics token resource

Returns a prometheus metrics token.

Authorizations:
iam_token_project_scoped
path Parameters
prometheus_metrics_token_id
required
string

Responses

Response samples

Content type
application/json
{
  • "prometheus-metrics-token": {
    }
}

Update prometheus metrics token

Updates prometheus metrics token parameters.

Authorizations:
iam_token_project_scoped
path Parameters
prometheus_metrics_token_id
required
string
Request Body schema: application/json
required
required
object (PrometheusMetricsTokenUpdate)
name
required
string [ 1 .. 255 ] characters

Name of the prometheus metrics token.

Responses

Request samples

Content type
application/json
{
  • "prometheus-metrics-token": {
    }
}

Response samples

Content type
application/json
{
  • "prometheus-metrics-token": {
    }
}

Quotas

Quotas are per-project resource limits used to control consumption and limit costs (e.g., clusters, vCPU, RAM, storage, etc.).

Get quota

Returns a list of project quotas.

Authorizations:
iam_token_project_scoped

Responses

Response samples

Content type
application/json
{
  • "quotas": [
    ]
}

Users

Managing database users within a cluster. Provides endpoints to create, retrieve, update, and delete users, rotate passwords.

List database users

Returns a list of database users.

Authorizations:
iam_token_project_scoped
query Parameters
id
string

Filter the list result by the id.

project_id
string

Filter the list result by the project_id.

name
string

Filter the list result by the name.

datastore_id
string

Filter the list result by the datastore_id.

status
string

Filter the list result by the status.

Responses

Response samples

Content type
application/json
{
  • "users": [
    ]
}

Create database user

Creates a new database user.

Authorizations:
iam_token_project_scoped
Request Body schema: application/json
required
required
object (UserCreate)
datastore_id
required
string <UUID>

Unique identifier of the associated cluster for which the user will be created.

name
required
string [ 1 .. 255 ] characters ^[A-Za-z_][A-Za-z0-9_]*$

Name of the user. For MySQL sync and MySQL semi-sync clusters, the username cannot exceed 32 characters. For all other cluster types, the username is limited to 63 characters.

password
required
string [ 1 .. 255 ] characters

Password for the user.

Responses

Request samples

Content type
application/json
{
  • "user": {
    }
}

Response samples

Content type
application/json
{
  • "user": {
    }
}

Delete database user

Deletes a database user.

Authorizations:
iam_token_project_scoped
path Parameters
user_id
required
string

User identifier.

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get database user

Returns a database user.

Authorizations:
iam_token_project_scoped
path Parameters
user_id
required
string

User identifier.

Responses

Response samples

Content type
application/json
{
  • "user": {
    }
}

Update database user

Updates a database user.

Authorizations:
iam_token_project_scoped
path Parameters
user_id
required
string

User identifier.

Request Body schema: application/json
required
required
object (UserUpdate)
password
required
string [ 1 .. 255 ] characters

Password for the user.

Responses

Request samples

Content type
application/json
{
  • "user": {
    }
}

Response samples

Content type
application/json
{
  • "user": {
    }
}

Topics

Managing Kafka topics — the logical streams of records. Provides endpoints to create, list, update, and delete topics.

List topics

Returns list of Kafka topics.

Authorizations:
iam_token_project_scoped
query Parameters
id
string

Filter the list result by the id.

project_id
string

Filter the list result by the project_id.

name
string

Filter the list result by the name.

datastore_id
string

Filter the list result by the datastore_id.

status
string

Filter the list result by the status.

Responses

Response samples

Content type
application/json
{
  • "topics": [
    ]
}

Create topic

Creates a new Kafka topic.

Authorizations:
iam_token_project_scoped
Request Body schema: application/json
required
required
object (TopicCreate)
datastore_id
required
string <UUID>

Unique identifier of the associated cluster for which the topic will be created.

name
required
string [ 1 .. 249 ] characters ^[a-zA-Z0-9\._\-]+$

Name of the topic.

partitions
required
integer [ 1 .. 4000 ]
Default: 1

Number of partitions for the topic. For an active topic only increasing is possible, decreasing typically requires data migration or creating a new topic.

Responses

Request samples

Content type
application/json
{
  • "topic": {
    }
}

Response samples

Content type
application/json
{
  • "topic": {
    }
}

Delete topic

Deletes a Kafka topic.

Authorizations:
iam_token_project_scoped
path Parameters
topic_id
required
string

Topic identifier.

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Get topic

Returns a Kafka topic.

Authorizations:
iam_token_project_scoped
path Parameters
topic_id
required
string

Topic identifier.

Responses

Response samples

Content type
application/json
{
  • "topic": {
    }
}

Update topic

Updates Kafka topic parameters.

Authorizations:
iam_token_project_scoped
path Parameters
topic_id
required
string

Topic identifier.

Request Body schema: application/json
required
required
object (TopicUpdate)
partitions
required
integer [ 1 .. 4000 ]
Default: 1

Number of partitions for the topic. For an active topic only increasing is possible, decreasing typically requires data migration or creating a new topic.

Responses

Request samples

Content type
application/json
{
  • "topic": {
    }
}

Response samples

Content type
application/json
{
  • "topic": {
    }
}