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 Main Calls API

The Container Main Calls API from Qovery — 3 operation(s) for container main calls.

Qovery Container 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 Container 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 5 operations across 3 paths, and defines 51 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.

5 operations 3 paths 51 schemas 1 DELETE3 GET1 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 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 5

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

Container Main Calls 5
GET
/container/{containerId}
Get container by ID
getContainer 1 param → 200401403404
PUT
/container/{containerId}
Edit container
editContainer 1 param body → 200400401403404409
DELETE
/container/{containerId}
Delete container
deleteContainer 1 param → 204401403404
GET
/container/{containerId}/status
Get container status
getContainerStatus 1 param → 200401403404
GET
/container/{containerId}/link
List all URLs of the container
listContainerLinks 1 param → 200401403404

Schemas 51

The contract defines 51 schemas that model the data the API accepts and returns. The most detailed are Status (10 properties), ServicePort (9 properties), Link (7 properties), Probe (6 properties). Each schema is shown below with its type and property counts.

ReferenceObject
object
1 property 1 required
ServicePortResponseList
array
Link
object
7 properties 7 required
ServiceLabelRequest
object
1 property 1 required
ServiceStorage
object
1 property
ContainerRegistryProviderDetailsResponse
object
4 properties 4 required
OrganizationAnnotationsGroupScopeEnum
string
Annotations Group Scope
ServiceAnnotationsRequestList
array
KedaAutoscalingResponse
KedaScalerRole
string
ContainerResponse
OrganizationLabelsGroupResponse
StorageTypeEnum
string
Healthcheck
object
2 properties
ServiceAnnotationRequest
object
1 property 1 required
ContainerSource
object
4 properties 3 required
ServiceTypeEnum
string
type of the service (application, database, job, ...)
KedaAutoscalingRequest
object
4 properties 2 required
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
LinkResponseList
object
1 property
Probe
object
6 properties
ServiceSubActionEnum
string
KedaScalerRequest
object
6 properties 2 required
PortProtocolEnum
string
KedaTriggerAuthenticationRequest
object
2 properties 1 required
ServiceLabelsRequestList
array
KedaTriggerAuthenticationResponse
OrganizationLabelsGroupResponseList
array
ServiceStepMetric
object
3 properties
ContainerRegistryKindEnum
string
The type of your container registry
Annotation
object
2 properties 2 required
AutoscalingPolicyResponse
ServiceDeploymentStatusEnum
string
KedaScalerResponse
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
ContainerRequest
AutoscalingPolicyRequest
AutoscalingMode
string
ServicePortRequest
object
1 property
StateEnum
string
ServiceStorageRequest
object
1 property
ServicePort
object
9 properties 4 required
OrganizationAnnotationsGroupResponseList
array
Status
object
10 properties 7 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-container-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