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 Application API

The Database Application API from Qovery — 2 operation(s) for database application.

Qovery Database Application 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 Application. 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 2 operations across 2 paths, and defines 28 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.

2 operations 2 paths 28 schemas 1 DELETE1 GET

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 Application 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 2

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

Database Application 2
GET
/database/{databaseId}/application
List applications using the database
listDatabaseApplication 1 param → 200401403404
DELETE
/database/{databaseId}/application/{targetApplicationId}
Remove an application from this database
removeApplicationFromDatabase 2 params → 204401403404

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are ApplicationGitRepository (13 properties), ServicePort (9 properties), Probe (6 properties), Base (3 properties). Each schema is shown below with its type and property counts.

ReferenceObject
object
1 property 1 required
ServicePortResponseList
array
GitProviderEnum
string
ServiceStorage
object
1 property
OrganizationAnnotationsGroupScopeEnum
string
Annotations Group Scope
KedaAutoscalingResponse
BuildModeEnum
string
DOCKER requires dockerfilepath
Application
KedaScalerRole
string
OrganizationLabelsGroupResponse
ApplicationGitRepository
object
13 properties 4 required
StorageTypeEnum
string
Healthcheck
object
2 properties
ServiceTypeEnum
string
type of the service (application, database, job, ...)
OrganizationAnnotationsGroupResponse
Label
object
3 properties 3 required
Probe
object
6 properties
ApplicationResponseList
object
1 property
PortProtocolEnum
string
KedaTriggerAuthenticationResponse
OrganizationLabelsGroupResponseList
array
Annotation
object
2 properties 2 required
AutoscalingPolicyResponse
KedaScalerResponse
AutoscalingMode
string
ServicePort
object
9 properties 4 required
OrganizationAnnotationsGroupResponseList
array
Base
object
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qovery-database-application-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