Getting Started
Guides
Organization Main Calls
- GETList user organizations
- POSTCreate an organization
- GETGet organization by ID
- PUTEdit an organization
- DELDelete an organization
- GETList organization available roles
- GETList organization git tokens
- POSTCreate a git token
- GETGet organization git token
- PUTEdit a git token
- DELDelete a git token
- GETGet organization git token associated services
- GETGet organization container registry associated services
- GETGet organization helm repository associated services
- GETList Services By OrganizationId
- POSTParse Terraform variables from Git repository
- POSTList Terraform tfvars files from Git repository
- GETList credentials of an organization and their associated clusters
Organization Api Token
Git repositories
- POSTList directories from a git repository
- GETGet git provider accountsdeprecated
- GETGet github repositories of the connected userdeprecated
- GETGet github branches of the specified repositorydeprecated
- GETGet gitlab repositories of the connected userdeprecated
- GETGet gitlab branches of the specified repositorydeprecated
- GETGet bitbucket repositories of the connected userdeprecated
- GETGet bitbucket branches of the specified repositorydeprecated
Members
Billing
- GETGet organization current cost
- POSTAdd credit code
- POSTChange organization plan
- GETGet cluster current cost
- GETGet organization billing info
- PUTEdit Organization Billing Info
- GETGet organization billing status
- POSTGenerate organization billing usage report
- GETGet organization billing external ID
- GETList organization invoices
- GETGet organization invoice
- GETGet invoice link
- POSTDownload all invoices
- GETList organization credit cards
- POSTAdd credit card
- DELDelete credit card
Projects
Clusters
- GETList organization clusters
- POSTCreate a cluster
- GETList all clusters statuses
- PUTEdit a cluster
- DELDelete a cluster
- GETGet cluster status
- GETGet cluster helm values for self managed installation
- GETGet cluster kubeconfig
- PUTEdit cluster kubeconfig
- GETGet advanced settings
- PUTEdit advanced settings
- GETGet routing table
- PUTEdit routing table
- GETList Cluster Logs
- GETGet cluster cloud provider info and credentials
- POSTSpecify cluster cloud provider info and credentials
- GETKnow if a cluster is ready to be deployed or not
- POSTDeploy a cluster
- POSTUpgrade a cluster
- PUTUpdate karpenter private fargate subnet ids
- POSTStop cluster
- GETList default cluster advanced settings
- POSTLock Cluster
- DELUnlock Cluster
- GETList Cluster Kubernetes Events
- GETFetch cluster metrics
- GETFetch cluster logs
Cloud Provider Credentials
- GETList AWS credentials
- POSTCreate AWS credentials set
- GETGet a set of AWS credentials
- PUTEdit a set of AWS credentials
- DELDelete a set of AWS credentials
- GETList OnPremise credentials
- POSTCreate OnPremise credentials set
- GETGet a set of OnPremise credentials
- PUTEdit a set of OnPremise credentials
- DELDelete a set of OnPremise credentials
- GETList Scaleway credentials
- POSTCreate Scaleway credentials set
- GETGet a set of Scaleway credentials
- PUTEdit a set of Scaleway credentials
- DELDelete a set of Scaleway credentials
- GETList GCP credentials
- POSTCreate GCP credentials set
- GETGet a set of GCP credentials
- PUTEdit a set of GCP credentials
- DELDelete a set of GCP credentials
- GETList Azure credentials
- POSTCreate Azure credentials set
- GETGet a set of Azure credentials
- PUTEdit a set of Azure credentials
- DELDelete a set of Azure credentials
Github App
Organization Account Git Repositories
- GETGet git provider accounts
- GETGet github repositories of the connected user
- GETGet github branches of the specified repository
- GETGet gitlab repositories of the connected user
- GETGet gitlab branches of the specified repository
- GETGet bitbucket repositories of the connected user
- GETGet bitbucket branches of the specified repository
Organization Webhook
Organization Custom Role
Organization Event
Organization Annotations Group
Organization Labels Group
Cloud Provider
- GETList Cloud providers available
- GETList AWS regions
- GETList AWS features available
- GETList AWS available instance types
- GETList AWS available managed database types
- GETList AWS available managed database instance types
- GETList Azure AKS available instance types
- GETList AWS EKS available instance types
- GETList Scaleway regions
- GETList Scaleway features available
- GETList Scaleway available instance types
- GETList Scaleway available managed database types
- GETList Scaleway Kapsule available instance types
- GETList GCP regions
- GETList GCP features available
- GETList GCP GKE available instance types
- GETList Azure regions
- GETList Azure features available
Container Registries
Containers
Helm Repositories
Project Main Calls
Project Deployment Rule
Environments
Project Environment Variable
- GETList project environment variables
- POSTAdd an environment variable to the project
- PUTEdit an environment variable belonging to the project
- DELDelete an environment variable from a project
- POSTCreate an environment variable override at the project level
- POSTCreate an environment variable alias at the project level
Project Secret
Environment Main Calls
- GETGet environment by ID
- PUTEdit an environment
- DELDelete an environment
- GETGet environment status
- GETGet environment statuses with services status
- GETGet environment statuses with stages
- GETList Services By EnvironmentId
- GETList Deployment Queue Request By EnvironmentId
- GETList Deployment Queue Request By ServiceId
Deployment Stage Main Calls
- GETList environment deployment stage
- POSTCreate environment deployment stage
- GETGet Deployment Stage
- PUTEdit deployment stage
- DELDelete deployment stage
- PUTAttach service to deployment stage
- PUTMove deployment stage before requested stage
- PUTMove deployment stage after requested stage
- GETGet Service Deployment Stage
Environment Deployment Rule
Environment Actions
Deployment Queue Actions
Applications
Jobs
Environment Deployment History
Environment Variable
- GETList environment variables
- POSTAdd an environment variable to the environment
- PUTEdit an environment variable belonging to the environment
- DELDelete an environment variable from an environment
- POSTCreate an environment variable override at the environment level
- POSTCreate an environment variable alias at the environment level
Environment Secret
Databases
Environment Export
Helms
Application Main Calls
Application Deployment Restriction
Application Actions
Application Deployment History
Application Environment Variable
- GETList environment variables
- POSTAdd an environment variable to the application
- POSTImport variables
- PUTEdit an environment variable belonging to the application
- DELDelete an environment variable from an application
- POSTCreate an environment variable override at the application level
- POSTCreate an environment variable alias at the application level
Application Secret
Application Custom Domain
Application Logs
Application Configuration
Container Main Calls
Container Deployment History
Container Configuration
Container Actions
Container Environment Variable
- GETList environment variables
- POSTAdd an environment variable to the container
- POSTImport variables
- PUTEdit an environment variable belonging to the container
- DELDelete an environment variable from a container
- POSTCreate an environment variable override at the container level
- POSTCreate an environment variable alias at the container level
Container Secret
Container Custom Domain
Container Logs
Database Main Calls
Database Application
Database Actions
Database Deployment History
Referral & Rewards
Helm Main Calls
Helm Configuration
Helm Deployment History
Helm Deployment Restriction
Helm Custom Domain
Environment
Job Configuration
Terraform Actions
Job Deployment History
Job Deployment Restriction
Job Environment Variable
- GETList environment variables
- POSTAdd an environment variable to the job
- POSTImport variables
- PUTEdit an environment variable belonging to the job
- DELDelete an environment variable from a job
- POSTCreate an environment variable override at the job level
- POSTCreate an environment variable alias at the job level
Job Secret
Variable Main Calls
Lifecycle Template Main Calls
Organization Cluster Lock
service_status
Terraforms
Terraform Main Calls
Terraform Configuration
Terraform Deployment History
Terraform Deployment Restriction
Organization Enterprise Connection
Alert Receivers
Edit a secret belonging to the application
Copy
Ask AI
curl --request PUT \
--url https://api.qovery.com/application/{applicationId}/secret/{secretId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"key": "<string>",
"value": "<string>",
"description": "<string>",
"enable_interpolation_in_file": true
}
'Copy
Ask AI
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"key": "<string>",
"scope": "APPLICATION",
"updated_at": "2023-11-07T05:31:56Z",
"overridden_secret": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"key": "<string>",
"mount_path": "<string>",
"scope": "APPLICATION",
"variable_type": "VALUE",
"description": "<string>",
"enable_interpolation_in_file": true
},
"aliased_secret": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"key": "QOVERY_DATABASE_PSQL_NAME",
"mount_path": "<string>",
"scope": "APPLICATION",
"variable_type": "VALUE",
"description": "<string>",
"enable_interpolation_in_file": true
},
"variable_type": "VALUE",
"service_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"service_name": "<string>",
"service_type": "APPLICATION",
"owned_by": "<string>",
"description": "<string>",
"enable_interpolation_in_file": true
}Application Secret
Edit a secret belonging to the application
- You can’t edit a BUILT_IN secret
- For an override, you can’t edit the key
- For an alias, you can’t edit the value
- An override can only have a scope lower to the secret it is overriding (hierarchy is BUILT_IN > PROJECT > ENVIRONMENT > APPLICATION)
PUT
/
application
/
{applicationId}
/
secret
/
{secretId}
Edit a secret belonging to the application
Copy
Ask AI
curl --request PUT \
--url https://api.qovery.com/application/{applicationId}/secret/{secretId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"key": "<string>",
"value": "<string>",
"description": "<string>",
"enable_interpolation_in_file": true
}
'Copy
Ask AI
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"key": "<string>",
"scope": "APPLICATION",
"updated_at": "2023-11-07T05:31:56Z",
"overridden_secret": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"key": "<string>",
"mount_path": "<string>",
"scope": "APPLICATION",
"variable_type": "VALUE",
"description": "<string>",
"enable_interpolation_in_file": true
},
"aliased_secret": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"key": "QOVERY_DATABASE_PSQL_NAME",
"mount_path": "<string>",
"scope": "APPLICATION",
"variable_type": "VALUE",
"description": "<string>",
"enable_interpolation_in_file": true
},
"variable_type": "VALUE",
"service_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"service_name": "<string>",
"service_type": "APPLICATION",
"owned_by": "<string>",
"description": "<string>",
"enable_interpolation_in_file": true
}Authorizations
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 ' curl https://console.qovery.com/organization -H "Authorization: Bearer $qovery_token" '
Path Parameters
Application ID
Secret ID
Body
application/json
Response
Edited the secret value
key is case sensitive
Available options:
APPLICATION, BUILT_IN, ENVIRONMENT, PROJECT, CONTAINER, JOB, HELM, TERRAFORM Show child attributes
Show child attributes
Show child attributes
Show child attributes
type of the environment variable (VALUE, FILE, ALIAS, OVERRIDE or BUIT_IN)
Available options:
VALUE, ALIAS, OVERRIDE, BUILT_IN, FILE type of the service (application, database, job, gateway...)
Available options:
APPLICATION, CONTAINER, DATABASE, JOB, HELM, TERRAFORM Entity that created/own the variable (i.e: Qovery, Doppler)
optional variable description (255 characters maximum)
Maximum string length:
255Was this page helpful?
⌘I