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 Job Actions API

The Job Actions API from Qovery — 5 operation(s) for job actions.

Qovery Job Actions 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 Actions. 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 5 paths, and defines 13 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 5 paths 13 schemas 5 POST

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

Job Actions 5
POST
/job/{jobId}/deploy
Deploy job
deployJob 2 params body → 202400401403404409
POST
/job/{jobId}/uninstall
Uninstall job
uninstallJob 2 params body → 202204400401403404409
POST
/job/{jobId}/redeploy
Redeploy job
redeployJob 2 params → 202401403404409
POST
/job/{jobId}/stop
Stop job
stopJob 1 param → 202401403404409
POST
/job/{jobId}/cleanFailedJob
Clean a failed job
cleanFailedJob 1 param → 200

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are Status (10 properties), StatusDetails (3 properties), ServiceStepMetrics (3 properties), ServiceStepMetric (3 properties). Each schema is shown below with its type and property counts.

ServiceStepMetric
object
3 properties
ServiceActionStatusEnum
string
StateEnum
string
ServiceActionEnum
string
ServiceDeploymentStatusEnum
string
ServiceSubActionEnum
string
Status
object
10 properties 7 required
ServiceStepMetrics
object
3 properties 3 required
JobDeployRequest
object
2 properties
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.…
JobForceEvent
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…
StatusDetails
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qovery-job-actions-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