Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Qovery Database Main Calls API

The Database Main Calls API from Qovery — 4 operation(s) for database main calls.

Qovery Database Main Calls API is one of 94 APIs that Qovery publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Database Main Calls. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, an API reference, authentication docs, and rate-limit docs.

This API exposes 7 operations across 4 paths, and defines 35 schemas. It is described by OpenAPI 3.0.0, at version 1.0.4.

Requests are made against a single base URL, https://api.qovery.com.

7 operations 4 paths 35 schemas 1 DELETE4 GET2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.4
Base URL
https://api.qovery.com
Authentication
HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 2

Qovery Database Main Calls API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). An API key is passed in the header as Authorization (ApiKeyAuth). By default, every request must be authenticated.

  • bearerAuth — JWT tokens should be used with OIDC account (human to machine). JWT tokens used by the Qovery console to communicate with the API have a TTL. Curl Example ' cu…
  • ApiKeyAuth — Token API are generated by Qovery to manage machine to machine interaction and do not have a TTL. Curl Example ' curl https://console.qovery.com/organization -…

Paths & Operations 7

Across 4 paths, the API surfaces 7 operations — 1 DELETE, 4 GET, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Database Main Calls 7
GET
/database/{databaseId}
Get database by ID
getDatabase 1 param → 200401403404
PUT
/database/{databaseId}
Edit a database
editDatabase 1 param body → 200400401403404409
DELETE
/database/{databaseId}
Delete a database
deleteDatabase 1 param → 204401403404
GET
/database/{databaseId}/status
Get database status
getDatabaseStatus 1 param → 200401403404
GET
/database/{databaseId}/version
List eligible versions for the database
listDatabaseVersion 1 param → 200401403404
GET
/database/{databaseId}/masterCredentials
Get master credentials of the database
getDatabaseMasterCredentials 1 param → 200401403404
PUT
/database/{databaseId}/masterCredentials
Edit database master credentials
editDatabaseCredentials 1 param body → 200400401403404

Schemas 35

The contract defines 35 schemas that model the data the API accepts and returns. The most detailed are DatabaseRequest (13 properties), DatabaseEditRequest (12 properties), Status (10 properties), Credentials (4 properties). Each schema is shown below with its type and property counts.

ReferenceObject
object
1 property 1 required
Credentials
object
4 properties 4 required
DatabaseModeEnum
string
ServiceLabelRequest
object
1 property 1 required
VersionResponseList
object
1 property
OrganizationAnnotationsGroupScopeEnum
string
Annotations Group Scope
ServiceAnnotationsRequestList
array
DatabaseAccessibilityEnum
string
OrganizationLabelsGroupResponse
ServiceAnnotationRequest
object
1 property 1 required
DatabaseTypeEnum
string
ServiceTypeEnum
string
type of the service (application, database, job, ...)
OrganizationAnnotationsGroupResponse
StepMetricStatusEnum
string
The status of completion for the step: - SUCCESS: The step completed successfully. - ERROR: The step completed with an error. - CANCEL: The step was canceled.…
Label
object
3 properties 3 required
ServiceSubActionEnum
string
ServiceLabelsRequestList
array
DatabaseRequest
object
13 properties 4 required
DatabaseEditRequest
object
12 properties
OrganizationLabelsGroupResponseList
array
ServiceStepMetric
object
3 properties
Version
object
1 property 1 required
Database
Annotation
object
2 properties 2 required
ServiceDeploymentStatusEnum
string
ServiceStepMetricNameEnum
string
The name of the deployment step at the service level: - REGISTRYCREATEREPOSITORY: The step to create the repository in the registry. - GITCLONE: The step to cl…
ServiceStepMetrics
object
3 properties 3 required
ServiceActionEnum
string
StateEnum
string
OrganizationAnnotationsGroupResponseList
array
Status
object
10 properties 7 required
CredentialsRequest
object
2 properties 2 required
ServiceActionStatusEnum
string
Base
object
3 properties 2 required
StatusDetails
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qovery-database-main-calls-api-openapi.yml Raw ↑

Other APIs Qovery publishes across the network.

Qovery Account Info API
Qovery Alert Receivers API
Qovery Alert Rules API
Qovery Application Actions API
Qovery Application Configuration API
Qovery Application Custom Domain API
Qovery Application Deployment History API
Qovery Application Deployment Restriction API
Qovery Application Environment Variable API
Qovery Application Logs API
Qovery Application Main Calls API
Qovery Application Secret API