UpCloud Database API
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.
UpCloud Database API is one of 29 APIs that UpCloud publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Database. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 70 operations across 47 paths, and defines 128 schemas. It is described by OpenAPI 3.2.0, at version 1.3.
Requests are made against a single base URL, https://api.upcloud.com.
70 operations
47 paths
128 schemas
10 DELETE36 GET9 PATCH13 POST2 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
UpCloud Database API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (apiToken).
By default, every request must be authenticated.
apiToken— UpCloud API uses HTTP Bearer authentication. An API token is required to authenticate. The API token can be created in the UpCloud control panel. Alternatively…
Paths & Operations 70
Across 47 paths, the API surfaces 70 operations — 10 DELETE, 36 GET, 9 PATCH, 13 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
Database 70
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 availabili…
GET
/1.3/database/service-types
List database types
GET
/1.3/database/plans
List database plans
GET
/1.3/database/service-types/{service-type-name}
Get database type
GET
/1.3/database
List databases
POST
/1.3/database
Create database
GET
/1.3/database/{uuid}
Get database
DELETE
/1.3/database/{uuid}
Delete database
PATCH
/1.3/database/{uuid}
Modify database
PATCH
/1.3/database/{uuid}/service-type
Modify database type
POST
/1.3/database/{uuid}/clone
Clone database
GET
/1.3/database/{uuid}/networks
List networks
POST
/1.3/database/{uuid}/networks
Create network
GET
/1.3/database/{uuid}/networks/{network-name}
Get network
DELETE
/1.3/database/{uuid}/networks/{network-name}
Delete network
POST
/1.3/database/{uuid}/upgrade
Upgrade database
GET
/1.3/database/{uuid}/labels
List labels
POST
/1.3/database/{uuid}/labels
Create label
GET
/1.3/database/{uuid}/labels/{label-key}
Get label
DELETE
/1.3/database/{uuid}/labels/{label-key}
Delete label
PATCH
/1.3/database/{uuid}/labels/{label-key}
Modify label
GET
/1.3/database/{uuid}/available-extensions
Get available extensions
GET
/1.3/database/pg/available-extensions
Get available PostgreSQL extensions
GET
/1.3/database/versions
Get database type versions
GET
/1.3/database/{uuid}/access-control
Get access controls (OpenSearch)
PATCH
/1.3/database/{uuid}/access-control
Modify access controls (OpenSearch)
GET
/1.3/database/{uuid}/security
Get Security management status (OpenSearch)
PUT
/1.3/database/{uuid}/security/admin
Modify Security management admin password (OpenSearch)
POST
/1.3/database/{uuid}/security/admin
Enable Security management admin (OpenSearch)
GET
/1.3/database/integration-endpoints
List integration endpoints
POST
/1.3/database/integration-endpoints
Create integration endpoint
GET
/1.3/database/integration-endpoints/{integration-uuid}
Get integration endpoint
DELETE
/1.3/database/integration-endpoints/{integration-uuid}
Delete integration endpoint
PATCH
/1.3/database/integration-endpoints/{integration-uuid}
Modify integration endpoint
GET
/1.3/database/certificate
Get account CA certificate
GET
/1.3/database/alerts
List all alerts
GET
/1.3/database/{uuid}/status
Get database status
GET
/1.3/database/{uuid}/versions
Get database versions
PUT
/1.3/database/{uuid}/start-maintenance
Start manual maintenance
POST
/1.3/database/{uuid}/enable-writes
Enable temporary writes
GET
/1.3/database/{uuid}/migration-status
Get database migration status
GET
/1.3/database/{uuid}/alerts
Get database alerts
GET
/1.3/database/{uuid}/metrics
Get database metrics
GET
/1.3/database/{uuid}/query-statistics
Get query statistics (MySQL / PostgreSQL)
GET
/1.3/database/{uuid}/logs
List logs
GET
/1.3/database/{uuid}/connection-pools
List connection pools
POST
/1.3/database/{uuid}/connection-pools
Create connection pool
GET
/1.3/database/{uuid}/connection-pools/{pool-name}
Get connection pool
DELETE
/1.3/database/{uuid}/connection-pools/{pool-name}
Delete connection pool
PATCH
/1.3/database/{uuid}/connection-pools/{pool-name}
Modify connection pool
GET
/1.3/database/{uuid}/indices
List indices (OpenSearch)
DELETE
/1.3/database/{uuid}/indices/{index-name}
Delete index (OpenSearch)
GET
/1.3/database/{uuid}/integrations
List integrations
POST
/1.3/database/{uuid}/integrations
Create integration
GET
/1.3/database/{uuid}/integrations/{integration-uuid}
Get integration
DELETE
/1.3/database/{uuid}/integrations/{integration-uuid}
Delete integration
PATCH
/1.3/database/{uuid}/integrations/{integration-uuid}
Modify integration
GET
/1.3/database/{uuid}/databases
List logical databases
POST
/1.3/database/{uuid}/databases
Create logical database
DELETE
/1.3/database/{uuid}/databases/{database-name}
Delete logical database
GET
/1.3/database/{uuid}/peering-status
Get service peerings status
GET
/1.3/database/{uuid}/sessions
List sessions
DELETE
/1.3/database/{uuid}/sessions/{pid}
Terminate session
POST
/1.3/database/{uuid}/tasks
Create task
GET
/1.3/database/{uuid}/tasks/{task-id}
Get task
GET
/1.3/database/{uuid}/users
List users
POST
/1.3/database/{uuid}/users
Create user
GET
/1.3/database/{uuid}/users/{username}
Get user
DELETE
/1.3/database/{uuid}/users/{username}
Delete user
PATCH
/1.3/database/{uuid}/users/{username}
Modify user
PATCH
/1.3/database/{uuid}/users/{username}/access-control
Modify user access control
Schemas 128
The contract defines 128 schemas that model the data the API accepts and returns. The most detailed are databaseServicePropertiesPg (84 properties), databaseServicePropertiesOpensearch (81 properties), databaseServicePropertiesMysql (68 properties), databaseQueryStatisticsMysqlResponse (35 properties). Each schema is shown below with its type and property counts.
databaseProjectAlertResponse
object
Schema for a project alert response
6 properties
databaseAclResponse
object
Response schema for an Access Control List (ACL) entry.
4 properties
databaseServiceAclModify
object
Schema for modifying service access control settings.
2 properties
databaseServiceAlertsResponse
array
Schema for service alerts response
databaseServiceCreateOpenAPI
object
Schema for creating a service — OpenAPI version.
17 properties
4 required
databaseLogEntryResponse
object
Schema representing a log entry from an UpCloud service.
4 properties
databaseServiceMigrationStatusResponse
object
Response schema for service migration status
6 properties
databaseServiceInformationResponse
object
Schema for service information response.
30 properties
databaseServiceVersionsResponse
array
Schema for representing available service versions
databaseServiceSecurityEnable
object
Schema for enabling security on a service instance
1 property
1 required
databaseLabelValue
string
The value of a label.
databaseNodeProgressUpdatesResponse
array
Response schema for node progress updates
databaseLabelKey
string
The key of a label.
databasePropertySchemaResponse
object
Schema definition for a single property
21 properties
databasePlansResponse
object
Lists available componentised database plans.
1 property
1 required
databaseNetworksInformationResponse
array
Schema for networks information response
LogicalDatabasesResponse
array
A list of logical databases.
databaseIntegrationEndpointResponse
object
Schema for an integration endpoint response.
4 properties
databaseQueryStatisticsMysqlResponse
object
Schema for MySQL query statistics response.
35 properties
databaseAvailableServiceTypesResponse
object
Response map schema for available service types
databaseServiceCloneOpenAPI
object
Schema for cloning a service — OpenAPI version.
6 properties
databaseIntegrationNodeStateResponse
object
Schema for representing the state of an integration node
4 properties
databaseServiceCloneRedis
object
Schema for cloning a Redis service.
16 properties
1 required
databaseMysqlCurrentSessionResponse
object
Schema for the current session of a MySQL service.
8 properties
databaseRedisAccessControlResponse
object
Schema for Redis access control response.
4 properties
databaseMetricsItemResponse
object
Schema for a single metrics item response.
2 properties
databaseMaintenancePendingUpdatesResponse
object
Response schema for pending maintenance updates.
4 properties
databaseServiceTaskCreate
object
Schema for creating a service task with various operations such as dataset import and migration checks.
5 properties
1 required
databaseMetricsColumnHeaderResponse
object
Schema for a metrics column header response.
2 properties
databaseVersionsResponse
array
Response schema for listing available service versions across all service types
databaseMaintenanceDow
string
Day of the week for maintenance window
databaseConnectionPoolModify
object
Schema for modifying a connection pool.
4 properties
databaseValkeyAccessControlResponse
object
Schema for Valkey user access control response
4 properties
databaseServiceTypeModify
object
Schema for modifying the service type
1 property
1 required
databasePGAvailableExtensionsResponse
array
Response schema for listing available PostgreSQL extensions grouped by version
databaseQueryParamSort
string
Schema for a query parameter specifying the sort field and direction. Prefix with '-' for descending order.
databaseServiceNetworkDetailsResponse
object
Schema for service network details response
4 properties
databaseQueryParamOffset
integer
Schema for a query parameter specifying the offset for pagination.
databaseConnectionPoolResponse
object
Schema for a connection pool response.
6 properties
databaseConnectionPoolCreate
object
Schema for creating a connection pool.
5 properties
4 required
databaseServicePlanResponse
object
Schema definition for a service plan
13 properties
databaseServiceTaskDetailsResponse
object
Response schema for retrieving detailed information about a specific service task, including result codes and success status.
databaseDependencyResponse
object
a dependency definition
1 property
databaseServiceIntegrationsResponse
array
Schema for a list of service integrations
databasePeeringStatusResponse
object
Schema for peering status response.
5 properties
databaseServiceIntegrationResponse
object
Schema for a service integration response.
10 properties
databaseOpenSearchAccessControlRuleResponse
object
Schema for OpenSearch access control rule response.
2 properties
databaseQueryParamOrder
string
Schema for a query parameter specifying the order.
databaseServiceCloneOpensearch
object
Schema for cloning an OpenSearch service
17 properties
1 required
databasePgCurrentSessionResponse
object
Schema for PostgreSQL current session response.
21 properties
databaseUpCloudApiResponse
object
Schema for UpCloud API error responses.
2 properties
databaseTitle
string
The title of an entity.
databaseNodeProgressUpdateResponse
object
Schema for node progress update response.
6 properties
databaseServiceUserCreate
object
Schema for creating a service user with access control settings
7 properties
1 required
databaseServiceTaskBaseResponse
object
Schema for representing a service task response
10 properties
databaseNetworkInformationDetailsResponse
object
Schema for network information response details
6 properties
databaseServiceType
string
The type of service.
databaseServiceIntegrationCreate
object
Schema for creating a service integration.
3 properties
1 required
databaseIntegrationEndpointCreate
object
Schema for creating an integration endpoint.
3 properties
2 required
databaseNetworkFamily
string
The network protocol family.
databaseServiceComponentResponse
object
Schema for a service component response.
6 properties
databaseNodeStateResponse
object
Schema for the state of a node in a service.
4 properties
databaseOpenSearchAccessControlResponse
object
Schema for OpenSearch access control response.
1 property
databaseLabelCreate
object
Schema for creating a label with a key and value.
2 properties
2 required
databaseBackupConfigResponse
object
General backup configuration schema
3 properties
databaseLabelInformationResponse
object
Schema representing a label with a key and value.
2 properties
databaseAvailableExtensionsResponse
array
Response schema for listing available PostgreSQL extensions
databasePlanComponentsResponse
object
Structured breakdown of a service plan into compute, storage and backups components. Sizes are expressed in GB to match plan naming; the classic MB/MiB fields…
3 properties
databaseIndexesResponse
array
Response schema for indexes
databaseServiceCloneMysql
object
Schema for cloning a MySQL service
17 properties
1 required
databaseMigrationStatusDetailsResponse
object
Schema for migration status details response.
4 properties
databaseServicePropertiesOpensearch
object
opensearch properties
81 properties
databaseServiceStatusResponse
object
Schema for representing the status of a service instance.
1 property
databaseId
integer
The unique identifier for the integration.
databaseNetworkCreate
object
Schema for creating a network.
4 properties
3 required
databaseServiceSecurityModify
object
Schema for modifying service security settings
2 properties
2 required
databaseMaintenanceWindowResponse
object
Schema for a maintenance window response.
3 properties
databaseQueryParamLimit
integer
Schema for a query parameter specifying the maximum number of entries to return (limit).
databasePgAccessControlResponse
object
Schema for PostgreSQL access control response.
1 property
databaseErrorResponse
object
Schema for error responses from the API.
1 property
databaseZoneInfoResponse
object
Schema for representing a Zone
1 property
databaseMaintenanceTime
string
Time of day for maintenance window in HH:MM:SS format
databaseUuid
string
The unique identifier for the integration.
databaseNetworkType
string
The type of network.
databaseServiceTypeResponse
object
Response schema for available service types
6 properties
LogicalDatabaseResponse
object
Schema for a logical database response.
3 properties
databaseIndexResponse
object
Schema representing the details of an index.
9 properties
databaseIntegrationUUID
string
The unique identifier for the service.
databaseQueryStatisticsPgResponse
object
Schema for PostgreSQL query statistics response.
22 properties
databaseServiceIntegrationModify
object
Schema for modifying a service integration.
1 property
databaseServiceModifyOpenAPI
object
Schema for modifying a service — OpenAPI version.
15 properties
databaseLabelsResponse
array
Schema for a list of labels.
databaseServiceClonePg
object
Schema for cloning a PostgreSQL service.
17 properties
1 required
databaseServicePropertiesPg
object
pg properties
84 properties
databaseBackupConfigOpenSearchResponse
object
OpenSearch specific backup configuration response
5 properties
databaseServiceTaskResponse
object
Response schema for retrieving information about a service task, including the operation type.
databaseBackupResponse
object
Schema for a backup response.
3 properties
databaseNetworkName
string
The name of the network.
databaseLabelModify
object
Schema for modifying a label with a key and/or value.
2 properties
databaseLabelResponse
object
Schema for deleting a label with a key and value.
2 properties
databaseUsersResponse
array
Schema for the response containing a list of users
databaseServiceAlertResponse
object
Schema for a service alert
4 properties
databaseQueryStatisticsResponse
object
Schema for query statistics response.
2 properties
databaseLogListResponse
object
Schema representing a paginated list of log entries from UpCloud services.
3 properties
databaseServicePropertiesRedis
object
redis properties
20 properties
databaseServiceIntegration
string
The type of service integration.
databaseAccessControlSettingsResponse
object
Response schema for access control settings of a cluster.
2 properties
databaseServiceUserAclModify
object
Schema for modifying user access control lists (ACL) for various services
4 properties
databaseServicePropertiesValkey
object
valkey properties
25 properties
databaseRedisValkeyCurrentSessionResponse
object
Schema for Redis Valkey current session response.
17 properties
databaseOpenSearchSecurityPluginStatusResponse
object
OpenSearch security plugin status response
3 properties
databaseServiceInformationListResponse
array
Schema for a list of service information
databaseMetricsRowDataResponse
array
Array of objects representing a row of metrics data - can be any format.
databaseServicePropertiesMysql
object
mysql properties
68 properties
databaseIntegrationEndpointModify
object
Schema for modifying an integration endpoint.
1 property
databaseServiceCloneValkey
object
Schema for cloning a service with valkey.
16 properties
1 required
databaseUserResponse
object
Schema for a user response.
8 properties
LogicalDatabaseCreate
object
Schema for creating a logical database.
3 properties
1 required
databaseMetricsDataResponse
object
Schema for metrics data response.
2 properties
databaseCurrentSessionsResponse
object
Schema for representing current sessions for various services
4 properties
databaseServiceUserModify
object
Schema for modifying a service user
2 properties
databaseIntegrationEndpoint
string
The type of integration endpoint.
databaseServiceUpgrade
object
Schema for upgrading the service version
1 property
1 required
databaseMetricsResponse
object
Schema for metrics response.
databaseAccountCaResponse
object
Response schema for account CA
1 property
databaseConnectionPoolsResponse
array
An array of connection pool response objects.
databaseIntegrationEndpointsResponse
array
Schema for a list of integration endpoints.
databaseProjectAlertsResponse
array
Schema for a project alerts
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from UpCloud 12
Other APIs UpCloud publishes across the network.
UpCloud Account API
UpCloud Account Tokens API
UpCloud Audit Logs API
UpCloud Currency API
UpCloud Device API
UpCloud Events API
UpCloud File Storage API
UpCloud Firewall Ruleset API
UpCloud Gateway API
UpCloud Ip Address API
UpCloud Kubernetes API
UpCloud Load Balancer API
#Database
Where this information came from
This is an independent, third-party profile of UpCloud Database API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.