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 Deployment Restriction API

The Job Deployment Restriction API from Qovery — 2 operation(s) for job deployment restriction.

Qovery Job Deployment Restriction 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 Deployment Restriction. 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 4 operations across 2 paths, and defines 6 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.

4 operations 2 paths 6 schemas 1 DELETE1 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 Job Deployment Restriction 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 4

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

Job Deployment Restriction 4
GET
/job/{jobId}/deploymentRestriction
Get job deployment restrictions
getJobDeploymentRestrictions 1 param → 200401403404
POST
/job/{jobId}/deploymentRestriction
Create a job deployment restriction
createJobDeploymentRestriction 1 param body → 201400401403409
PUT
/job/{jobId}/deploymentRestriction/{deploymentRestrictionId}
Edit a job deployment restriction
editJobDeploymentRestriction 2 params body → 200400401403404
DELETE
/job/{jobId}/deploymentRestriction/{deploymentRestrictionId}
Delete a job deployment restriction
deleteJobDeploymentRestriction 2 params → 204401403404

Schemas 6

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

JobDeploymentRestrictionResponse
JobDeploymentRestrictionResponseList
object
1 property
JobDeploymentRestrictionRequest
object
3 properties 3 required
DeploymentRestrictionModeEnum
string
Match mode will rebuild app only if specified items are updated. Exclude mode will not rebuild app if specified items are updated.
Base
object
3 properties 2 required
DeploymentRestrictionTypeEnum
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qovery-job-deployment-restriction-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