Skip to main content
Qovery home page
Search...
⌘K
Ask AI
GitHub
Console
Console
Search...
Navigation
Application Deployment Restriction
Page Not Found
Getting Started
Configuration
Copilot
Terraform Provider
CLI
API Reference
Getting Started
Introduction
Authentication
Guides
Overview
Examples
Organization Main Calls
List user organizations
Create an organization
Get organization by id
Edit an organization
Delete an organization
List organization available roles
List organization git tokens
Create a git token
Get organization git token
Edit a git token
Delete a git token
Get organization git token associated services
Get organization container registry associated services
Get organization helm repository associated services
List services by organizationid
List environments by organizationid
Parse terraform variables from git repository
List terraform tfvars files from git repository
List credentials of an organization and their associated clusters
Organization Api Token
List organization api tokens
Create an organization api token
Delete organization api token
Git repositories
List directories from a git repository
Get git provider accounts
Get github repositories of the connected user
Get github branches of the specified repository
Get gitlab repositories of the connected user
Get gitlab branches of the specified repository
Get bitbucket repositories of the connected user
Get bitbucket branches of the specified repository
Members
Get organization members
Edit an organization member role
Remove a member
Get invited members
Invite someone in the organization
Get member invitation
Accept invite in the organization
Remove an invited member
Transfer organization ownership to another user
Billing
Get organization current cost
Add credit code
Change organization plan
Get cluster current cost
Get organization billing info
Edit organization billing info
Get organization billing status
Generate organization billing usage report
Get organization billing external id
List organization invoices
Get organization invoice
Get invoice link
Download all invoices
List organization credit cards
Add credit card
Delete credit card
Projects
List projects
Create a project
List total number of services and environments for each project of the organization
Clusters
List organization clusters
Create a cluster
List all clusters statuses
Edit a cluster
Delete a cluster
Get cluster status
Get cluster helm values for self managed installation
Get cluster kubeconfig
Edit cluster kubeconfig
Get advanced settings
Edit advanced settings
Get routing table
Edit routing table
List cluster logs
Get cluster cloud provider info and credentials
Specify cluster cloud provider info and credentials
Know if a cluster is ready to be deployed or not
Deploy a cluster
Upgrade a cluster
Update karpenter private fargate subnet ids
Stop cluster
List default cluster advanced settings
Lock cluster
Unlock cluster
List cluster kubernetes events
Fetch cluster metrics
Fetch cluster logs
Cloud Provider Credentials
List aws credentials
Create aws credentials set
Get a set of aws credentials
Edit a set of aws credentials
Delete a set of aws credentials
List onpremise credentials
Create onpremise credentials set
Get a set of onpremise credentials
Edit a set of onpremise credentials
Delete a set of onpremise credentials
List scaleway credentials
Create scaleway credentials set
Get a set of scaleway credentials
Edit a set of scaleway credentials
Delete a set of scaleway credentials
List gcp credentials
Create gcp credentials set
Get a set of gcp credentials
Edit a set of gcp credentials
Delete a set of gcp credentials
List azure credentials
Create azure credentials set
Get a set of azure credentials
Edit a set of azure credentials
Delete a set of azure credentials
Github App
Connect a github account to an organization
Disconnect a github account from an organization
Organization Account Git Repositories
Get git provider accounts
Get github repositories of the connected user
Get github branches of the specified repository
Get gitlab repositories of the connected user
Get gitlab branches of the specified repository
Get bitbucket repositories of the connected user
Get bitbucket branches of the specified repository
Organization Webhook
List organization webhooks
Create an organization webhook
List events of a webhook
Get an organization webhook
Edit an organization webhook
Delete organization webhook
Organization Custom Role
List organization custom roles
Create an organization custom role
Get an organization custom role
Edit an organization custom role
Delete organization custom role
Organization Event
Get all events inside the organization
Get available event targets to filter events
Organization Annotations Group
List organization annotations group
Create an organization annotations group
Get organization annotations group
Edit organization annotations group
Delete organization annotations group
Get organization annotations group associated items
Organization Labels Group
List organization labels group
Create an organization labels group
Get organization labels group
Edit organization labels group
Delete organization labels group
Get organization labels group associated items
Cloud Provider
List cloud providers available
List aws regions
List aws features available
List aws available instance types
List aws available managed database types
List aws available managed database instance types
List azure aks available instance types
List aws eks available instance types
List scaleway regions
List scaleway features available
List scaleway available instance types
List scaleway available managed database types
List scaleway kapsule available instance types
List gcp regions
List gcp features available
List gcp gke available instance types
List azure regions
List azure features available
Container Registries
List organization container registries
Create a container registry
Get a container registry
Edit a container registry
Delete a container registry
List image version for a container registry
List supported container registries
Containers
List all container registry container statuses
List containers
Create a container
List all environment container statuses
Auto deploy containers
Preview container environments
List default container advanced settings
Clone container
Helm Repositories
List supported helm repository
List organization helm repositories
Create a helm repository
Get a helm repository
Edit a helm repository
Delete a helm repository
List helm charts contained inside the repository
Project Main Calls
Get project by id
Edit a project
Delete a project
Project Deployment Rule
List project deployment rules
Create a deployment rule
Get a project deployment rule
Edit a project deployment rule
Delete a project deployment rule
Update deployment rules priority order
Environments
List environments
Create an environment
List environments statuses
List total number of services for each environment of the project
List environments overview
Project Environment Variable
List project environment variables
Add an environment variable to the project
Edit an environment variable belonging to the project
Delete an environment variable from a project
Create an environment variable override at the project level
Create an environment variable alias at the project level
Project Secret
List project secrets
Add a secret to the project
Edit a secret belonging to the project
Delete a secret from a project
Create a secret override at the project level
Create a secret alias at the project level
Environment Main Calls
Get environment by id
Edit an environment
Delete an environment
Get environment status
Get environment statuses with services status
Get environment statuses with stages
List services by environmentid
List deployment queue request by environmentid
List deployment queue request by serviceid
Deployment Stage Main Calls
List environment deployment stage
Create environment deployment stage
Get deployment stage
Edit deployment stage
Delete deployment stage
Attach service to deployment stage
Move deployment stage before requested stage
Move deployment stage after requested stage
Get service deployment stage
Environment Deployment Rule
Get environment deployment rule
Edit an environment deployment rule
Environment Actions
Deploy environment
Uninstall environment
Stop environment
Redeploy environment
Cancel environment deployment
Clone environment
Deploy services
Reboot services
Stop services
Delete services
Uninstall services
Clean failed jobs within an environment
Deployment Queue Actions
Cancel deployment request
Applications
List applications
Create an application
List all environment applications statuses
List default application advanced settings
Clone application
Jobs
Auto deploy jobs
List default job advanced settings
List jobs
Create a job
List all environment job statuses
Clone job
Environment Logs
List environment deployment logs
List environment deployment logs v2
Environment Deployment History
List environment deployments
List environment deployments 1
Environment Variable
List environment variables
Add an environment variable to the environment
Edit an environment variable belonging to the environment
Delete an environment variable from an environment
Create an environment variable override at the environment level
Create an environment variable alias at the environment level
Environment Secret
List environment secrets
Add a secret to the environment
Edit a secret belonging to the environment
Delete a secret from the environment
Create a secret override at the environment level
Create a secret alias at the environment level
Databases
List eligible database types versions and modes for the environment
List environment databases
Create a database
List all environment databases statuses
Clone database
Environment Export
Export full environment and its resources into terraform manifests
Helms
List default helm advanced settings
List helms
Create a helm
Get helm default values
List all environment helm statuses
Clone helm
Application Main Calls
Get application by id
Edit application
Delete application
Get application status
List contributors
List last commits
List all urls of the application
Application Deployment Restriction
Get application deployment restrictions
Create an application deployment restriction
Edit an application deployment restriction
Delete an application deployment restriction
Application Actions
Deploy application
Uninstall application
Stop application
Redeploy application
Reboot application
Application Deployment History
List application deploys
List application deploys 1
Application Environment Variable
List environment variables
Add an environment variable to the application
Import variables
Edit an environment variable belonging to the application
Delete an environment variable from an application
Create an environment variable override at the application level
Create an environment variable alias at the application level
Application Secret
List application secrets
Add a secret to the application
Edit a secret belonging to the application
Delete a secret from an application
Create a secret override at the application level
Create a secret alias at the application level
Application Custom Domain
List application custom domains
Add custom domain to the application
Edit a custom domain
Delete a custom domain
Get custom domain status
Check application custom domain
Application Logs
List logs
Application Configuration
Get application network information
Edit application network
Get advanced settings
Edit advanced settings
Container Main Calls
Get container by id
Edit container
Delete container
Get container status
List all urls of the container
Container Deployment History
List container deployments
List container deployments 1
Container Configuration
Get advanced settings
Edit advanced settings
Get container network information
Edit container network
Container Actions
Deploy container
Uninstall container
Stop container
Redeploy container
Reboot container
Container Environment Variable
List environment variables
Add an environment variable to the container
Import variables
Edit an environment variable belonging to the container
Delete an environment variable from a container
Create an environment variable override at the container level
Create an environment variable alias at the container level
Container Secret
List container secrets
Add a secret to the container
Edit a secret belonging to the container
Delete a secret from an container
Create a secret override at the container level
Create a secret alias at the container level
Container Custom Domain
List container custom domains
Add custom domain to the container
Edit a custom domain
Delete a custom domain
Get custom domain status
Check container custom domain
Container Logs
List logs
Database Main Calls
Get database by id
Edit a database
Delete a database
Get database status
List eligible versions for the database
Get master credentials of the database
Edit database master credentials
Database Application
List applications using the database
Remove an application from this database
Database Actions
Redeploy database
Retart database
Stop database
Deploy database
Uninstall database
Database Deployment History
List database deploys
List database deploys 1
Backups
List database backups
Add a backup to the database
Remove database backup
Account Info
Get account information
Edit account information
Referral & Rewards
Get your referral information
Claim a reward
User Sign Up
Get sign up information
Send sign up request
Helm Main Calls
Get helm by id
Edit helm
Delete helm
List last helm commits
Get helm status
List all urls of the helm
Get helm kubernetes services
Helm Configuration
Get advanced settings
Edit advanced settings
Helm Actions
Deploy helm
Uninstall helm
Redeploy helm
Stop helm
Helm Deployment History
List helm deployments
List helm deployments 1
Helm Deployment Restriction
Get helm deployment restrictions
Create a helm deployment restriction
Edit a helm deployment restriction
Delete a helm deployment restriction
Helm Custom Domain
List helm custom domains
Add custom domain to the helm
Get a custom domain
Edit a custom domain
Delete a custom domain
Check helm custom domain
Environment
Check dockerfile configuration is correct
Check helm repository configuration is correct
Check container image configuration is correct
Check git file configuration is correct
List environment services links
Job Main Calls
Get job by id
Edit job
Delete job
Get job status
List last job commits
Job Configuration
Get advanced settings
Edit advanced settings
Job Actions
Deploy job
Uninstall job
Redeploy job
Stop job
Clean a failed job
Terraform Actions
Redeploy terraform
Deploy terraform
Uninstall terraform
Job Deployment History
List job deployments
List job deployments 1
Job Deployment Restriction
Get job deployment restrictions
Create a job deployment restriction
Edit a job deployment restriction
Delete a job deployment restriction
Job Environment Variable
List environment variables
Add an environment variable to the job
Import variables
Edit an environment variable belonging to the job
Delete an environment variable from a job
Create an environment variable override at the job level
Create an environment variable alias at the job level
Job Secret
List job secrets
Add a secret to the job
Edit a secret belonging to the job
Delete a secret from an job
Create a secret override at the job level
Create a secret alias at the job level
Service Main Calls
Get git webhook status for a service
Synchronize git webhook for a service
Variable Main Calls
List variables
Create a variable
Create a variable alias
Create a variable override
Edit a variable
Delete a variable
Import variables
Lifecycle Template Main Calls
List available lifecycle template for this environment
Get specific lifecycle template
API Reference
Get cluster token by clusterid
Get deployment status by deploymentrequestid
Organization Cluster Lock
List locked cluster by organization
service_status
Get ingress deployment status by service
Terraforms
List terraforms
Create a terraform
List default terraform advanced settings
Clone terraform
Terraform Main Calls
Get terraform by id
Edit terraform
Delete terraform
List available terraform versions
List last commits
Terraform Configuration
Get advanced settings
Edit advanced settings
Terraform Deployment History
List terraform deployments
Terraform Deployment Restriction
Get terraform deployment restrictions
Create a terraform deployment restriction
Edit a terraform deployment restriction
Delete a terraform deployment restriction
Terraform Resources
Get terraform resources from latest deployment
Organization Enterprise Connection
List enterprise connections
Get enterprise connection
Update enterprise connection
Alert Receivers
List alert receivers
Create alert receiver
Get alert receiver
Update alert receiver
Delete alert receiver
Validate existing alert receiver
Validate new alert receiver
Alert Rules
Create alert rule
Get alert rule
Update alert rule
Delete alert rule
List alert rules
404
Page Not Found
We couldn't find the page.
⌘I