How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Qovery Jobs API

The Jobs API from Qovery — 5 operation(s) for jobs.

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

Tagged areas include Job. 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 5 paths, and defines 47 schemas. It is described by OpenAPI 3.2.0, at version 1.0.4.

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

6 operations 5 paths 47 schemas 3 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 2

Qovery Jobs 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 5 paths, the API surfaces 6 operations — 3 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Jobs 6
POST
/organization/{organizationId}/job/deploy
Auto deploy jobs
autoDeployJobEnvironments 1 param body → 202400401403404409
GET
/defaultJobAdvancedSettings
List default job advanced settings
getDefaultJobAdvancedSettings → 200401403
GET
/environment/{environmentId}/job
List jobs
listJobs 2 params → 200401403404
POST
/environment/{environmentId}/job
Create a job
createJob 1 param body → 201400401403404409
GET
/environment/{environmentId}/job/status
List all environment job statuses
getEnvironmentJobStatus 1 param → 200401403404
POST
/job/{jobId}/clone
Clone job
cloneJob 1 param body → 202401403404409

Schemas 47

The contract defines 47 schemas that model the data the API accepts and returns. The most detailed are JobAdvancedSettings (13 properties), ApplicationGitRepository (13 properties), Status (10 properties), Probe (6 properties). Each schema is shown below with its type and property counts.

ServiceLabelsRequestList
array
ReferenceObject
object
1 property 1 required
JobAdvancedSettings
object
13 properties
JobResponseList
object
1 property
OrganizationAnnotationsGroupScopeEnum
string
Annotations Group Scope
ContainerRegistryProviderDetailsResponse
object
4 properties 4 required
ServiceTypeEnum
string
type of the service (application, database, job, ...)
ApplicationGitRepository
object
13 properties 4 required
ContainerRegistryKindEnum
string
The type of your container registry
JobSourceDockerResponse
object
4 properties
OrganizationLabelsGroupResponseList
array
Healthcheck
object
2 properties
Base
object
3 properties 2 required
Probe
objectnull
6 properties
JobTypeEnum
string
type of job
JobLifecycleTypeEnum
Label
object
3 properties 3 required
ServiceActionEnum
string
JobRequest
object
ApplicationGitRepositoryRequest
object
5 properties 4 required
ServiceSubActionEnum
string
ServiceActionStatusEnum
string
OrganizationAnnotationsGroupResponseList
array
ServiceLabelRequest
object
1 property 1 required
JobResponse
OrganizationLabelsGroupResponse
StatusDetails
object
3 properties 3 required
ServiceStepMetrics
object
3 properties 3 required
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…
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.…
GitProviderEnum
string
ReferenceObjectStatus
Annotation
object
2 properties 2 required
ServiceDeploymentStatusEnum
string
ServiceStepMetric
object
3 properties
ServiceAnnotationRequest
object
1 property 1 required
CronJobResponse
Status
object
10 properties 7 required
StateEnum
string
CloneServiceRequest
object
2 properties 2 required
LifecycleJobResponse
OrganizationJobAutoDeployRequest
object
2 properties
OrganizationAnnotationsGroupResponse
BaseJobResponse
ContainerSource
object
4 properties 3 required
ReferenceObjectStatusResponseList
object
1 property
ServiceAnnotationsRequestList
array

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qovery-jobs-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
Where this information came from

This is an independent, third-party profile of Qovery Jobs 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.