Qovery API

API Examples

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

Parse Terraform variables from Git repository

List credentials of an organization and their associated clusters

List organization api tokens

Create an organization api token

Delete organization api token

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

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

List projects

Create a project

List total number of services and environments for each project of the organization

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

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

Connect a github account to an organization

Disconnect a github account from an organization

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

List organization webhooks

Create an organization webhook

Get an Organization webhook

Edit an organization webhook

Delete organization webhook

List organization custom roles

Create an organization custom role

Get an organization custom role

Edit an organization custom role

Delete organization custom role

Get all events inside the organization

Get available event targets to filter events

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

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

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

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

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

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

Get project by ID

Edit a project

Delete a project

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

List environments

Create an environment

List environments statuses

List total number of services for each environment of the project

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

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

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

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

Get environment deployment rule

Edit an environment deployment rule

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

Cancel deployment request

List applications

Create an application

List all environment applications statuses

List default application advanced settings

Clone application

Auto deploy jobs

List default job advanced settings

List jobs

Create a job

List all environment job statuses

Clone job

List environment deployment logs

List environment deployment logs v2

List environment deployments

List environment deployments

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

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

List eligible database types, versions and modes for the environment

List environment databases

Create a database

List all environment databases statuses

Clone database

Export full environment and its resources into Terraform manifests

List default helm advanced settings

List helms

Create a helm

Get helm default values

List all environment helm statuses

Clone helm

Get application by ID

Edit application

Delete application

Get application status

List contributors

List last commits

List all URLs of the application

Get application deployment restrictions

Create an application deployment restriction

Edit an application deployment restriction

Delete an application deployment restriction

Deploy application

Uninstall application

Stop application

Redeploy application

Reboot application

List application deploys

List application deploys

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

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

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

List logs

Get Application Network information

Edit Application Network

Get advanced settings

Edit advanced settings

Get container by ID

Edit container

Delete container

Get container status

List all URLs of the container

List container deployments

List container deployments

Get advanced settings

Edit advanced settings

Get Container Network information

Edit Container Network

Deploy container

Uninstall container

Stop container

Redeploy container

Reboot container

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

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

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

List logs

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

List applications using the database

Remove an application from this database

Redeploy database

Retart database

Stop database

Deploy database

Uninstall database

List database deploys

List database deploys

List database backups

Add a backup to the Database

Remove database backup

Get Account information

Edit account information

Get your referral information

Claim a reward

Get Sign up information

Send Sign Up request

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

Get advanced settings

Edit advanced settings

Deploy helm

Uninstall helm

Redeploy helm

Stop helm

List helm deployments

List helm deployments

Get helm deployment restrictions

Create a helm deployment restriction

Edit a helm deployment restriction

Delete a helm deployment restriction

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

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

Get job by ID

Edit job

Delete job

Get job status

List last job commits

Get advanced settings

Edit advanced settings

Deploy job

Uninstall job

Redeploy job

Stop job

Clean a failed job

Redeploy terraform

Deploy terraform

Uninstall terraform

List job deployments

List job deployments

Get job deployment restrictions

Create a job deployment restriction

Edit a job deployment restriction

Delete a job deployment restriction

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

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

List variables

Create a variable

Create a variable alias

Create a variable override

Edit a variable

Delete a variable

Import variables

List available lifecycle template for this environment

Get specific lifecycle template

Get cluster token by clusterId

Get Deployment Status By DeploymentRequestId

List locked Cluster by organization

Get Ingress Deployment Status By Service

List terraforms

Create a terraform

List default terraform advanced settings

Clone terraform

Get terraform by ID

Edit Terraform

Delete Terraform

List last commits

Get Advanced settings

Edit Advanced settings

List terraform deployments

Get terraform deployment restrictions

Create a terraform deployment restriction

Edit a terraform deployment restriction

Delete a terraform deployment restriction

Get enterprise connection

Update enterprise connection