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 Project Deployment Rule API

The Project Deployment Rule API from Qovery — 3 operation(s) for project deployment rule.

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

Tagged areas include Project Deployment Rule. 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 3 paths, and defines 7 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 3 paths 7 schemas 1 DELETE2 GET1 POST2 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 Project Deployment Rule 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 3 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 1 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Project Deployment Rule 6
GET
/project/{projectId}/deploymentRule
List project deployment rules
listProjectDeploymentRules 1 param → 200401403404
POST
/project/{projectId}/deploymentRule
Create a deployment rule
createDeploymentRule 1 param body → 201400401403404
GET
/project/{projectId}/deploymentRule/{deploymentRuleId}
Get a project deployment rule
getProjectDeploymentRule 2 params → 200401403404
PUT
/project/{projectId}/deploymentRule/{deploymentRuleId}
Edit a project deployment rule
editProjectDeployemtnRule 2 params body → 200400401403404
DELETE
/project/{projectId}/deploymentRule/{deploymentRuleId}
Delete a project deployment rule
deleteProjectDeploymentRule 2 params → 204401403404
PUT
/project/{projectId}/deploymentRule/order
Update deployment rules priority order
updateDeploymentRulesPriorityOrder 1 param body → 200400401403404

Schemas 7

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

EnvironmentModeEnum
string
WeekdayEnum
string
ProjectDeploymentRule
ProjectDeploymentRulesPriorityOrderRequest
object
1 property
ProjectDeploymentRuleResponseList
object
1 property
ProjectDeploymentRuleRequest
object
10 properties 8 required
Base
object
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qovery-project-deployment-rule-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