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 Container Custom Domain API

The Container Custom Domain API from Qovery — 4 operation(s) for container custom domain.

Qovery Container Custom Domain API is one of 94 APIs that Qovery publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Container Custom Domain. 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 6 operations across 4 paths, and defines 8 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.

6 operations 4 paths 8 schemas 1 DELETE3 GET1 POST1 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 Container Custom Domain 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 6

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

Container Custom Domain 6
GET
/container/{containerId}/customDomain
List container custom domains
listContainerCustomDomain 1 param → 200401403404
POST
/container/{containerId}/customDomain
Add custom domain to the container.
createContainerCustomDomain 1 param body → 201400401403404
PUT
/container/{containerId}/customDomain/{customDomainId}
Edit a Custom Domain
editContainerCustomDomain 2 params body → 200400401403404
DELETE
/container/{containerId}/customDomain/{customDomainId}
Delete a Custom Domain
deleteContainerCustomDomain 2 params → 204401403404
GET
/container/{containerId}/customDomain/{customDomainId}/status
Get Custom Domain status
getContainerCustomDomainStatus 2 params → 200401403404
GET
/container/{containerId}/checkCustomDomain
Check Container Custom Domain
checkContainerCustomDomain 1 param → 200401403404

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are CheckedCustomDomainResponse (3 properties), Base (3 properties), CustomDomainRequest (3 properties), CustomDomainResponseList (1 property). Each schema is shown below with its type and property counts.

CustomDomain
CheckedCustomDomainResponse
object
3 properties 2 required
CheckedCustomDomainStatus
string
This enum represents the final status for your domain. There are 2 successful statuses: RESOLVESTOIP: we succeeded to resolve an IP to your domain. This is the…
CustomDomainStatusEnum
string
CustomDomainResponseList
object
1 property
CustomDomainRequest
object
3 properties 2 required
Base
object
3 properties 2 required
CheckedCustomDomainsResponse
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qovery-container-custom-domain-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