A Managed Database is a database-as-a-service that lets customers use a database without setting up servers or database software. The service configuration defines high availability, resources, the database software version, and security parameters.
The Managed Database API lets you manage instances of supported open-source engines, including MySQL, PostgreSQL, Valkey, and OpenSearch. Managed Databases are available in every UpCloud zone. All request and response payloads are JSON.
List database types
Returns a list of available database types. Contains available plans, zones, database versions supported and the configuration properties for each database.
List database types › Responses
OK
nameThe name of the service type
descriptionThe description of the service type
latest_available_versionThe latest available version of the service type
Get database type
Returns database type details by given {database_type}. Contains available plans, zones, database versions supported and configuration properties.
path Parameters
service-type-nameService type parameter
The type of service.
Get database type › Responses
OK
nameThe name of the service type
descriptionThe description of the service type
latest_available_versionThe latest available version of the service type
List databases
Returns a list of all available Managed Database services. Depending on their database type, Managed Databases services will have different details.
query Parameters
limitNumber of entries to receive at most.
Schema for a query parameter specifying the maximum number of entries to return (limit).
offsetOffset for retrieved results.
Schema for a query parameter specifying the offset for pagination.
sortSort results by the specified field. Prefix with '-' for descending order. Supported fields: created_at, name (service hostname), operational_state (service status), zone (location).
Schema for a query parameter specifying the sort field and direction. Prefix with '-' for descending order.
List databases › Responses
OK
Schema for a list of service information
uuidThe unique identifier for the service.
zoneThe zone where the service is hosted.
nameThe name of the service.
titleThe title of the service.
typeThe type of the service.
planThe plan of the service.
additional_disk_space_gibThe additional disk space allocated to the service in GiB.
stateThe current state of the service.
A map of errors related to the service state.
poweredIndicates whether the service is powered on.
termination_protectionIndicates whether termination protection is enabled for the service.
node_countThe number of nodes in the service.
create_timeThe time when the service was created.
update_timeThe time when the service was last updated.
service_uriThe URI for accessing the service.
A map of connection parameters for the service.
Schema for a maintenance window response.
A map of metadata key-value pairs for the service.
A map of additional properties for the service.
List of network information details associated with the service.
The states of individual nodes in the service.
List of label information associated with the service.
List of backups associated with the service.
List of service components associated with the service.
List of connection pools associated with the service.
List of users associated with the service.
A list of logical databases.
List of ACLs associated with the service.
List of service integrations associated with the service.
Create database
Creates a new Managed Database instance. New databases are started by default. An initial backup is created automatically on startup and the API will be fully functional only after this backup has been created. The creation might take a while. Note that different databases have different properties that can be passed on creation.
Create database › Request Body
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object | |
| type = object | |
| type = object | |
| type = object | |
| type = object |
admin_password^[a-zA-Z0-9-_]+$admin_username^[_A-Za-z0-9][-._A-Z…automatic_utility_network_ip_filterAutomatically allow connections from servers in the utility network within the same zone
backup_hourbackup_minutebinlog_retention_periodconnect_timeoutThe number of seconds that the mysqld server waits for a connect packet before responding with Bad handshake
default_time_zone^([-+][\d:]*|[\w/]*)…Default server time zone as an offset from UTC (from -12:00 to +12:00), a time zone name, or 'SYSTEM' to use the MySQL server default.
group_concat_max_lenThe maximum permitted result length in bytes for the GROUP_CONCAT() function.
information_schema_stats_expiryThe time, in seconds, before cached statistics expire
innodb_change_buffer_max_sizeMaximum size for the InnoDB change buffer, as a percentage of the total size of the buffer pool. Default is 25
innodb_flush_neighborsSpecifies whether flushing a page from the InnoDB buffer pool also flushes other dirty pages in the same extent (default is 1): 0 - dirty pages in the same extent are not flushed, 1 - flush contiguous dirty pages in the same extent, 2 - flush dirty pages in the same extent
innodb_ft_min_token_sizeMinimum length of words that are stored in an InnoDB FULLTEXT index. Changing this parameter will lead to a restart of the MySQL service.
innodb_ft_server_stopword_table^.+/.+$This option is used to specify your own InnoDB FULLTEXT index stopword list for all InnoDB tables.
innodb_lock_wait_timeoutThe length of time in seconds an InnoDB transaction waits for a row lock before giving up. Default is 120.
innodb_log_buffer_sizeThe size in bytes of the buffer that InnoDB uses to write to the log files on disk.
innodb_online_alter_log_max_sizeThe upper limit in bytes on the size of the temporary log files used during online DDL operations for InnoDB tables.
innodb_print_all_deadlocksWhen enabled, information about all deadlocks in InnoDB user transactions is recorded in the error log. Disabled by default.
innodb_read_io_threadsThe number of I/O threads for read operations in InnoDB. Default is 4. Changing this parameter will lead to a restart of the MySQL service.
innodb_rollback_on_timeoutWhen enabled a transaction timeout causes InnoDB to abort and roll back the entire transaction. Changing this parameter will lead to a restart of the MySQL service.
innodb_thread_concurrencyDefines the maximum number of threads permitted inside of InnoDB. Default is 0 (infinite concurrency - no limit)
innodb_write_io_threadsThe number of I/O threads for write operations in InnoDB. Default is 4. Changing this parameter will lead to a restart of the MySQL service.
interactive_timeoutThe number of seconds the server waits for activity on an interactive connection before closing it.
internal_tmp_mem_storage_engineThe storage engine for in-memory internal temporary tables.
ip_filterAllow incoming connections from CIDR address block, e.g. '10.20.0.0/16'
log_outputThe slow log output destination when slow_query_log is ON. To enable MySQL AI Insights, choose INSIGHTS. To use MySQL AI Insights and the mysql.slow_log table at the same time, choose INSIGHTS,TABLE. To only use the mysql.slow_log table, choose TABLE. To silence slow logs, choose NONE.
long_query_timeThe slow_query_logs work as SQL statements that take more than long_query_time seconds to execute.
lower_case_table_namesSets how table and database names are stored and compared. 0 = case-sensitive (default), 1 = names stored lowercase, comparisons are case-insensitive. This option can only be set when creating the service and cannot be changed later. See https://dev.mysql.com/doc/refman/8.0/en/identifier-case-sensitivity.html for details.
max_allowed_packetSize of the largest message in bytes that can be received by the server. Default is 67108864 (64M)
max_heap_table_sizeLimits the size of internal in-memory tables. Also set tmp_table_size. Default is 16777216 (16M)
migrationnet_buffer_lengthStart sizes of connection buffer and result buffer. Default is 16384 (16K). Changing this parameter will lead to a restart of the MySQL service.
net_read_timeoutThe number of seconds to wait for more data from a connection before aborting the read.
net_write_timeoutThe number of seconds to wait for a block to be written to a connection before aborting the write.
performance_schema_events_statements_history_sizeThe number of rows per thread in the events_statements_history table. Changing this parameter will lead to a restart of the MySQL service.
public_accessAllow access to the service from the public Internet
public_access_prometheusAllow access to Prometheus metrics from the public Internet
relay_log_space_limitThe maximum amount of space in bytes to use for all relay logs while replicating from an external migration source. When the limit is reached, the replication I/O thread stops fetching relay log events until the SQL thread has caught up. Raise this to give a large migration a bigger relay-log budget; ensure the service disk is sized accordingly. The setting applies only on the node replicating from the external source; standby nodes always use the UpCloud-managed default (the smaller of 5 GiB and 30% of the service disk), which is also used when this option is left unset. Changing this parameter will lead to a restart of the MySQL service.
service_logStore logs for the service so that they are available in the HTTP API and console.
slow_query_logSlow query log enables capturing of slow queries. Setting slow_query_log to false also truncates the mysql.slow_log table.
sort_buffer_sizeSort buffer size in bytes for ORDER BY optimization. Default is 262144 (256K)
sql_mode^[A-Z_]*(,[A-Z_]+)*$Global SQL mode. Set to empty to use MySQL server defaults. When creating a new service and not setting this field UpCloud default SQL mode (strict, SQL standard compliant) will be assigned.
sql_require_primary_keyRequire primary key to be defined for new tables or old tables modified with ALTER TABLE and fail if missing. It is recommended to always have primary keys because various functionality may break if any large table is missing them.
tmp_table_sizeLimits the size of internal in-memory tables. Also set max_heap_table_size. Default is 16777216 (16M)
versionwait_timeoutThe number of seconds the server waits for activity on a noninteractive connection before closing it.
Create database › Responses
Created
uuidThe unique identifier for the service.
zoneThe zone where the service is hosted.
nameThe name of the service.
titleThe title of the service.
typeThe type of the service.
planThe plan of the service.
additional_disk_space_gibThe additional disk space allocated to the service in GiB.
stateThe current state of the service.
A map of errors related to the service state.
poweredIndicates whether the service is powered on.
termination_protectionIndicates whether termination protection is enabled for the service.
node_countThe number of nodes in the service.
create_timeThe time when the service was created.
update_timeThe time when the service was last updated.
service_uriThe URI for accessing the service.
A map of connection parameters for the service.
Schema for a maintenance window response.
A map of metadata key-value pairs for the service.
A map of additional properties for the service.
List of network information details associated with the service.
The states of individual nodes in the service.
List of label information associated with the service.
List of backups associated with the service.
List of service components associated with the service.
List of connection pools associated with the service.
List of users associated with the service.
A list of logical databases.
List of ACLs associated with the service.
List of service integrations associated with the service.
Get database
Returns details of a Managed Database service by its {uuid}.
path Parameters
uuidService UUID
The unique identifier for the integration.
Get database › Responses
OK
uuidThe unique identifier for the service.
zoneThe zone where the service is hosted.
nameThe name of the service.
titleThe title of the service.
typeThe type of the service.
planThe plan of the service.
additional_disk_space_gibThe additional disk space allocated to the service in GiB.
stateThe current state of the service.
A map of errors related to the service state.
poweredIndicates whether the service is powered on.
termination_protectionIndicates whether termination protection is enabled for the service.
node_countThe number of nodes in the service.
create_timeThe time when the service was created.
update_timeThe time when the service was last updated.
service_uriThe URI for accessing the service.
A map of connection parameters for the service.
Schema for a maintenance window response.
A map of metadata key-value pairs for the service.
A map of additional properties for the service.
List of network information details associated with the service.
The states of individual nodes in the service.
List of label information associated with the service.
List of backups associated with the service.
List of service components associated with the service.
List of connection pools associated with the service.
List of users associated with the service.
A list of logical databases.
List of ACLs associated with the service.
List of service integrations associated with the service.
Delete database
Deletes a specified Managed Database. All data will be erased and lost, including backups. If the service is not powered off, it will be powered off before deletion. The state of the service can be anything.
path Parameters
uuidService UUID
The unique identifier for the integration.
Delete database › Responses
No Content
Modify database
Modifies Managed Database service details by its {uuid} including upgrading plans, migration to other zones and database type-specific configurations.
path Parameters
uuidService UUID
The unique identifier for the integration.
Modify database › Request Body
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object | |
| type = object | |
| type = object | |
| type = object | |
| type = object |
admin_password^[a-zA-Z0-9-_]+$admin_username^[_A-Za-z0-9][-._A-Z…automatic_utility_network_ip_filterAutomatically allow connections from servers in the utility network within the same zone
backup_hourbackup_minutebinlog_retention_periodconnect_timeoutThe number of seconds that the mysqld server waits for a connect packet before responding with Bad handshake
default_time_zone^([-+][\d:]*|[\w/]*)…Default server time zone as an offset from UTC (from -12:00 to +12:00), a time zone name, or 'SYSTEM' to use the MySQL server default.
group_concat_max_lenThe maximum permitted result length in bytes for the GROUP_CONCAT() function.
information_schema_stats_expiryThe time, in seconds, before cached statistics expire
innodb_change_buffer_max_sizeMaximum size for the InnoDB change buffer, as a percentage of the total size of the buffer pool. Default is 25
innodb_flush_neighborsSpecifies whether flushing a page from the InnoDB buffer pool also flushes other dirty pages in the same extent (default is 1): 0 - dirty pages in the same extent are not flushed, 1 - flush contiguous dirty pages in the same extent, 2 - flush dirty pages in the same extent
innodb_ft_min_token_sizeMinimum length of words that are stored in an InnoDB FULLTEXT index. Changing this parameter will lead to a restart of the MySQL service.
innodb_ft_server_stopword_table^.+/.+$This option is used to specify your own InnoDB FULLTEXT index stopword list for all InnoDB tables.
innodb_lock_wait_timeoutThe length of time in seconds an InnoDB transaction waits for a row lock before giving up. Default is 120.
innodb_log_buffer_sizeThe size in bytes of the buffer that InnoDB uses to write to the log files on disk.
innodb_online_alter_log_max_sizeThe upper limit in bytes on the size of the temporary log files used during online DDL operations for InnoDB tables.
innodb_print_all_deadlocksWhen enabled, information about all deadlocks in InnoDB user transactions is recorded in the error log. Disabled by default.
innodb_read_io_threadsThe number of I/O threads for read operations in InnoDB. Default is 4. Changing this parameter will lead to a restart of the MySQL service.
innodb_rollback_on_timeoutWhen enabled a transaction timeout causes InnoDB to abort and roll back the entire transaction. Changing this parameter will lead to a restart of the MySQL service.
innodb_thread_concurrencyDefines the maximum number of threads permitted inside of InnoDB. Default is 0 (infinite concurrency - no limit)
innodb_write_io_threadsThe number of I/O threads for write operations in InnoDB. Default is 4. Changing this parameter will lead to a restart of the MySQL service.
interactive_timeoutThe number of seconds the server waits for activity on an interactive connection before closing it.
internal_tmp_mem_storage_engineThe storage engine for in-memory internal temporary tables.
ip_filterAllow incoming connections from CIDR address block, e.g. '10.20.0.0/16'
log_outputThe slow log output destination when slow_query_log is ON. To enable MySQL AI Insights, choose INSIGHTS. To use MySQL AI Insights and the mysql.slow_log table at the same time, choose INSIGHTS,TABLE. To only use the mysql.slow_log table, choose TABLE. To silence slow logs, choose NONE.
long_query_timeThe slow_query_logs work as SQL statements that take more than long_query_time seconds to execute.
lower_case_table_namesSets how table and database names are stored and compared. 0 = case-sensitive (default), 1 = names stored lowercase, comparisons are case-insensitive. This option can only be set when creating the service and cannot be changed later. See https://dev.mysql.com/doc/refman/8.0/en/identifier-case-sensitivity.html for details.
max_allowed_packetSize of the largest message in bytes that can be received by the server. Default is 67108864 (64M)
max_heap_table_sizeLimits the size of internal in-memory tables. Also set tmp_table_size. Default is 16777216 (16M)
migrationnet_buffer_lengthStart sizes of connection buffer and result buffer. Default is 16384 (16K). Changing this parameter will lead to a restart of the MySQL service.
net_read_timeoutThe number of seconds to wait for more data from a connection before aborting the read.
net_write_timeoutThe number of seconds to wait for a block to be written to a connection before aborting the write.
performance_schema_events_statements_history_sizeThe number of rows per thread in the events_statements_history table. Changing this parameter will lead to a restart of the MySQL service.
public_accessAllow access to the service from the public Internet
public_access_prometheusAllow access to Prometheus metrics from the public Internet
relay_log_space_limitThe maximum amount of space in bytes to use for all relay logs while replicating from an external migration source. When the limit is reached, the replication I/O thread stops fetching relay log events until the SQL thread has caught up. Raise this to give a large migration a bigger relay-log budget; ensure the service disk is sized accordingly. The setting applies only on the node replicating from the external source; standby nodes always use the UpCloud-managed default (the smaller of 5 GiB and 30% of the service disk), which is also used when this option is left unset. Changing this parameter will lead to a restart of the MySQL service.
service_logStore logs for the service so that they are available in the HTTP API and console.
slow_query_logSlow query log enables capturing of slow queries. Setting slow_query_log to false also truncates the mysql.slow_log table.
sort_buffer_sizeSort buffer size in bytes for ORDER BY optimization. Default is 262144 (256K)
sql_mode^[A-Z_]*(,[A-Z_]+)*$Global SQL mode. Set to empty to use MySQL server defaults. When creating a new service and not setting this field UpCloud default SQL mode (strict, SQL standard compliant) will be assigned.
sql_require_primary_keyRequire primary key to be defined for new tables or old tables modified with ALTER TABLE and fail if missing. It is recommended to always have primary keys because various functionality may break if any large table is missing them.
tmp_table_sizeLimits the size of internal in-memory tables. Also set max_heap_table_size. Default is 16777216 (16M)
versionwait_timeoutThe number of seconds the server waits for activity on a noninteractive connection before closing it.
Modify database › Responses
OK
uuidThe unique identifier for the service.
zoneThe zone where the service is hosted.
nameThe name of the service.
titleThe title of the service.
typeThe type of the service.
planThe plan of the service.
additional_disk_space_gibThe additional disk space allocated to the service in GiB.
stateThe current state of the service.
A map of errors related to the service state.
poweredIndicates whether the service is powered on.
termination_protectionIndicates whether termination protection is enabled for the service.
node_countThe number of nodes in the service.
create_timeThe time when the service was created.
update_timeThe time when the service was last updated.
service_uriThe URI for accessing the service.
A map of connection parameters for the service.
Schema for a maintenance window response.
A map of metadata key-value pairs for the service.
A map of additional properties for the service.
List of network information details associated with the service.
The states of individual nodes in the service.
List of label information associated with the service.
List of backups associated with the service.
List of service components associated with the service.
List of connection pools associated with the service.
List of users associated with the service.
A list of logical databases.
List of ACLs associated with the service.
List of service integrations associated with the service.
Modify database type
Update a service's type by the given {service-uuid}.
path Parameters
uuidService UUID
The unique identifier for the integration.
Modify database type › Request Body
target_typeService type
Modify database type › Responses
OK
uuidThe unique identifier for the service.
zoneThe zone where the service is hosted.
nameThe name of the service.
titleThe title of the service.
typeThe type of the service.
planThe plan of the service.
additional_disk_space_gibThe additional disk space allocated to the service in GiB.
stateThe current state of the service.
A map of errors related to the service state.
poweredIndicates whether the service is powered on.
termination_protectionIndicates whether termination protection is enabled for the service.
node_countThe number of nodes in the service.
create_timeThe time when the service was created.
update_timeThe time when the service was last updated.
service_uriThe URI for accessing the service.
A map of connection parameters for the service.
Schema for a maintenance window response.
A map of metadata key-value pairs for the service.
A map of additional properties for the service.
List of network information details associated with the service.
The states of individual nodes in the service.
List of label information associated with the service.
List of backups associated with the service.
List of service components associated with the service.
List of connection pools associated with the service.
List of users associated with the service.
A list of logical databases.
List of ACLs associated with the service.
List of service integrations associated with the service.
Clone database
Creates a clone of a Managed Database service based on its {uuid}. It is possible to change location, plans and use the point in time feature to clone your service at a specific time using your backups.
path Parameters
uuidService UUID
The unique identifier for the integration.
Clone database › Request Body
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · requires: hostname_prefix | |
| type = object · requires: hostname_prefix | |
| type = object · requires: hostname_prefix | |
| type = object · requires: hostname_prefix | |
| type = object · requires: hostname_prefix |
hostname_prefixHostname prefix
planPlan
titleThe title of an entity.
clone_timeClone time
backup_name^[a-zA-Z0-9-_:.]+$Backup name
set_service_uuidTitle
zone^[a-z]{2}-[a-z]{3}\d…Zone
termination_protectionTermination protection
Maintenance
Networks
Labels
additional_disk_space_gibAdditional disk space in GiB
mysql properties
Clone database › Responses
Created
uuidThe unique identifier for the service.
zoneThe zone where the service is hosted.
nameThe name of the service.
titleThe title of the service.
typeThe type of the service.
planThe plan of the service.
additional_disk_space_gibThe additional disk space allocated to the service in GiB.
stateThe current state of the service.
A map of errors related to the service state.
poweredIndicates whether the service is powered on.
termination_protectionIndicates whether termination protection is enabled for the service.
node_countThe number of nodes in the service.
create_timeThe time when the service was created.
update_timeThe time when the service was last updated.
service_uriThe URI for accessing the service.
A map of connection parameters for the service.
Schema for a maintenance window response.
A map of metadata key-value pairs for the service.
A map of additional properties for the service.
List of network information details associated with the service.
The states of individual nodes in the service.
List of label information associated with the service.
List of backups associated with the service.
List of service components associated with the service.
List of connection pools associated with the service.
List of users associated with the service.
A list of logical databases.
List of ACLs associated with the service.
List of service integrations associated with the service.
List networks
Returns a list of attached SDN networks to a Managed Database service by its {uuid}.
path Parameters
uuidService UUID
The unique identifier for the integration.
List networks › Responses
OK
Schema for networks information response
uuidUnique identifier for the network
nameName of the network
familyAddress family (e.g., IPv4, IPv6)
typeType of network (e.g., private, public)
create_timeTimestamp when the network was created
update_timeTimestamp when the network was last updated
Create network
Attaches an SDN network to a Managed Database service by its {uuid}.
path Parameters
uuidService UUID
The unique identifier for the integration.
Create network › Request Body
name^[a-zA-Z0-9_-]+$ · requiredThe name of the network.
typeThe type of network.
familyThe network protocol family.
uuidOptional UUID for the network. If not provided, a new UUID will be generated.
Create network › Responses
Created
uuidUnique identifier for the network
nameName of the network
familyAddress family (e.g., IPv4, IPv6)
typeType of network (e.g., private, public)
create_timeTimestamp when the network was created
update_timeTimestamp when the network was last updated
Get network
Returns the attached SDN network details to service by its {uuid} and {network_name}.
path Parameters
uuidService UUID
The unique identifier for the integration.
network-nameNetwork UUID
The unique identifier for the integration.
Get network › Responses
OK
uuidUnique identifier for the network
nameName of the network
familyAddress family (e.g., IPv4, IPv6)
typeType of network (e.g., private, public)
create_timeTimestamp when the network was created
update_timeTimestamp when the network was last updated
Delete network
Detaches an existing SDN network from a Managed Database service by its {uuid} and {network_name}.
path Parameters
uuidService UUID
The unique identifier for the integration.
network-nameNetwork UUID
The unique identifier for the integration.
Delete network › Responses
No Content
Upgrade database
Upgrades your PostgreSQL Managed Database service database to a newer major version. Downgrades are not permitted.
path Parameters
uuidService UUID
The unique identifier for the integration.
Upgrade database › Request Body
target_versionVersion to upgrade the service
Upgrade database › Responses
Created
uuidThe unique identifier for the service.
zoneThe zone where the service is hosted.
nameThe name of the service.
titleThe title of the service.
typeThe type of the service.
planThe plan of the service.
additional_disk_space_gibThe additional disk space allocated to the service in GiB.
stateThe current state of the service.
A map of errors related to the service state.
poweredIndicates whether the service is powered on.
termination_protectionIndicates whether termination protection is enabled for the service.
node_countThe number of nodes in the service.
create_timeThe time when the service was created.
update_timeThe time when the service was last updated.
service_uriThe URI for accessing the service.
A map of connection parameters for the service.
Schema for a maintenance window response.
A map of metadata key-value pairs for the service.
A map of additional properties for the service.
List of network information details associated with the service.
The states of individual nodes in the service.
List of label information associated with the service.
List of backups associated with the service.
List of service components associated with the service.
List of connection pools associated with the service.
List of users associated with the service.
A list of logical databases.
List of ACLs associated with the service.
List of service integrations associated with the service.
List labels
Returns a list of available service labels by given {service_uuid}.
path Parameters
uuidService UUID
The unique identifier for the integration.
List labels › Responses
OK
Schema for a list of labels.
keyThe key of the label to delete.
valueThe value of the label to delete.
Create label
Creates a new label by given {service_uuid}. Labels used for service filtering.
path Parameters
uuidService UUID
The unique identifier for the integration.
Create label › Request Body
key^[\x20-\x5E\x60-\x7E… · requiredThe key of a label.
value\A[\p{L}\p{N}\p{P}\p… · requiredThe value of a label.
Create label › Responses
Created
keyThe key of the label to delete.
valueThe value of the label to delete.
Get label
Returns label details by given {service_uuid} and {key}.
path Parameters
uuidService UUID
The unique identifier for the integration.
label-key^[\x20-\x5E\x60-\x7E… · requiredLabel ID
The key of a label.
Get label › Responses
OK
keyThe key of the label to delete.
valueThe value of the label to delete.
Delete label
Deletes existing label by given {service_uuid} and {key}.
path Parameters
uuidService UUID
The unique identifier for the integration.
label-key^[\x20-\x5E\x60-\x7E… · requiredLabel ID
The key of a label.
Delete label › Responses
No Content
Modify label
Modifies existing label by given {service_uuid} and {key}.
path Parameters
uuidService UUID
The unique identifier for the integration.
label-key^[\x20-\x5E\x60-\x7E… · requiredLabel ID
The key of a label.
Modify label › Request Body
key^[\x20-\x5E\x60-\x7E…The key of a label.
value\A[\p{L}\p{N}\p{P}\p…The value of a label.
Modify label › Responses
OK
keyThe key of the label to delete.
valueThe value of the label to delete.
Get available extensions
Returns a list of available PostgreSQL extensions for the Managed Database service by its {service-uuid}. Only supported for PostgreSQL services.
path Parameters
uuidService UUID
The unique identifier for the integration.
Get available extensions › Responses
OK
Response schema for listing available PostgreSQL extensions
default_versionThe default version of the extension
nameThe name of the PostgreSQL extension
versionsList of available versions for this extension
Get available PostgreSQL extensions
Returns a list of available PostgreSQL extensions grouped by PostgreSQL version.
Get available PostgreSQL extensions › Responses
OK
Response schema for listing available PostgreSQL extensions grouped by version
versionThe PostgreSQL major version
List of available extensions for this PostgreSQL version
Get database type versions
Returns a list of supported Managed Database service versions.
Get database type versions › Responses
OK
Response schema for listing available service versions across all service types
major_versionThe major version of the service
service_typeThe type of service (e.g., mysql, pg, opensearch, valkey)
stateThe availability state of the version
end_of_life_timeThe date when this version reaches end of life
availability_end_timeThe date when this version will no longer be available for new services
availability_start_timeThe date when this version became available
termination_timeThe date when services running this version will be terminated
upgrade_to_service_typeThe service type to upgrade to when this version reaches end of life
upgrade_to_versionThe version to upgrade to when this version reaches end of life
upstream_end_of_life_timeThe upstream end of life date for this version
Get access controls (OpenSearch)
Return access controls settings for the OpenSearch Managed Database service {uuid}.
path Parameters
uuidService UUID
The unique identifier for the integration.
Get access controls (OpenSearch) › Responses
OK
access_controlIf true, access control is enabled for the cluster.
extended_access_controlIf true, extended access control features are enabled.
Modify access controls (OpenSearch)
Modifies the user {username} access control for the Managed Database service {uuid}.
path Parameters
uuidService UUID
The unique identifier for the integration.
Modify access controls (OpenSearch) › Request Body
access_controlEnables OpenSearch access control
extended_access_controlEnables OpenSearch extended access control
Modify access controls (OpenSearch) › Responses
OK
access_controlIf true, access control is enabled for the cluster.
extended_access_controlIf true, extended access control features are enabled.
Get Security management status (OpenSearch)
Returns Security management status for the OpenSearch Managed Database service {uuid}.
path Parameters
uuidService UUID
The unique identifier for the integration.
Get Security management status (OpenSearch) › Responses
OK
security_plugin_admin_enabledIndicates if the security plugin admin is enabled
security_plugin_availableIndicates if the security plugin is available
security_plugin_enabledIndicates if the security plugin is enabled
Modify Security management admin password (OpenSearch)
Modifies Security management admin password for the OpenSearch Managed Database service {uuid}.
path Parameters
uuidService UUID
The unique identifier for the integration.
Modify Security management admin password (OpenSearch) › Request Body
admin_passwordCurrent admin password
new_passwordNew admin password
Modify Security management admin password (OpenSearch) › Responses
OK
security_plugin_admin_enabledIndicates if the security plugin admin is enabled
security_plugin_availableIndicates if the security plugin is available
security_plugin_enabledIndicates if the security plugin is enabled
Enable Security management admin (OpenSearch)
Enables Security management admin for the OpenSearch Managed Database service {uuid}.
path Parameters
uuidService UUID
The unique identifier for the integration.
Enable Security management admin (OpenSearch) › Request Body
admin_passwordSecurity admin password
Enable Security management admin (OpenSearch) › Responses
Created
security_plugin_admin_enabledIndicates if the security plugin admin is enabled
security_plugin_availableIndicates if the security plugin is available
security_plugin_enabledIndicates if the security plugin is enabled
List integration endpoints
Returns a list of available integration endpoints.
List integration endpoints › Responses
OK
Schema for a list of integration endpoints.
uuidThe universally unique identifier (UUID) of the integration endpoint.
nameThe name of the integration endpoint.
typeThe type of the integration endpoint.
A key-value map of properties specific to the integration endpoint type.
Create integration endpoint
Creates a new integration endpoint.
Create integration endpoint › Request Body
typeThe type of integration endpoint.
nameThe name of the integration endpoint.
propertiesA key-value map of properties specific to the integration endpoint type.
Create integration endpoint › Responses
Created
uuidThe universally unique identifier (UUID) of the integration endpoint.
nameThe name of the integration endpoint.
typeThe type of the integration endpoint.
A key-value map of properties specific to the integration endpoint type.
Get integration endpoint
Returns integration endpoint details by given {integration-uuid}.
path Parameters
integration-uuidIntegration UUID
The unique identifier for the service.
Get integration endpoint › Responses
OK
uuidThe universally unique identifier (UUID) of the integration endpoint.
nameThe name of the integration endpoint.
typeThe type of the integration endpoint.
A key-value map of properties specific to the integration endpoint type.
Delete integration endpoint
Deletes existing integration endpoint by given {integration-uuid}.
path Parameters
integration-uuidIntegration UUID
The unique identifier for the service.
Delete integration endpoint › Responses
No Content
Modify integration endpoint
Modifies existing integration endpoint by given {integration-uuid}.
path Parameters
integration-uuidIntegration UUID
The unique identifier for the service.
Modify integration endpoint › Responses
OK
uuidThe universally unique identifier (UUID) of the integration endpoint.
nameThe name of the integration endpoint.
typeThe type of the integration endpoint.
A key-value map of properties specific to the integration endpoint type.
Get account CA certificate
Returns the CA certificate. Every customer main account has a private Certificate Authority (CA) that signs certificates for internal use. Managed Database service types, such as PostgreSQL, use it for external connections. To access these services, you must download and configure the certificate on your browser or client.
Get account CA certificate › Responses
List all alerts
Returns all the alerts associated with your Managed Database services.
List all alerts › Responses
OK
Schema for a project alerts
create_timeTimestamp when the alert was created
eventEvent type for the alert
uuidUnique identifier for the alert
titleOptional title of the alert
service_typeService type related to the alert
severitySeverity of the alert
Get database status
Get a service's status by the given {service-uuid}.
path Parameters
uuidService UUID
The unique identifier for the integration.
Get database status › Responses
OK
stateThe service status indicates the service's current operational status.
Get database versions
Returns available versions of the Managed Database service by its {uuid}.
path Parameters
uuidService UUID
The unique identifier for the integration.
Get database versions › Responses
OK
Schema for representing available service versions
Start manual maintenance
Start maintenance updates for your Managed Database service if any updates are pending.
path Parameters
uuidService UUID
The unique identifier for the integration.
Start manual maintenance › Responses
OK
A list of error messages returned by UpCloud's API.
messageThe time the backup was created.
Enable temporary writes
Enable temporary writes by the given {service-uuid}.
path Parameters
uuidService UUID
The unique identifier for the integration.
Enable temporary writes › Responses
Created
A list of error messages returned by UpCloud's API.
messageThe time the backup was created.
Get database migration status
Returns details about the migration progress over time of a Managed database service by its {uuid}.
path Parameters
uuidService UUID
The unique identifier for the integration.
Get database migration status › Responses
OK
errorError message if any
methodMigration method used
seconds_behind_masterSeconds behind master
source_activeIs source active
statusCurrent status of the migration
Get database alerts
Returns alerts for Managed Database service identified by {uuid}.
path Parameters
uuidService UUID
The unique identifier for the integration.
Get database alerts › Responses
OK
Schema for service alerts response
create_timeThe time when the alert was created.
eventA brief description of the alert event.
service_typeThe type of service associated with the alert.
severityThe severity level of the alert.
Get database metrics
Returns metrics related to a Managed Database service by its {uuid} and query parameter {period}.
path Parameters
uuidService UUID
The unique identifier for the integration.
Get database metrics › Responses
OK
Schema for metrics data response.
Additional hints or metadata about the metric data.
Get query statistics (MySQL / PostgreSQL)
Returns a list of query statistics for the Managed Database service by its {uuid} and optional query parameters {limit}, {offset} and {order}. Query statistics will differ depending on the database type.
path Parameters
uuidService UUID
The unique identifier for the integration.
query Parameters
limitNumber of entries to receive at most.
Schema for a query parameter specifying the maximum number of entries to return (limit).
offsetOffset for retrieved results.
Schema for a query parameter specifying the offset for pagination.
orderSort order
Schema for a query parameter specifying the order.
Get query statistics (MySQL / PostgreSQL) › Responses
OK
List logs
Returns Managed Database service system-level logs by its {uuid} and optional query parameters {limit}, {offset} and {order}.
path Parameters
uuidService UUID
The unique identifier for the integration.
query Parameters
limitNumber of entries to receive at most.
Schema for a query parameter specifying the maximum number of entries to return (limit).
offsetOffset for retrieved results.
Schema for a query parameter specifying the offset for pagination.
orderSort order
Schema for a query parameter specifying the order.
List logs › Responses
OK
first_log_offsetOffset of the first log entry in the list.
offsetCurrent offset for pagination.
Array of log entries from UpCloud services.
List connection pools
Returns a list of available connection pools for a Managed Database service. Connection pools are available only for PostgreSQL database services.
path Parameters
uuidService UUID
The unique identifier for the integration.
query Parameters
Order of returned results.
Schema for a query parameter specifying the order.
List connection pools › Responses
OK
An array of connection pool response objects.
connection_uriThe connection URI of the connection pool.
databaseThe database name associated with the connection pool.
pool_modeThe mode of the connection pool.
pool_nameThe name of the connection pool.
pool_sizeThe size of the connection pool.
usernameThe username for the connection pool
Create connection pool
Creates a connection pool for the Managed Database service {uuid}. Connection pool endpoints are for PostgreSQL Managed Databases only.
path Parameters
uuidService UUID
The unique identifier for the integration.
Create connection pool › Request Body
databaseDatabase
pool_modeConnection Pool mode
pool_nameConnection Pool name
pool_sizeConnection Pool size
usernameConnection Pool username
Create connection pool › Responses
Created
connection_uriThe connection URI of the connection pool.
databaseThe database name associated with the connection pool.
pool_modeThe mode of the connection pool.
pool_nameThe name of the connection pool.
pool_sizeThe size of the connection pool.
usernameThe username for the connection pool
Get connection pool
Returns the connection pool {pool-name} details for the Managed Database service {uuid}.
path Parameters
uuidService UUID
The unique identifier for the integration.
pool-nameConnection Pool Name
The title of an entity.
Get connection pool › Responses
OK
connection_uriThe connection URI of the connection pool.
databaseThe database name associated with the connection pool.
pool_modeThe mode of the connection pool.
pool_nameThe name of the connection pool.
pool_sizeThe size of the connection pool.
usernameThe username for the connection pool
Delete connection pool
Deletes the connection pool {pool-name} for the Managed Database service {uuid}.
path Parameters
uuidService UUID
The unique identifier for the integration.
pool-nameConnection Pool Name
The title of an entity.
Delete connection pool › Responses
No Content
Modify connection pool
Modifies the connection pool {pool-name} for the Managed Database service {uuid}.
path Parameters
uuidService UUID
The unique identifier for the integration.
pool-nameConnection Pool Name
The title of an entity.
Modify connection pool › Request Body
databaseDatabase
pool_modeConnection Pool mode
pool_sizeConnection Pool size
usernameConnection Pool username
Modify connection pool › Responses
OK
connection_uriThe connection URI of the connection pool.
databaseThe database name associated with the connection pool.
pool_modeThe mode of the connection pool.
pool_nameThe name of the connection pool.
pool_sizeThe size of the connection pool.
usernameThe username for the connection pool
List indices (OpenSearch)
Returns a list of available indices for a Managed Database service {uuid}.
path Parameters
uuidService UUID
The unique identifier for the integration.
List indices (OpenSearch) › Responses
OK
Response schema for indexes
create_timeCreation time of the index.
docsNumber of documents in the index.
healthHealth status of the index.
index_nameName of the index.
number_of_replicasNumber of replicas for the index.
number_of_shardsNumber of shards for the index.
read_only_allow_deleteIndicates if the index is read-only and allows deletion.
sizeSize of the index in bytes.
statusStatus of the index.
Delete index (OpenSearch)
Deletes the index {index_name} for the Managed Database service {uuid}.
path Parameters
uuidService UUID
The unique identifier for the integration.
index-nameOpenSearch Index Name
The title of an entity.
Delete index (OpenSearch) › Responses
No Content
List integrations
Returns a list of available service integrations by given {service-uuid}.
path Parameters
uuidService UUID
The unique identifier for the integration.
List integrations › Responses
OK
Schema for a list of service integrations
uuidThe UUID of the service integration.
typeThe type of service integration.
source_nameThe name of the source service.
source_uuidThe UUID of the source service.
destination_nameThe name of the destination service.
destination_uuidThe UUID of the destination service.
stateThe current state of the service integration.
A list of errors related to the service integration state.
The states of individual nodes in the service integration.
A map of additional properties for the service integration.
Create integration
Creates a new integration by given {service-uuid}.
path Parameters
uuidService UUID
The unique identifier for the integration.
Create integration › Request Body
typeThe type of service integration.
destination_uuidThe UUID of the destination where the service integration will send data.
propertiesCreate integration › Responses
Created
uuidThe UUID of the service integration.
typeThe type of service integration.
source_nameThe name of the source service.
source_uuidThe UUID of the source service.
destination_nameThe name of the destination service.
destination_uuidThe UUID of the destination service.
stateThe current state of the service integration.
A list of errors related to the service integration state.
The states of individual nodes in the service integration.
A map of additional properties for the service integration.
Get integration
Returns integration details by given {service-uuid} and {integration-uuid}.
path Parameters
uuidService UUID
The unique identifier for the integration.
integration-uuidIntegration UUID
The unique identifier for the service.
Get integration › Responses
OK
uuidThe UUID of the service integration.
typeThe type of service integration.
source_nameThe name of the source service.
source_uuidThe UUID of the source service.
destination_nameThe name of the destination service.
destination_uuidThe UUID of the destination service.
stateThe current state of the service integration.
A list of errors related to the service integration state.
The states of individual nodes in the service integration.
A map of additional properties for the service integration.
Delete integration
Deletes existing integration by given {service-uuid} and {integration-uuid}.
path Parameters
uuidService UUID
The unique identifier for the integration.
integration-uuidIntegration UUID
The unique identifier for the service.
Delete integration › Responses
No Content
Modify integration
Modifies existing integration by given {service-uuid} and {integration-uuid}.
path Parameters
uuidService UUID
The unique identifier for the integration.
integration-uuidIntegration UUID
The unique identifier for the service.
Modify integration › Responses
OK
uuidThe UUID of the service integration.
typeThe type of service integration.
source_nameThe name of the source service.
source_uuidThe UUID of the source service.
destination_nameThe name of the destination service.
destination_uuidThe UUID of the destination service.
stateThe current state of the service integration.
A list of errors related to the service integration state.
The states of individual nodes in the service integration.
A map of additional properties for the service integration.
List logical databases
Returns a list of logical databases for a Managed Database service identified by {uuid}.
path Parameters
uuidService UUID
The unique identifier for the integration.
List logical databases › Responses
OK
A list of logical databases.
nameThe name of the logical database.
lc_collateThe LC_COLLATE setting of the logical database.
lc_ctypeThe LC_CTYPE setting of the logical database.
Create logical database
Creates a new logical database for the Managed Database service {uuid}.
path Parameters
uuidService UUID
The unique identifier for the integration.
Create logical database › Request Body
namelogical database name
lc_collateCollation order
lc_ctypeCategory of a locale definition source file
Create logical database › Responses
Created
nameThe name of the logical database.
lc_collateThe LC_COLLATE setting of the logical database.
lc_ctypeThe LC_CTYPE setting of the logical database.
Delete logical database
Deletes the logical database {database_name} from the Managed Database service {uuid}.
path Parameters
uuidService UUID
The unique identifier for the integration.
database-nameDatabase name
The title of an entity.
Delete logical database › Responses
No Content
Get service peerings status
Returns networks peering status for a service by its {uuid}. Only available for services using SDN private networks.
path Parameters
uuidService UUID
The unique identifier for the integration.
Get service peerings status › Responses
OK
create_timeThe creation time of the service network.
update_timeThe last update time of the service network.
stateThe current state of the service network.
List sessions
Returns a list of current sessions details for your Managed Database service by its {uuid} and optional query parameters {limit}, {offset} and {order}.
path Parameters
uuidService UUID
The unique identifier for the integration.
query Parameters
limitNumber of entries to receive at most.
Schema for a query parameter specifying the maximum number of entries to return (limit).
offsetOffset for retrieved results.
Schema for a query parameter specifying the offset for pagination.
orderSort order
Schema for a query parameter specifying the order.
List sessions › Responses
OK
Terminate session
Terminates a sessions or kills a running query for a Managed Database service by its {uuid}, session {pid} and optional query parameter {terminate}.
path Parameters
uuidService UUID
The unique identifier for the integration.
pidSession PID
The unique identifier for the integration.
Terminate session › Responses
OK
successIndicates whether the session termination was successful.
Create task
Creates a task that checks for potential errors before starting a migration or upgrade for a Managed Database service by its {uuid}.
path Parameters
uuidService UUID
The unique identifier for the integration.
Create task › Request Body
operationThe operation to be performed.
target_versionThe target version for upgrade operations.
Create task › Responses
Created
create_timeThe time when the service task was created
resultOptional result message
Optional list of result codes as key-value maps
ignore_dbsOptional list of databases to ignore
operationThe operation being performed
successIndicates if the operation was successful
methodOptional method used for the operation
source_pg_versionOptional source PostgreSQL version
target_pg_versionOptional target PostgreSQL version
idOptional identifier for the task
Get task
Returns task details of a Managed Database service by its {uuid} and the task {id} obtained from Create Managed Database task.
path Parameters
uuidService UUID
The unique identifier for the integration.
task-idTask ID
The unique identifier for the integration.
Get task › Responses
OK
create_timeThe time when the service task was created
resultOptional result message
Optional list of result codes as key-value maps
ignore_dbsOptional list of databases to ignore
operationThe operation being performed
successIndicates if the operation was successful
methodOptional method used for the operation
source_pg_versionOptional source PostgreSQL version
target_pg_versionOptional target PostgreSQL version
idOptional identifier for the task
List users
Returns a list of database users associated with the Managed Database service {uuid}.
path Parameters
uuidService UUID
The unique identifier for the integration.
List users › Responses
OK
Schema for the response containing a list of users
usernameThe username of the user.
passwordThe password of the user.
authenticationThe authentication method used by the user.
typeThe type of the user.
Schema for PostgreSQL access control response.
Schema for Redis access control response.
Schema for Valkey user access control response
Schema for OpenSearch access control response.
Create user
Creates a new user for the Managed Database service {uuid}.
path Parameters
uuidService UUID
The unique identifier for the integration.
Create user › Request Body
usernameThe username of the service user
passwordThe password of the service user
authenticationThe authentication method for the service user
Redis access control settings
PostgreSQL access control settings
OpenSearch access control settings
Valkey access control settings
Create user › Responses
Created
usernameThe username of the user.
passwordThe password of the user.
authenticationThe authentication method used by the user.
typeThe type of the user.
Schema for PostgreSQL access control response.
Schema for Redis access control response.
Schema for Valkey user access control response
Schema for OpenSearch access control response.
Get user
Returns the user {username} details for the Managed Database service {uuid}.
path Parameters
uuidService UUID
The unique identifier for the integration.
usernameUsername identifier
The title of an entity.
Get user › Responses
OK
usernameThe username of the user.
passwordThe password of the user.
authenticationThe authentication method used by the user.
typeThe type of the user.
Schema for PostgreSQL access control response.
Schema for Redis access control response.
Schema for Valkey user access control response
Schema for OpenSearch access control response.
Delete user
Deletes the user {username} from the Managed Database service {uuid}.
path Parameters
uuidService UUID
The unique identifier for the integration.
usernameUsername identifier
The title of an entity.
Delete user › Responses
No Content
Modify user
Modifies the user {username} details for the Managed Database service {uuid}.
path Parameters
uuidService UUID
The unique identifier for the integration.
usernameUsername identifier
The title of an entity.
Modify user › Request Body
passwordNew password for the service user
authenticationAuthentication method for the service user
Modify user › Responses
OK
usernameThe username of the user.
passwordThe password of the user.
authenticationThe authentication method used by the user.
typeThe type of the user.
Schema for PostgreSQL access control response.
Schema for Redis access control response.
Schema for Valkey user access control response
Schema for OpenSearch access control response.
Modify user access control
Return access controls settings for the OpenSearch Managed Database service {uuid}.
path Parameters
uuidService UUID
The unique identifier for the integration.
usernameUsername identifier
The title of an entity.
Modify user access control › Request Body
Redis ACL modification schema
PostgreSQL replication permission modification schema
OpenSearch index permission modification schema
Valkey ACL modification schema
Modify user access control › Responses
OK
usernameThe username of the user.
passwordThe password of the user.
authenticationThe authentication method used by the user.
typeThe type of the user.
Schema for PostgreSQL access control response.
Schema for Redis access control response.
Schema for Valkey user access control response
Schema for OpenSearch access control response.