# Qovery: Platform API Reference ## API Reference - [Platform / API Reference / Organization Main Calls (21 pages)](https://www.qovery.com/docs/_llms/platform/api-reference/organization-main-calls.md): Documentation for Platform / API Reference / Organization Main Calls. - [Platform / API Reference / Clusters (37 pages)](https://www.qovery.com/docs/_llms/platform/api-reference/clusters.md): Documentation for Platform / API Reference / Clusters. - [Platform / API Reference / Cloud Provider Credentials (25 pages)](https://www.qovery.com/docs/_llms/platform/api-reference/cloud-provider-credentials.md): Documentation for Platform / API Reference / Cloud Provider Credentials. - [Platform / API Reference / Blueprint Main Calls (8 pages)](https://www.qovery.com/docs/_llms/platform/api-reference/blueprint-main-calls.md): Documentation for Platform / API Reference / Blueprint Main Calls. ### Getting Started - [Getting Started with Qovery API](https://www.qovery.com/docs/api-reference/introduction.md): Learn how to authenticate and use the Qovery API - [API Authentication](https://www.qovery.com/docs/api-reference/authentication.md): Learn how to authenticate with the Qovery API ### Guides - [Qovery API](https://www.qovery.com/docs/api-reference/overview.md): Programmatically manage your infrastructure with the Qovery REST API - [API Examples](https://www.qovery.com/docs/api-reference/examples.md): Practical examples for using the Qovery API ### IPs - [List Qovery NAT gateway IP addresses](https://www.qovery.com/docs/api-reference/ips/list-qovery-nat-gateway-ip-addresses.md): Returns the list of static IP addresses used by Qovery's NAT gateways for outbound traffic. Customers can allow-list these IPs on their side. This endpoint is public and does not require authentication. ### Organization Policy Api Token - [List organization policy api tokens](https://www.qovery.com/docs/api-reference/organization-policy-api-token/list-organization-policy-api-tokens.md): List the policy api tokens of the organization, each with the Open Policy Agent (rego) policy it carries. The token value itself is never returned here, it is only shown once at creation. - [Create an organization policy api token](https://www.qovery.com/docs/api-reference/organization-policy-api-token/create-an-organization-policy-api-token.md): Create a policy api token, intended for autonomous agents calling the Qovery API. - [Delete organization policy api token](https://www.qovery.com/docs/api-reference/organization-policy-api-token/delete-organization-policy-api-token.md): Delete organization policy api token ### Organization Api Token - [List organization api tokens](https://www.qovery.com/docs/api-reference/organization-api-token/list-organization-api-tokens.md): List organization api tokens - [Create an organization api token](https://www.qovery.com/docs/api-reference/organization-api-token/create-an-organization-api-token.md): Create an organization api token. You can use the generated token to interact in a programmatic way with our API. - [Delete organization api token](https://www.qovery.com/docs/api-reference/organization-api-token/delete-organization-api-token.md): Delete organization api token ### Git repositories - [List directories from a git repository](https://www.qovery.com/docs/api-reference/git-repositories/list-directories-from-a-git-repository.md): List immediate subdirectories at a specified path in a git repository. This endpoint is used when creating Terraform services to help users browse and select the appropriate root path. - [Get git provider accounts](https://www.qovery.com/docs/api-reference/git-repositories/get-git-provider-accounts.md) - [Get github repositories of the connected user](https://www.qovery.com/docs/api-reference/git-repositories/get-github-repositories-of-the-connected-user.md) - [Get github branches of the specified repository](https://www.qovery.com/docs/api-reference/git-repositories/get-github-branches-of-the-specified-repository.md) - [Get gitlab repositories of the connected user](https://www.qovery.com/docs/api-reference/git-repositories/get-gitlab-repositories-of-the-connected-user.md) - [Get gitlab branches of the specified repository](https://www.qovery.com/docs/api-reference/git-repositories/get-gitlab-branches-of-the-specified-repository.md) - [Get bitbucket repositories of the connected user](https://www.qovery.com/docs/api-reference/git-repositories/get-bitbucket-repositories-of-the-connected-user.md) - [Get bitbucket branches of the specified repository](https://www.qovery.com/docs/api-reference/git-repositories/get-bitbucket-branches-of-the-specified-repository.md) ### Members - [Get organization members](https://www.qovery.com/docs/api-reference/members/get-organization-members.md) - [Edit an organization member role](https://www.qovery.com/docs/api-reference/members/edit-an-organization-member-role.md): Edit an organization member role - [Remove a member](https://www.qovery.com/docs/api-reference/members/remove-a-member.md) - [Get invited members](https://www.qovery.com/docs/api-reference/members/get-invited-members.md) - [Invite someone in the organization](https://www.qovery.com/docs/api-reference/members/invite-someone-in-the-organization.md) - [Get member invitation](https://www.qovery.com/docs/api-reference/members/get-member-invitation.md) - [Accept Invite in the organization](https://www.qovery.com/docs/api-reference/members/accept-invite-in-the-organization.md) - [Remove an invited member](https://www.qovery.com/docs/api-reference/members/remove-an-invited-member.md) - [Transfer organization ownership to another user](https://www.qovery.com/docs/api-reference/members/transfer-organization-ownership-to-another-user.md) ### Billing - [Get organization current cost](https://www.qovery.com/docs/api-reference/billing/get-organization-current-cost.md) - [Add credit code](https://www.qovery.com/docs/api-reference/billing/add-credit-code.md) - [Change organization plan](https://www.qovery.com/docs/api-reference/billing/change-organization-plan.md) - [Get cluster current cost](https://www.qovery.com/docs/api-reference/billing/get-cluster-current-cost.md): Get your cluster cost range. We are unable to give a precise cost of your infrastructure at the moment. But Qovery guarantees that the cost of your cluster will not exceed the max range. - [Get organization billing info](https://www.qovery.com/docs/api-reference/billing/get-organization-billing-info.md) - [Edit Organization Billing Info](https://www.qovery.com/docs/api-reference/billing/edit-organization-billing-info.md) - [Get organization billing status](https://www.qovery.com/docs/api-reference/billing/get-organization-billing-status.md): This endpoint returns a "is_valid" boolean field reflecting the billing status of the organization: - If true, the organization billing is valid - For Startup organization, it returns false if there is at least 1 invoice unpaid since 1 week - For Community organization, it returns false if there is… - [Generate organization billing usage report](https://www.qovery.com/docs/api-reference/billing/generate-organization-billing-usage-report.md) - [Get organization billing external ID](https://www.qovery.com/docs/api-reference/billing/get-organization-billing-external-id.md): This endpoint returns the external ID of the organization's billing account - [List organization invoices](https://www.qovery.com/docs/api-reference/billing/list-organization-invoices.md) - [Get organization invoice](https://www.qovery.com/docs/api-reference/billing/get-organization-invoice.md) - [Get invoice link](https://www.qovery.com/docs/api-reference/billing/get-invoice-link.md): This will return URL of the invoice PDF - [Download all invoices](https://www.qovery.com/docs/api-reference/billing/download-all-invoices.md) - [List organization credit cards](https://www.qovery.com/docs/api-reference/billing/list-organization-credit-cards.md) - [Add credit card](https://www.qovery.com/docs/api-reference/billing/add-credit-card.md) - [Delete credit card](https://www.qovery.com/docs/api-reference/billing/delete-credit-card.md) ### Projects - [List projects](https://www.qovery.com/docs/api-reference/projects/list-projects.md) - [Create a project](https://www.qovery.com/docs/api-reference/projects/create-a-project.md) - [List total number of services and environments for each project of the organization](https://www.qovery.com/docs/api-reference/projects/list-total-number-of-services-and-environments-for-each-project-of-the-organization.md): Returns a list of project ids, and for each its total numberof services and environments ### Platform Configuration - [List platform templates](https://www.qovery.com/docs/api-reference/platform-configuration/list-platform-templates.md): Returns the published platform templates available to the organization. Each template contains its layers, components, and the configuration fields that the Console can render. When clusterMode and cloudProvider are supplied together, component field constraints are narrowed to the effective choices… - [Resolve a platform component configuration before cluster creation](https://www.qovery.com/docs/api-reference/platform-configuration/resolve-a-platform-component-configuration-before-cluster-creation.md): Resolves the fields and runtime requirements to display for a component using an explicit cluster context and the values currently entered in the Console. This operation is read-only and does not require an existing cluster or platform binding. - [Get the cluster platform binding](https://www.qovery.com/docs/api-reference/platform-configuration/get-the-cluster-platform-binding.md): Returns the platform template selected for the cluster, its layer resolution, and the currently stored component configuration. - [Update the cluster platform binding](https://www.qovery.com/docs/api-reference/platform-configuration/update-the-cluster-platform-binding.md): Selects a platform template and stores layer selections, component profile values, and customer-provided runtime inputs for the cluster. - [Resolve a platform component configuration](https://www.qovery.com/docs/api-reference/platform-configuration/resolve-a-platform-component-configuration.md): Resolves the fields and runtime requirements to display for a component using the cluster context and the values currently entered in the Console. This operation is read-only. ### Cluster Operator - [Attach a cluster to the Qovery Operator execution path](https://www.qovery.com/docs/api-reference/cluster-operator/attach-a-cluster-to-the-qovery-operator-execution-path.md): Marks a self-managed cluster for routing through the Qovery Operator. This records the routing intent only; it does not install the Operator or prove that it is connected. Cluster administrator permission is required. - [Get the Qovery Operator bootstrap](https://www.qovery.com/docs/api-reference/cluster-operator/get-the-qovery-operator-bootstrap.md): Compiles the Helm chart coordinates, values file, and ready-to-run Helm command for a self-managed cluster. The response contains cluster credentials and must be handled as sensitive data. Cluster administrator permission is required. - [Get the Qovery Operator status for a cluster](https://www.qovery.com/docs/api-reference/cluster-operator/get-the-qovery-operator-status-for-a-cluster.md): Returns heartbeat freshness and the image, chart, and protocol versions last reported by the running Operator, together with the current bootstrap targets and a stable drift status. A false operator_connected value means that no heartbeat was received within the presence window. The status is a disp… - [Update the Qovery Operator on a cluster](https://www.qovery.com/docs/api-reference/cluster-operator/update-the-qovery-operator-on-a-cluster.md): Queues an Engine v2 execution containing only the Qovery Operator Helm release. The chart version is required; the optional image version overrides the image target selected by q-core. The current Operator must be attached, connected, and protocol-compatible. A successful response means that the exe… - [List the Qovery Operator fleet](https://www.qovery.com/docs/api-reference/cluster-operator/list-the-qovery-operator-fleet.md): Returns every self-managed cluster with its attachment, heartbeat freshness, desired and reported image and Helm chart versions, and a stable drift status. This operation is restricted to Qovery administrators and is the source for internal fleet CLI and dashboard consumers. ### Secret Manager Access - [List upstream secrets from secret provider](https://www.qovery.com/docs/api-reference/secret-manager-access/list-upstream-secrets-from-secret-provider.md): List upstream secrets from secret provider - [List external secrets used by a secret manager access](https://www.qovery.com/docs/api-reference/secret-manager-access/list-external-secrets-used-by-a-secret-manager-access.md): List external secrets used by a secret manager access ### Github App - [Connect a github account to an organization](https://www.qovery.com/docs/api-reference/github-app/connect-a-github-account-to-an-organization.md) - [Disconnect a github account from an organization](https://www.qovery.com/docs/api-reference/github-app/disconnect-a-github-account-from-an-organization.md) ### Organization Account Git Repositories - [Get git provider accounts](https://www.qovery.com/docs/api-reference/organization-account-git-repositories/get-git-provider-accounts.md) - [Get github repositories of the connected user](https://www.qovery.com/docs/api-reference/organization-account-git-repositories/get-github-repositories-of-the-connected-user.md) - [Get github branches of the specified repository](https://www.qovery.com/docs/api-reference/organization-account-git-repositories/get-github-branches-of-the-specified-repository.md) - [Get gitlab repositories of the connected user](https://www.qovery.com/docs/api-reference/organization-account-git-repositories/get-gitlab-repositories-of-the-connected-user.md) - [Get gitlab branches of the specified repository](https://www.qovery.com/docs/api-reference/organization-account-git-repositories/get-gitlab-branches-of-the-specified-repository.md) - [Get bitbucket repositories of the connected user](https://www.qovery.com/docs/api-reference/organization-account-git-repositories/get-bitbucket-repositories-of-the-connected-user.md) - [Get bitbucket branches of the specified repository](https://www.qovery.com/docs/api-reference/organization-account-git-repositories/get-bitbucket-branches-of-the-specified-repository.md) ### Organization Webhook - [List organization webhooks](https://www.qovery.com/docs/api-reference/organization-webhook/list-organization-webhooks.md): List organization webhooks - [Create an organization webhook](https://www.qovery.com/docs/api-reference/organization-webhook/create-an-organization-webhook.md): Create an organization webhook. - [List events of a webhook](https://www.qovery.com/docs/api-reference/organization-webhook/list-events-of-a-webhook.md): List events of a webhooks - [Get an Organization webhook](https://www.qovery.com/docs/api-reference/organization-webhook/get-an-organization-webhook.md): Get an Organization webhook - [Edit an organization webhook](https://www.qovery.com/docs/api-reference/organization-webhook/edit-an-organization-webhook.md): Edit an organization webhook - [Delete organization webhook](https://www.qovery.com/docs/api-reference/organization-webhook/delete-organization-webhook.md): Delete organization webhook ### Blueprint Catalog - [Get the README of a blueprint catalog service](https://www.qovery.com/docs/api-reference/blueprint-catalog/get-the-readme-of-a-blueprint-catalog-service.md) - [Get the input fields to display for a blueprint catalog service](https://www.qovery.com/docs/api-reference/blueprint-catalog/get-the-input-fields-to-display-for-a-blueprint-catalog-service.md): Returns the list of form fields the console must display to deploy the selected blueprint, derived from the blueprint's qbm.yml manifest. Includes editable variables (overridable=true) and auto-sourced context variables (overridable=false, with a source). ### Organization Custom Role - [List organization custom roles](https://www.qovery.com/docs/api-reference/organization-custom-role/list-organization-custom-roles.md): List organization custom roles - [Create an organization custom role](https://www.qovery.com/docs/api-reference/organization-custom-role/create-an-organization-custom-role.md): Create an organization custom role - [Get an organization custom role ](https://www.qovery.com/docs/api-reference/organization-custom-role/get-an-organization-custom-role.md): Get an organization custom role - [Edit an organization custom role](https://www.qovery.com/docs/api-reference/organization-custom-role/edit-an-organization-custom-role.md): Edit an organization custom role - [Delete organization custom role](https://www.qovery.com/docs/api-reference/organization-custom-role/delete-organization-custom-role.md): Delete organization custom role ### Organization Event - [Get all events inside the organization](https://www.qovery.com/docs/api-reference/organization-event/get-all-events-inside-the-organization.md): Get all events inside the organization - [Get available event targets to filter events](https://www.qovery.com/docs/api-reference/organization-event/get-available-event-targets-to-filter-events.md): Get available event targets to filter events ### Organization Annotations Group - [List organization annotations group](https://www.qovery.com/docs/api-reference/organization-annotations-group/list-organization-annotations-group.md): List organization annotations group - [Create an organization annotations group](https://www.qovery.com/docs/api-reference/organization-annotations-group/create-an-organization-annotations-group.md): Create an organization annotations group - [Get organization annotations group](https://www.qovery.com/docs/api-reference/organization-annotations-group/get-organization-annotations-group.md): Get organization annotations group - [Edit organization annotations group](https://www.qovery.com/docs/api-reference/organization-annotations-group/edit-organization-annotations-group.md): Edit organization annotations group - [Delete organization annotations group](https://www.qovery.com/docs/api-reference/organization-annotations-group/delete-organization-annotations-group.md): Delete organization annotations group - [Get organization annotations group associated items](https://www.qovery.com/docs/api-reference/organization-annotations-group/get-organization-annotations-group-associated-items.md): Get organization annotations group associated items ### Organization Labels Group - [List organization labels group](https://www.qovery.com/docs/api-reference/organization-labels-group/list-organization-labels-group.md): List organization labels group - [Create an organization labels group](https://www.qovery.com/docs/api-reference/organization-labels-group/create-an-organization-labels-group.md): Create an organization labels group - [Get organization labels group](https://www.qovery.com/docs/api-reference/organization-labels-group/get-organization-labels-group.md): Get organization labels group - [Edit organization labels group](https://www.qovery.com/docs/api-reference/organization-labels-group/edit-organization-labels-group.md): Edit organization labels group - [Delete organization labels group](https://www.qovery.com/docs/api-reference/organization-labels-group/delete-organization-labels-group.md): Delete organization labels group - [Get organization labels group associated items](https://www.qovery.com/docs/api-reference/organization-labels-group/get-organization-labels-group-associated-items.md): Get organization labels group associated items ### Cloud Provider - [List Cloud providers available](https://www.qovery.com/docs/api-reference/cloud-provider/list-cloud-providers-available.md) - [List AWS regions](https://www.qovery.com/docs/api-reference/cloud-provider/list-aws-regions.md) - [List AWS features available](https://www.qovery.com/docs/api-reference/cloud-provider/list-aws-features-available.md) - [List AWS available instance types](https://www.qovery.com/docs/api-reference/cloud-provider/list-aws-available-instance-types.md) - [List AWS available managed database types](https://www.qovery.com/docs/api-reference/cloud-provider/list-aws-available-managed-database-types.md) - [List AWS available managed database instance types](https://www.qovery.com/docs/api-reference/cloud-provider/list-aws-available-managed-database-instance-types.md) - [List Azure AKS available instance types](https://www.qovery.com/docs/api-reference/cloud-provider/list-azure-aks-available-instance-types.md) - [List AWS EKS available instance types](https://www.qovery.com/docs/api-reference/cloud-provider/list-aws-eks-available-instance-types.md) - [List Scaleway regions](https://www.qovery.com/docs/api-reference/cloud-provider/list-scaleway-regions.md) - [List Scaleway features available](https://www.qovery.com/docs/api-reference/cloud-provider/list-scaleway-features-available.md) - [List Scaleway available instance types](https://www.qovery.com/docs/api-reference/cloud-provider/list-scaleway-available-instance-types.md) - [List Scaleway available managed database types](https://www.qovery.com/docs/api-reference/cloud-provider/list-scaleway-available-managed-database-types.md) - [List Scaleway Kapsule available instance types](https://www.qovery.com/docs/api-reference/cloud-provider/list-scaleway-kapsule-available-instance-types.md) - [List GCP regions](https://www.qovery.com/docs/api-reference/cloud-provider/list-gcp-regions.md) - [List GCP features available](https://www.qovery.com/docs/api-reference/cloud-provider/list-gcp-features-available.md) - [List GCP GKE available instance types](https://www.qovery.com/docs/api-reference/cloud-provider/list-gcp-gke-available-instance-types.md) - [List Azure regions](https://www.qovery.com/docs/api-reference/cloud-provider/list-azure-regions.md) - [List Azure features available](https://www.qovery.com/docs/api-reference/cloud-provider/list-azure-features-available.md) ### ArgoCD - [Get ArgoCD credentials for a cluster](https://www.qovery.com/docs/api-reference/argocd/get-argocd-credentials-for-a-cluster.md): Retrieve the stored ArgoCD configuration for a cluster. The token is always returned as REDACTED. Requires VIEWER role. - [Save ArgoCD credentials for a cluster](https://www.qovery.com/docs/api-reference/argocd/save-argocd-credentials-for-a-cluster.md): Save or update the ArgoCD URL and authentication token for a cluster. Requires ADMIN role. - [Delete ArgoCD credentials for a cluster](https://www.qovery.com/docs/api-reference/argocd/delete-argocd-credentials-for-a-cluster.md): Remove the stored ArgoCD configuration for a cluster. Requires ADMIN role. - [Check ArgoCD connection](https://www.qovery.com/docs/api-reference/argocd/check-argocd-connection.md): Test an ArgoCD URL and token before saving. The cluster agent attempts to connect to ArgoCD and returns the connection result. Always returns HTTP 200 — check the `status` field for the connection outcome. Requires ADMIN role. - [List ArgoCD instance mappings for an organization](https://www.qovery.com/docs/api-reference/argocd/list-argocd-instance-mappings-for-an-organization.md): Returns one entry per ArgoCD agent cluster that has credentials configured. Each entry lists linked clusters and unlinked clusters. Requires VIEWER role. - [Save an ArgoCD destination cluster mapping](https://www.qovery.com/docs/api-reference/argocd/save-an-argocd-destination-cluster-mapping.md): Map an ArgoCD destination cluster URL to a Qovery cluster for a given agent cluster. If a mapping for the same (agentClusterId, argocdClusterUrl) already exists, it is updated. Requires ADMIN role on the agent cluster. - [Delete an ArgoCD destination cluster mapping](https://www.qovery.com/docs/api-reference/argocd/delete-an-argocd-destination-cluster-mapping.md): Remove the mapping between an ArgoCD destination cluster URL and a Qovery cluster. Requires ADMIN role on the agent cluster. - [Get ArgoCD app by ID](https://www.qovery.com/docs/api-reference/argocd/get-argocd-app-by-id.md) - [Get ArgoCD app manifest enrichment](https://www.qovery.com/docs/api-reference/argocd/get-argocd-app-manifest-enrichment.md) - [Get ArgoCD associated services for a cluster](https://www.qovery.com/docs/api-reference/argocd/get-argocd-associated-services-for-a-cluster.md): List the ArgoCD discovered apps for a cluster, mapped to their project, environment, and service context. Requires VIEWER role. ### Container Registries - [List organization container registries](https://www.qovery.com/docs/api-reference/container-registries/list-organization-container-registries.md) - [Create a container registry](https://www.qovery.com/docs/api-reference/container-registries/create-a-container-registry.md) - [Get a container registry](https://www.qovery.com/docs/api-reference/container-registries/get-a-container-registry.md) - [Edit a container registry](https://www.qovery.com/docs/api-reference/container-registries/edit-a-container-registry.md) - [Delete a container registry](https://www.qovery.com/docs/api-reference/container-registries/delete-a-container-registry.md) - [List image version for a container registry](https://www.qovery.com/docs/api-reference/container-registries/list-image-version-for-a-container-registry.md) - [List supported container registries](https://www.qovery.com/docs/api-reference/container-registries/list-supported-container-registries.md): List supported container registries by Qovery and get the mandatory authentification configuration. ### MCP Servers - [List organization MCP servers](https://www.qovery.com/docs/api-reference/mcp-servers/list-organization-mcp-servers.md): List the remote MCP servers configured for an organization. Header values are never returned. - [Create an MCP server](https://www.qovery.com/docs/api-reference/mcp-servers/create-an-mcp-server.md): Configure a remote HTTPS MCP server for an organization. - [Get an MCP server](https://www.qovery.com/docs/api-reference/mcp-servers/get-an-mcp-server.md): Get a remote MCP server configuration. Header values are never returned. - [Edit an MCP server](https://www.qovery.com/docs/api-reference/mcp-servers/edit-an-mcp-server.md): Replace a remote MCP server configuration, including all configured headers. - [Delete an MCP server](https://www.qovery.com/docs/api-reference/mcp-servers/delete-an-mcp-server.md): Delete a remote MCP server configuration. ### Containers - [List all container registry container statuses](https://www.qovery.com/docs/api-reference/containers/list-all-container-registry-container-statuses.md): Returns a list of containers with only their id and status. - [List containers](https://www.qovery.com/docs/api-reference/containers/list-containers.md) - [Create a container](https://www.qovery.com/docs/api-reference/containers/create-a-container.md) - [List all environment container statuses](https://www.qovery.com/docs/api-reference/containers/list-all-environment-container-statuses.md): Returns a list of containers with only their id and status. - [Auto deploy containers](https://www.qovery.com/docs/api-reference/containers/auto-deploy-containers.md): Triggers a new container deploy in each environment matching the following conditions - environment should have the auto-deploy enabled - the container should have the same image name and a different tag - [Preview container environments](https://www.qovery.com/docs/api-reference/containers/preview-container-environments.md): Triggers a new container preview for each environment matching the following conditions - preview environment feature should be enabled for the container - the container should have the same image name and a different tag - [List default container advanced settings](https://www.qovery.com/docs/api-reference/containers/list-default-container-advanced-settings.md): Default values for each setting are available in [our documentation](https://hub.qovery.com/docs/using-qovery/configuration/advanced-settings/) - [Clone container](https://www.qovery.com/docs/api-reference/containers/clone-container.md): This will create a new container with the same configuration on the targeted environment Id. ### Helm Repositories - [List supported helm repository](https://www.qovery.com/docs/api-reference/helm-repositories/list-supported-helm-repository.md): List supported helm repository by Qovery and get the mandatory authentification configuration. - [List organization helm repositories](https://www.qovery.com/docs/api-reference/helm-repositories/list-organization-helm-repositories.md) - [Create a helm repository](https://www.qovery.com/docs/api-reference/helm-repositories/create-a-helm-repository.md) - [Get a helm repository](https://www.qovery.com/docs/api-reference/helm-repositories/get-a-helm-repository.md) - [Edit a helm repository](https://www.qovery.com/docs/api-reference/helm-repositories/edit-a-helm-repository.md) - [Delete a helm repository](https://www.qovery.com/docs/api-reference/helm-repositories/delete-a-helm-repository.md) - [List helm charts contained inside the repository](https://www.qovery.com/docs/api-reference/helm-repositories/list-helm-charts-contained-inside-the-repository.md) ### Project Main Calls - [Get project by ID](https://www.qovery.com/docs/api-reference/project-main-calls/get-project-by-id.md) - [Edit a project](https://www.qovery.com/docs/api-reference/project-main-calls/edit-a-project.md): To edit a project you must have the admin permission - [Delete a project](https://www.qovery.com/docs/api-reference/project-main-calls/delete-a-project.md): To delete a project you must have the admin permission ### Project Deployment Rule - [List project deployment rules](https://www.qovery.com/docs/api-reference/project-deployment-rule/list-project-deployment-rules.md): List project deployment rules - [Create a deployment rule](https://www.qovery.com/docs/api-reference/project-deployment-rule/create-a-deployment-rule.md): Create a deployment rule - [Get a project deployment rule](https://www.qovery.com/docs/api-reference/project-deployment-rule/get-a-project-deployment-rule.md): Get a project deployment rule - [Edit a project deployment rule](https://www.qovery.com/docs/api-reference/project-deployment-rule/edit-a-project-deployment-rule.md): Edit a project deployment rule - [Delete a project deployment rule](https://www.qovery.com/docs/api-reference/project-deployment-rule/delete-a-project-deployment-rule.md): Delete a project deployment rule - [Update deployment rules priority order](https://www.qovery.com/docs/api-reference/project-deployment-rule/update-deployment-rules-priority-order.md): Update deployment rules priority order ### Environments - [List environments](https://www.qovery.com/docs/api-reference/environments/list-environments.md) - [Create an environment](https://www.qovery.com/docs/api-reference/environments/create-an-environment.md) - [List environments statuses](https://www.qovery.com/docs/api-reference/environments/list-environments-statuses.md): Returns a list of environments with only their id and status. - [List total number of services for each environment of the project](https://www.qovery.com/docs/api-reference/environments/list-total-number-of-services-for-each-environment-of-the-project.md): Returns a list of environment ids, and for each its total numberof services - [List environments overview](https://www.qovery.com/docs/api-reference/environments/list-environments-overview.md): Returns a list of environments with their overview information including deployment status, service count, and cluster details. ### Project Environment Variable - [List project environment variables](https://www.qovery.com/docs/api-reference/project-environment-variable/list-project-environment-variables.md) - [Add an environment variable to the project](https://www.qovery.com/docs/api-reference/project-environment-variable/add-an-environment-variable-to-the-project.md): - Add an environment variable to the project. - If the environment variable key already exists, then it will be replaced by the new one. - If the environment variable value points toward an existing environment variable key, it will be considered as an alias. - [Edit an environment variable belonging to the project](https://www.qovery.com/docs/api-reference/project-environment-variable/edit-an-environment-variable-belonging-to-the-project.md): - You can't edit a BUILT_IN variable - 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 variable it is overriding (hierarchy is BUILT_IN > PROJECT > ENVIRONMENT > APPLICATION) - [Delete an environment variable from a project](https://www.qovery.com/docs/api-reference/project-environment-variable/delete-an-environment-variable-from-a-project.md): - To delete an environment variable you must have the project user permission - You can't delete a BUILT_IN variable - If you delete a variable having override or alias, the associated override/alias will be deleted as well - [Create an environment variable override at the project level](https://www.qovery.com/docs/api-reference/project-environment-variable/create-an-environment-variable-override-at-the-project-level.md): - Allows you to override at project level an environment variable that has a higher scope. - You only have to specify a value in the request body - The system will create a new environment variable at project level with the same key as the one corresponding to the variable id in the path - The respo… - [Create an environment variable alias at the project level](https://www.qovery.com/docs/api-reference/project-environment-variable/create-an-environment-variable-alias-at-the-project-level.md): - Allows you to add an alias at project level on an existing environment variable having higher scope, in order to customize its key. - You only have to specify a key in the request body - The system will create a new environment variable at project level with the same value as the one corresponding… ### Project Secret - [List project secrets](https://www.qovery.com/docs/api-reference/project-secret/list-project-secrets.md) - [Add a secret to the project](https://www.qovery.com/docs/api-reference/project-secret/add-a-secret-to-the-project.md): - Add a secret to the project. - If the secret key already exists, then it will be replaced by the new one. - If the secret value points toward an existing secret key, it will be considered as an alias. - [Edit a secret belonging to the project](https://www.qovery.com/docs/api-reference/project-secret/edit-a-secret-belonging-to-the-project.md): - 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) - [Delete a secret from a project](https://www.qovery.com/docs/api-reference/project-secret/delete-a-secret-from-a-project.md): - To delete a secret you must have the project user permission - You can't delete a BUILT_IN secret - If you delete a secret having override or alias, the associated override/alias will be deleted as well operationId: deleteProjectSecret - [Create a secret override at the project level](https://www.qovery.com/docs/api-reference/project-secret/create-a-secret-override-at-the-project-level.md): - Allows you to override at project level a secret that has a higher scope. - You only have to specify a value in the request body - The system will create a new secret at project level with the same key as the one corresponding to the secret id in the path - The response body will contain the newly… - [Create a secret alias at the project level](https://www.qovery.com/docs/api-reference/project-secret/create-a-secret-alias-at-the-project-level.md): - Allows you to add an alias at project level on an existing secret having higher scope, in order to customize its key. - You only have to specify a key in the request body - The system will create a new secret at project level with the same value as the one corresponding to the secret id in the pat… ### Environment Main Calls - [Get environment by ID](https://www.qovery.com/docs/api-reference/environment-main-calls/get-environment-by-id.md) - [Edit an environment](https://www.qovery.com/docs/api-reference/environment-main-calls/edit-an-environment.md): To edit an environment you must have the admin permission - [Delete an environment](https://www.qovery.com/docs/api-reference/environment-main-calls/delete-an-environment.md): To delete an environment you must have the admin permission - [Get environment status](https://www.qovery.com/docs/api-reference/environment-main-calls/get-environment-status.md) - [Get environment statuses with services status](https://www.qovery.com/docs/api-reference/environment-main-calls/get-environment-statuses-with-services-status.md) - [Get environment statuses with stages](https://www.qovery.com/docs/api-reference/environment-main-calls/get-environment-statuses-with-stages.md) - [List Services By EnvironmentId](https://www.qovery.com/docs/api-reference/environment-main-calls/list-services-by-environmentid.md) - [List Deployment Queue Request By EnvironmentId](https://www.qovery.com/docs/api-reference/environment-main-calls/list-deployment-queue-request-by-environmentid.md) - [List Deployment Queue Request By ServiceId](https://www.qovery.com/docs/api-reference/environment-main-calls/list-deployment-queue-request-by-serviceid.md) ### Deployment Stage Main Calls - [List environment deployment stage](https://www.qovery.com/docs/api-reference/deployment-stage-main-calls/list-environment-deployment-stage.md) - [Create environment deployment stage](https://www.qovery.com/docs/api-reference/deployment-stage-main-calls/create-environment-deployment-stage.md) - [Get Deployment Stage](https://www.qovery.com/docs/api-reference/deployment-stage-main-calls/get-deployment-stage.md) - [Edit deployment stage](https://www.qovery.com/docs/api-reference/deployment-stage-main-calls/edit-deployment-stage.md) - [Delete deployment stage](https://www.qovery.com/docs/api-reference/deployment-stage-main-calls/delete-deployment-stage.md) - [Attach service to deployment stage](https://www.qovery.com/docs/api-reference/deployment-stage-main-calls/attach-service-to-deployment-stage.md): Moves the service to the specified deployment stage. To skip a service from environment-level deployments while keeping it in its current stage, set `is_skipped: true` in the request body. Moving the service to a different stage automatically un-skips it (sets `is_skipped: false`). - [Move deployment stage before requested stage](https://www.qovery.com/docs/api-reference/deployment-stage-main-calls/move-deployment-stage-before-requested-stage.md) - [Move deployment stage after requested stage](https://www.qovery.com/docs/api-reference/deployment-stage-main-calls/move-deployment-stage-after-requested-stage.md) - [Get Service Deployment Stage](https://www.qovery.com/docs/api-reference/deployment-stage-main-calls/get-service-deployment-stage.md) ### Environment Deployment Rule - [Get environment deployment rule](https://www.qovery.com/docs/api-reference/environment-deployment-rule/get-environment-deployment-rule.md) - [Edit an environment deployment rule](https://www.qovery.com/docs/api-reference/environment-deployment-rule/edit-an-environment-deployment-rule.md) ### Environment Actions - [Deploy environment](https://www.qovery.com/docs/api-reference/environment-actions/deploy-environment.md): This will deploy all the services of this environment to their latest version. - [Uninstall environment](https://www.qovery.com/docs/api-reference/environment-actions/uninstall-environment.md): This will uninstall all the services of this environment. - [Stop environment](https://www.qovery.com/docs/api-reference/environment-actions/stop-environment.md) - [Redeploy environment](https://www.qovery.com/docs/api-reference/environment-actions/redeploy-environment.md) - [Cancel environment deployment](https://www.qovery.com/docs/api-reference/environment-actions/cancel-environment-deployment.md): Cancel the current deployment of your environment. - [Clone environment](https://www.qovery.com/docs/api-reference/environment-actions/clone-environment.md): You must provide a name. This will create a new environment, with the same configuration, and same applications and databases. Database data is not cloned. - [Deploy services](https://www.qovery.com/docs/api-reference/environment-actions/deploy-services.md): Update and deploy the selected services - [Reboot services](https://www.qovery.com/docs/api-reference/environment-actions/reboot-services.md): Update and reboot the selected services - [Stop services](https://www.qovery.com/docs/api-reference/environment-actions/stop-services.md): Stop selected services - [Delete services](https://www.qovery.com/docs/api-reference/environment-actions/delete-services.md): Delete selected services - [Uninstall services](https://www.qovery.com/docs/api-reference/environment-actions/uninstall-services.md): uninstall selected services - [Clean failed jobs within an environment](https://www.qovery.com/docs/api-reference/environment-actions/clean-failed-jobs-within-an-environment.md) ### Deployment Queue Actions - [Cancel deployment request](https://www.qovery.com/docs/api-reference/deployment-queue-actions/cancel-deployment-request.md): Cancel the a deployment request. ### Applications - [List applications](https://www.qovery.com/docs/api-reference/applications/list-applications.md) - [Create an application](https://www.qovery.com/docs/api-reference/applications/create-an-application.md) - [List all environment applications statuses](https://www.qovery.com/docs/api-reference/applications/list-all-environment-applications-statuses.md): Returns a list of applications with only their id and status. - [List default application advanced settings](https://www.qovery.com/docs/api-reference/applications/list-default-application-advanced-settings.md): Default values for each setting are available in [our documentation](https://hub.qovery.com/docs/using-qovery/configuration/advanced-settings/) - [Clone application](https://www.qovery.com/docs/api-reference/applications/clone-application.md): This will create a new application with the same configuration on the targeted environment Id. ### Jobs - [Auto deploy jobs](https://www.qovery.com/docs/api-reference/jobs/auto-deploy-jobs.md): Triggers a new job deploy in each environment matching the following conditions - environment should have the auto-deploy enabled - the job should have the same image name and a different tag - [List default job advanced settings](https://www.qovery.com/docs/api-reference/jobs/list-default-job-advanced-settings.md): Default values for each setting is available in [our documentation](https://hub.qovery.com/docs/using-qovery/configuration/advanced-settings/) - [List jobs](https://www.qovery.com/docs/api-reference/jobs/list-jobs.md) - [Create a job](https://www.qovery.com/docs/api-reference/jobs/create-a-job.md) - [List all environment job statuses](https://www.qovery.com/docs/api-reference/jobs/list-all-environment-job-statuses.md): Returns a list of jobs with only their id and status. - [Clone job](https://www.qovery.com/docs/api-reference/jobs/clone-job.md): This will create a new job with the same configuration on the targeted environment Id. ### Environment Logs - [List environment deployment logs](https://www.qovery.com/docs/api-reference/environment-logs/list-environment-deployment-logs.md): This returns the last 1000 environment deployment logs. - [List environment deployment logs v2](https://www.qovery.com/docs/api-reference/environment-logs/list-environment-deployment-logs-v2.md): This returns the last 1000 environment deployment logs v2 ### Environment Deployment History - [List environment deployments](https://www.qovery.com/docs/api-reference/environment-deployment-history/list-environment-deployments.md): List previous and current environment deployments with the status deployment and the related services. By default it returns the 20 last results. The response is paginated. In order to request the next page, you can use the startId query parameter - [List environment deployments](https://www.qovery.com/docs/api-reference/environment-deployment-history/list-environment-deployments-1.md): List previous and current environment deployments with the status deployment and the related services. By default it returns the 20 last results. The response is paginated. In order to request the next page, you can use the startId query parameter - [Generate a Grafana snapshot report showing build runner pod usage for a specific deployment](https://www.qovery.com/docs/api-reference/environment-deployment-history/generate-a-grafana-snapshot-report-showing-build-runner-pod-usage-for-a-specific-deployment.md): Generate a Grafana snapshot report that shows the resource usage (CPU, memory) of build runner pods for a specific deployment execution. The report is publicly accessible for the specified duration. ### Environment Variable - [List environment variables](https://www.qovery.com/docs/api-reference/environment-variable/list-environment-variables.md) - [Add an environment variable to the environment](https://www.qovery.com/docs/api-reference/environment-variable/add-an-environment-variable-to-the-environment.md): - Add an environment variable to the environment. - If the environment variable key already exists, then it will be replaced by the new one. - If the environment variable value points toward an existing environment variable key, it will be considered as an alias. - [Edit an environment variable belonging to the environment](https://www.qovery.com/docs/api-reference/environment-variable/edit-an-environment-variable-belonging-to-the-environment.md): - You can't edit a BUILT_IN variable - 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 variable it is overriding (hierarchy is BUILT_IN > PROJECT > ENVIRONMENT > APPLICATION) - [Delete an environment variable from an environment](https://www.qovery.com/docs/api-reference/environment-variable/delete-an-environment-variable-from-an-environment.md): - To delete an environment variable you must have the project user permission - You can't delete a BUILT_IN variable - If you delete a variable having override or alias, the associated override/alias will be deleted as well - [Create an environment variable override at the environment level](https://www.qovery.com/docs/api-reference/environment-variable/create-an-environment-variable-override-at-the-environment-level.md): - Allows you to override at environment level an environment variable that has a higher scope. - You only have to specify a value in the request body - The system will create a new environment variable at environment level with the same key as the one corresponding to the variable id in the path - T… - [Create an environment variable alias at the environment level](https://www.qovery.com/docs/api-reference/environment-variable/create-an-environment-variable-alias-at-the-environment-level.md): - Allows you to add an alias at environment level on an existing environment variable having higher scope, in order to customize its key. - You only have to specify a key in the request body - The system will create a new environment variable at environment level with the same value as the one corre… ### Environment Secret - [List environment secrets](https://www.qovery.com/docs/api-reference/environment-secret/list-environment-secrets.md) - [Add a secret to the environment](https://www.qovery.com/docs/api-reference/environment-secret/add-a-secret-to-the-environment.md): - Add a secret to the environment. - If the secret key already exists, then it will be replaced by the new one. - If the secret value points toward an existing secret key, it will be considered as an alias. - [Edit a secret belonging to the environment](https://www.qovery.com/docs/api-reference/environment-secret/edit-a-secret-belonging-to-the-environment.md): - 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) - [Delete a secret from the environment](https://www.qovery.com/docs/api-reference/environment-secret/delete-a-secret-from-the-environment.md): - To delete a secret you must have the project user permission - You can't delete a BUILT_IN secret - If you delete a secret having override or alias, the associated override/alias will be deleted as well operationId: deleteEnvironmentSecret - [Create a secret override at the environment level](https://www.qovery.com/docs/api-reference/environment-secret/create-a-secret-override-at-the-environment-level.md): - Allows you to override at environment level a secret that has a higher scope. - You only have to specify a value in the request body - The system will create a new secret at environment level with the same key as the one corresponding to the secret id in the path - The response body will contain t… - [Create a secret alias at the environment level](https://www.qovery.com/docs/api-reference/environment-secret/create-a-secret-alias-at-the-environment-level.md): - Allows you to add an alias at environment level on an existing secret having higher scope, in order to customize its key. - You only have to specify a key in the request body - The system will create a new secret at environment level with the same value as the one corresponding to the secret id in… ### Databases - [List eligible database types, versions and modes for the environment](https://www.qovery.com/docs/api-reference/databases/list-eligible-database-types-versions-and-modes-for-the-environment.md) - [List environment databases](https://www.qovery.com/docs/api-reference/databases/list-environment-databases.md) - [Create a database](https://www.qovery.com/docs/api-reference/databases/create-a-database.md) - [List all environment databases statuses](https://www.qovery.com/docs/api-reference/databases/list-all-environment-databases-statuses.md): Returns a list of databases with only their id and status. - [Clone database](https://www.qovery.com/docs/api-reference/databases/clone-database.md): This will create a new database with the same configuration on the targeted environment Id. ### Environment Export - [Export full environment and its resources into Terraform manifests](https://www.qovery.com/docs/api-reference/environment-export/export-full-environment-and-its-resources-into-terraform-manifests.md) ### Helms - [List default helm advanced settings](https://www.qovery.com/docs/api-reference/helms/list-default-helm-advanced-settings.md) - [List helms](https://www.qovery.com/docs/api-reference/helms/list-helms.md) - [Create a helm](https://www.qovery.com/docs/api-reference/helms/create-a-helm.md) - [Get helm default values](https://www.qovery.com/docs/api-reference/helms/get-helm-default-values.md) - [List all environment helm statuses](https://www.qovery.com/docs/api-reference/helms/list-all-environment-helm-statuses.md): Returns a list of helms with only their id and status. - [Clone helm](https://www.qovery.com/docs/api-reference/helms/clone-helm.md): This will create a new helm with the same configuration on the targeted environment Id. ### Application Main Calls - [Get application by ID](https://www.qovery.com/docs/api-reference/application-main-calls/get-application-by-id.md) - [Edit application](https://www.qovery.com/docs/api-reference/application-main-calls/edit-application.md): - To edit the application you must have the admin permission. - For port edition, if you provide a port id, we will update the corresponding port. If you don't we will create a new one. If you remove a port from the payload, we will delete it. - For storage edition, if you provide a storage id, we w… - [Delete application](https://www.qovery.com/docs/api-reference/application-main-calls/delete-application.md): To delete the application you must have the admin permission - [Get application status](https://www.qovery.com/docs/api-reference/application-main-calls/get-application-status.md) - [List contributors](https://www.qovery.com/docs/api-reference/application-main-calls/list-contributors.md) - [List last commits](https://www.qovery.com/docs/api-reference/application-main-calls/list-last-commits.md): Returns list of the last 100 commits made on the repository linked to the application - [List all URLs of the application](https://www.qovery.com/docs/api-reference/application-main-calls/list-all-urls-of-the-application.md): This will return all the custom domains and Qovery autogenerated domain for the given application ### Application Deployment Restriction - [Get application deployment restrictions](https://www.qovery.com/docs/api-reference/application-deployment-restriction/get-application-deployment-restrictions.md): Get application deployment restrictions - [Create an application deployment restriction](https://www.qovery.com/docs/api-reference/application-deployment-restriction/create-an-application-deployment-restriction.md): Create an application deployment restriction - [Edit an application deployment restriction](https://www.qovery.com/docs/api-reference/application-deployment-restriction/edit-an-application-deployment-restriction.md): Edit an application deployment restriction - [Delete an application deployment restriction](https://www.qovery.com/docs/api-reference/application-deployment-restriction/delete-an-application-deployment-restriction.md): Delete an application deployment restriction ### Application Actions - [Deploy application](https://www.qovery.com/docs/api-reference/application-actions/deploy-application.md): You must provide a git commit id - [Uninstall application](https://www.qovery.com/docs/api-reference/application-actions/uninstall-application.md): Delete the resources of an application but keep the Qovery config. - [Stop application](https://www.qovery.com/docs/api-reference/application-actions/stop-application.md) - [Redeploy application](https://www.qovery.com/docs/api-reference/application-actions/redeploy-application.md) - [Reboot application](https://www.qovery.com/docs/api-reference/application-actions/reboot-application.md) ### Application Deployment History - [List application deploys](https://www.qovery.com/docs/api-reference/application-deployment-history/list-application-deploys.md): By default it returns the 20 last results. The response is paginated. In order to request the next page, you can use the startId query parameter. You can also filter by status (FAILED or SUCCESS), and git_commit_id - [List application deploys](https://www.qovery.com/docs/api-reference/application-deployment-history/list-application-deploys-1.md): By default it returns the 20 last results. The response is paginated. In order to request the next page, you can use the startId query parameter. You can also filter by status (FAILED or SUCCESS), and git_commit_id ### Application Environment Variable - [List environment variables](https://www.qovery.com/docs/api-reference/application-environment-variable/list-environment-variables.md) - [Add an environment variable to the application](https://www.qovery.com/docs/api-reference/application-environment-variable/add-an-environment-variable-to-the-application.md): - Add an environment variable to the application. - [Import variables](https://www.qovery.com/docs/api-reference/application-environment-variable/import-variables.md): Import environment variables in a defined scope, with a defined visibility. - [Edit an environment variable belonging to the application](https://www.qovery.com/docs/api-reference/application-environment-variable/edit-an-environment-variable-belonging-to-the-application.md): - You can't edit a BUILT_IN variable - 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 variable it is overriding (hierarchy is BUILT_IN > PROJECT > ENVIRONMENT > APPLICATION) - [Delete an environment variable from an application](https://www.qovery.com/docs/api-reference/application-environment-variable/delete-an-environment-variable-from-an-application.md): - To delete an environment variable from an application you must have the project user permission - You can't delete a BUILT_IN variable - If you delete a variable having override or alias, the associated override/alias will be deleted as well - [Create an environment variable override at the application level](https://www.qovery.com/docs/api-reference/application-environment-variable/create-an-environment-variable-override-at-the-application-level.md): - Allows you to override at application level an environment variable that has a higher scope. - You only have to specify a value in the request body - The system will create a new environment variable at application level with the same key as the one corresponding to the variable id in the path - T… - [Create an environment variable alias at the application level](https://www.qovery.com/docs/api-reference/application-environment-variable/create-an-environment-variable-alias-at-the-application-level.md): - Allows you to add an alias at application level on an existing environment variable having higher scope, in order to customize its key. - You only have to specify a key in the request body - The system will create a new environment variable at application level with the same value as the one corre… ### Application Secret - [List application secrets](https://www.qovery.com/docs/api-reference/application-secret/list-application-secrets.md): Secrets are like environment variables, but they are secured and can't be revealed. - [Add a secret to the application](https://www.qovery.com/docs/api-reference/application-secret/add-a-secret-to-the-application.md): - Add a secret to the application. - [Edit a secret belonging to the application](https://www.qovery.com/docs/api-reference/application-secret/edit-a-secret-belonging-to-the-application.md): - 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) - [Delete a secret from an application](https://www.qovery.com/docs/api-reference/application-secret/delete-a-secret-from-an-application.md): - To delete a secret you must have the project user permission - You can't delete a BUILT_IN secret - If you delete a secret having override or alias, the associated override/alias will be deleted as well - [Create a secret override at the application level](https://www.qovery.com/docs/api-reference/application-secret/create-a-secret-override-at-the-application-level.md): - Allows you to override at application level a secret that has a higher scope. - You only have to specify a value in the request body - The system will create a new secret at application level with the same key as the one corresponding to the secret id in the path - The response body will contain t… - [Create a secret alias at the application level](https://www.qovery.com/docs/api-reference/application-secret/create-a-secret-alias-at-the-application-level.md): - Allows you to add an alias at application level on an existing secret having higher scope, in order to customize its key. - You only have to specify a key in the request body - The system will create a new secret at application level with the same value as the one corresponding to the secret id in… ### Application Custom Domain - [List application custom domains](https://www.qovery.com/docs/api-reference/application-custom-domain/list-application-custom-domains.md) - [Add custom domain to the application.](https://www.qovery.com/docs/api-reference/application-custom-domain/add-custom-domain-to-the-application.md): Add a custom domain to this application in order not to use qovery autogenerated domain - [Edit a Custom Domain](https://www.qovery.com/docs/api-reference/application-custom-domain/edit-a-custom-domain.md): To edit a Custom Domain you must have the project user permission - [Delete a Custom Domain](https://www.qovery.com/docs/api-reference/application-custom-domain/delete-a-custom-domain.md): To delete an CustomDomain you must have the project user permission - [Get Custom Domain status](https://www.qovery.com/docs/api-reference/application-custom-domain/get-custom-domain-status.md) - [Check Application Custom Domain](https://www.qovery.com/docs/api-reference/application-custom-domain/check-application-custom-domain.md) ### Application Logs - [List logs](https://www.qovery.com/docs/api-reference/application-logs/list-logs.md): This will list the last 1000 logs of the application ### Application Configuration - [Get Application Network information](https://www.qovery.com/docs/api-reference/application-configuration/get-application-network-information.md): Get status of the application network settings. - [Edit Application Network](https://www.qovery.com/docs/api-reference/application-configuration/edit-application-network.md): Edit the Network settings of the application. - [Get advanced settings](https://www.qovery.com/docs/api-reference/application-configuration/get-advanced-settings.md): Get list and values of the advanced settings of the application. Default values for each setting are available in [our documentation](https://hub.qovery.com/docs/using-qovery/configuration/advanced-settings/) - [Edit advanced settings](https://www.qovery.com/docs/api-reference/application-configuration/edit-advanced-settings.md): Edit advanced settings by returning table of advanced settings. ### Container Main Calls - [Get container by ID](https://www.qovery.com/docs/api-reference/container-main-calls/get-container-by-id.md) - [Edit container](https://www.qovery.com/docs/api-reference/container-main-calls/edit-container.md): - To edit the container you must have the admin permission. - For port edition, if you provide a port id, we will update the corresponding port. If you don't we will create a new one. If you remove a port from the payload, we will delete it. - For storage edition, if you provide a storage id, we wil… - [Delete container](https://www.qovery.com/docs/api-reference/container-main-calls/delete-container.md): To delete the container you must have the admin permission - [Get container status](https://www.qovery.com/docs/api-reference/container-main-calls/get-container-status.md) - [List all URLs of the container](https://www.qovery.com/docs/api-reference/container-main-calls/list-all-urls-of-the-container.md): This will return all the custom domains and Qovery autogenerated domain for the given container ### Container Deployment History - [List container deployments](https://www.qovery.com/docs/api-reference/container-deployment-history/list-container-deployments.md): Returns the 20 last container deployments - [List container deployments](https://www.qovery.com/docs/api-reference/container-deployment-history/list-container-deployments-1.md): Returns the 20 last container deployments ### Container Configuration - [Get advanced settings](https://www.qovery.com/docs/api-reference/container-configuration/get-advanced-settings.md): Get list and values of the advanced settings of the container. Default values for each setting are available in [our documentation](https://hub.qovery.com/docs/using-qovery/configuration/advanced-settings/) - [Edit advanced settings](https://www.qovery.com/docs/api-reference/container-configuration/edit-advanced-settings.md): Edit advanced settings by returning table of advanced settings. - [Get Container Network information](https://www.qovery.com/docs/api-reference/container-configuration/get-container-network-information.md): Get status of the container network settings. - [Edit Container Network](https://www.qovery.com/docs/api-reference/container-configuration/edit-container-network.md): Edit the Network settings of the container. ### Container Actions - [Deploy container](https://www.qovery.com/docs/api-reference/container-actions/deploy-container.md): You must provide a container image tag - [Uninstall container](https://www.qovery.com/docs/api-reference/container-actions/uninstall-container.md): Delete the resources of the container but keep Qovery configuration - [Stop container](https://www.qovery.com/docs/api-reference/container-actions/stop-container.md) - [Redeploy container](https://www.qovery.com/docs/api-reference/container-actions/redeploy-container.md) - [Reboot container](https://www.qovery.com/docs/api-reference/container-actions/reboot-container.md) ### Container Environment Variable - [List environment variables](https://www.qovery.com/docs/api-reference/container-environment-variable/list-environment-variables.md) - [Add an environment variable to the container](https://www.qovery.com/docs/api-reference/container-environment-variable/add-an-environment-variable-to-the-container.md): - Add an environment variable to the container. - [Import variables](https://www.qovery.com/docs/api-reference/container-environment-variable/import-variables.md): Import environment variables in a defined scope, with a defined visibility. - [Edit an environment variable belonging to the container](https://www.qovery.com/docs/api-reference/container-environment-variable/edit-an-environment-variable-belonging-to-the-container.md): - You can't edit a BUILT_IN variable - 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 variable it is overriding (hierarchy is BUILT_IN > PROJECT > ENVIRONMENT > CONTAINER) - [Delete an environment variable from a container](https://www.qovery.com/docs/api-reference/container-environment-variable/delete-an-environment-variable-from-a-container.md): - To delete an environment variable from an container you must have the project user permission - You can't delete a BUILT_IN variable - If you delete a variable having override or alias, the associated override/alias will be deleted as well - [Create an environment variable override at the container level](https://www.qovery.com/docs/api-reference/container-environment-variable/create-an-environment-variable-override-at-the-container-level.md): - Allows you to override at container level an environment variable that has a higher scope. - You only have to specify a value in the request body - The system will create a new environment variable at container level with the same key as the one corresponding to the variable id in the path - The r… - [Create an environment variable alias at the container level](https://www.qovery.com/docs/api-reference/container-environment-variable/create-an-environment-variable-alias-at-the-container-level.md): - Allows you to add an alias at container level on an existing environment variable having higher scope, in order to customize its key. - You only have to specify a key in the request body - The system will create a new environment variable at container level with the same value as the one correspon… ### Container Secret - [List container secrets](https://www.qovery.com/docs/api-reference/container-secret/list-container-secrets.md): Secrets are like environment variables, but they are secured and can't be revealed. - [Add a secret to the container](https://www.qovery.com/docs/api-reference/container-secret/add-a-secret-to-the-container.md): - Add a secret to the container. - [Edit a secret belonging to the container](https://www.qovery.com/docs/api-reference/container-secret/edit-a-secret-belonging-to-the-container.md): - 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 > CONTAINER) - [Delete a secret from an container](https://www.qovery.com/docs/api-reference/container-secret/delete-a-secret-from-an-container.md): - To delete a secret you must have the project user permission - You can't delete a BUILT_IN secret - If you delete a secret having override or alias, the associated override/alias will be deleted as well - [Create a secret override at the container level](https://www.qovery.com/docs/api-reference/container-secret/create-a-secret-override-at-the-container-level.md): - Allows you to override at container level a secret that has a higher scope. - You only have to specify a value in the request body - The system will create a new secret at container level with the same key as the one corresponding to the secret id in the path - The response body will contain the n… - [Create a secret alias at the container level](https://www.qovery.com/docs/api-reference/container-secret/create-a-secret-alias-at-the-container-level.md): - Allows you to add an alias at container level on an existing secret having higher scope, in order to customize its key. - You only have to specify a key in the request body - The system will create a new secret at container level with the same value as the one corresponding to the secret id in the… ### Container Custom Domain - [List container custom domains](https://www.qovery.com/docs/api-reference/container-custom-domain/list-container-custom-domains.md) - [Add custom domain to the container.](https://www.qovery.com/docs/api-reference/container-custom-domain/add-custom-domain-to-the-container.md): Add a custom domain to this container in order not to use qovery autogenerated domain - [Edit a Custom Domain](https://www.qovery.com/docs/api-reference/container-custom-domain/edit-a-custom-domain.md): To edit a Custom Domain you must have the project user permission - [Delete a Custom Domain](https://www.qovery.com/docs/api-reference/container-custom-domain/delete-a-custom-domain.md): To delete an CustomDomain you must have the project user permission - [Get Custom Domain status](https://www.qovery.com/docs/api-reference/container-custom-domain/get-custom-domain-status.md) - [Check Container Custom Domain](https://www.qovery.com/docs/api-reference/container-custom-domain/check-container-custom-domain.md) ### Container Logs - [List logs](https://www.qovery.com/docs/api-reference/container-logs/list-logs.md): This will list the last 1000 logs of the container ### Database Main Calls - [Get database by ID](https://www.qovery.com/docs/api-reference/database-main-calls/get-database-by-id.md) - [Edit a database ](https://www.qovery.com/docs/api-reference/database-main-calls/edit-a-database.md): To edit a database you must have the admin permission - [Delete a database ](https://www.qovery.com/docs/api-reference/database-main-calls/delete-a-database.md): To delete a database you must have the admin permission - [Get database status](https://www.qovery.com/docs/api-reference/database-main-calls/get-database-status.md) - [List eligible versions for the database](https://www.qovery.com/docs/api-reference/database-main-calls/list-eligible-versions-for-the-database.md) - [Get master credentials of the database](https://www.qovery.com/docs/api-reference/database-main-calls/get-master-credentials-of-the-database.md) ### Database Application - [List applications using the database](https://www.qovery.com/docs/api-reference/database-application/list-applications-using-the-database.md) - [Remove an application from this database ](https://www.qovery.com/docs/api-reference/database-application/remove-an-application-from-this-database.md) ### Database Actions - [Redeploy database](https://www.qovery.com/docs/api-reference/database-actions/redeploy-database.md) - [Retart database](https://www.qovery.com/docs/api-reference/database-actions/retart-database.md) - [Stop database](https://www.qovery.com/docs/api-reference/database-actions/stop-database.md) - [Deploy database ](https://www.qovery.com/docs/api-reference/database-actions/deploy-database.md) - [Uninstall database](https://www.qovery.com/docs/api-reference/database-actions/uninstall-database.md) ### Database Deployment History - [List database deploys](https://www.qovery.com/docs/api-reference/database-deployment-history/list-database-deploys.md): By default it returns the 20 last results. The response is paginated. - [List database deploys](https://www.qovery.com/docs/api-reference/database-deployment-history/list-database-deploys-1.md): By default it returns the 20 last results. The response is paginated. ### Backups - [List database backups](https://www.qovery.com/docs/api-reference/backups/list-database-backups.md): By default it returns the 20 last results. The response is paginated. In order to request the next page, you can use the startId query parameter - [Add a backup to the Database ](https://www.qovery.com/docs/api-reference/backups/add-a-backup-to-the-database.md) - [Remove database backup](https://www.qovery.com/docs/api-reference/backups/remove-database-backup.md) ### Account Info - [Get Account information](https://www.qovery.com/docs/api-reference/account-info/get-account-information.md) - [Edit account information](https://www.qovery.com/docs/api-reference/account-info/edit-account-information.md) ### Referral & Rewards - [Get your referral information](https://www.qovery.com/docs/api-reference/referral-&-rewards/get-your-referral-information.md) - [Claim a reward](https://www.qovery.com/docs/api-reference/referral-&-rewards/claim-a-reward.md): A same code can be claimed only 3 times at max ### User Sign Up - [Get Sign up information](https://www.qovery.com/docs/api-reference/user-sign-up/get-sign-up-information.md): Retrieve the Sign Up information of the user - [Send Sign Up request](https://www.qovery.com/docs/api-reference/user-sign-up/send-sign-up-request.md): Send a Sign Up request containing the user information ### Helm Main Calls - [Get helm by ID](https://www.qovery.com/docs/api-reference/helm-main-calls/get-helm-by-id.md) - [Edit helm](https://www.qovery.com/docs/api-reference/helm-main-calls/edit-helm.md): - To edit the helm you must have the admin permission. - [Delete helm](https://www.qovery.com/docs/api-reference/helm-main-calls/delete-helm.md): To delete the helm you must have the admin permission - [List last helm commits](https://www.qovery.com/docs/api-reference/helm-main-calls/list-last-helm-commits.md): Returns list of the last 100 commits made on the repository linked to helm - [Get helm status](https://www.qovery.com/docs/api-reference/helm-main-calls/get-helm-status.md) - [List all URLs of the helm](https://www.qovery.com/docs/api-reference/helm-main-calls/list-all-urls-of-the-helm.md): This will return all the custom domains and Qovery autogenerated domain for the given helm - [Get helm kubernetes services](https://www.qovery.com/docs/api-reference/helm-main-calls/get-helm-kubernetes-services.md): Get helm kubernetes services ### Helm Configuration - [Get advanced settings](https://www.qovery.com/docs/api-reference/helm-configuration/get-advanced-settings.md): Get list and values of the advanced settings of the helm. - [Edit advanced settings](https://www.qovery.com/docs/api-reference/helm-configuration/edit-advanced-settings.md): Edit advanced settings by returning table of advanced settings. ### Helm Actions - [Deploy helm](https://www.qovery.com/docs/api-reference/helm-actions/deploy-helm.md): You must provide a git commit id or a helm version depending on the source location of your code (git vs helm repository). - [Uninstall helm](https://www.qovery.com/docs/api-reference/helm-actions/uninstall-helm.md): Delete the resources of the helm but keep Qovery configuration - [Redeploy helm](https://www.qovery.com/docs/api-reference/helm-actions/redeploy-helm.md) - [Stop helm](https://www.qovery.com/docs/api-reference/helm-actions/stop-helm.md) ### Helm Deployment History - [List helm deployments](https://www.qovery.com/docs/api-reference/helm-deployment-history/list-helm-deployments.md): Returns the 20 last helm deployments - [List helm deployments](https://www.qovery.com/docs/api-reference/helm-deployment-history/list-helm-deployments-1.md): Returns the 20 last helm deployments ### Helm Deployment Restriction - [Get helm deployment restrictions](https://www.qovery.com/docs/api-reference/helm-deployment-restriction/get-helm-deployment-restrictions.md): Get helm deployment restrictions - [Create a helm deployment restriction](https://www.qovery.com/docs/api-reference/helm-deployment-restriction/create-a-helm-deployment-restriction.md): Create a helm deployment restriction - [Edit a helm deployment restriction](https://www.qovery.com/docs/api-reference/helm-deployment-restriction/edit-a-helm-deployment-restriction.md): Edit a helm deployment restriction - [Delete a helm deployment restriction](https://www.qovery.com/docs/api-reference/helm-deployment-restriction/delete-a-helm-deployment-restriction.md): Delete a helm deployment restriction ### Helm Custom Domain - [List helm custom domains](https://www.qovery.com/docs/api-reference/helm-custom-domain/list-helm-custom-domains.md): List the custom domains of this helm - [Add custom domain to the helm.](https://www.qovery.com/docs/api-reference/helm-custom-domain/add-custom-domain-to-the-helm.md): Add a custom domain to this helm in order not to use qovery autogenerated domain - [Get a Custom Domain](https://www.qovery.com/docs/api-reference/helm-custom-domain/get-a-custom-domain.md): Get a custom domain - [Edit a Custom Domain](https://www.qovery.com/docs/api-reference/helm-custom-domain/edit-a-custom-domain.md): To edit a Custom Domain you must have the project user permission - [Delete a Custom Domain](https://www.qovery.com/docs/api-reference/helm-custom-domain/delete-a-custom-domain.md): To delete an CustomDomain you must have the project user permission - [Check Helm Custom Domain](https://www.qovery.com/docs/api-reference/helm-custom-domain/check-helm-custom-domain.md) ### Environment - [Check dockerfile configuration is correct](https://www.qovery.com/docs/api-reference/environment/check-dockerfile-configuration-is-correct.md) - [Check helm repository configuration is correct](https://www.qovery.com/docs/api-reference/environment/check-helm-repository-configuration-is-correct.md) - [Check container image configuration is correct](https://www.qovery.com/docs/api-reference/environment/check-container-image-configuration-is-correct.md) - [Check git file configuration is correct](https://www.qovery.com/docs/api-reference/environment/check-git-file-configuration-is-correct.md) - [List environment services links](https://www.qovery.com/docs/api-reference/environment/list-environment-services-links.md): List services links of an environment ### Job Main Calls - [Get job by ID](https://www.qovery.com/docs/api-reference/job-main-calls/get-job-by-id.md) - [Edit job](https://www.qovery.com/docs/api-reference/job-main-calls/edit-job.md): - To edit the job you must have the admin permission. - [Delete job](https://www.qovery.com/docs/api-reference/job-main-calls/delete-job.md): To delete the job you must have the admin permission - [Get job status](https://www.qovery.com/docs/api-reference/job-main-calls/get-job-status.md) - [List last job commits](https://www.qovery.com/docs/api-reference/job-main-calls/list-last-job-commits.md): Returns list of the last 100 commits made on the repository linked to the job ### Job Configuration - [Get advanced settings](https://www.qovery.com/docs/api-reference/job-configuration/get-advanced-settings.md): Get list and values of the advanced settings of the job. Default values for each setting are available in [our documentation](https://hub.qovery.com/docs/using-qovery/configuration/advanced-settings/) - [Edit advanced settings](https://www.qovery.com/docs/api-reference/job-configuration/edit-advanced-settings.md): Edit advanced settings by returning table of advanced settings. ### Job Actions - [Deploy job](https://www.qovery.com/docs/api-reference/job-actions/deploy-job.md): You must provide a git commit id or an image tag depending on the source location of your code (git vs image repository). - [Uninstall job](https://www.qovery.com/docs/api-reference/job-actions/uninstall-job.md): Delete the resources of the job but keep Qovery configuration - [Redeploy job](https://www.qovery.com/docs/api-reference/job-actions/redeploy-job.md) - [Stop job](https://www.qovery.com/docs/api-reference/job-actions/stop-job.md) - [Clean a failed job](https://www.qovery.com/docs/api-reference/job-actions/clean-a-failed-job.md) ### Terraform Actions - [Redeploy terraform](https://www.qovery.com/docs/api-reference/terraform-actions/redeploy-terraform.md) - [Deploy terraform](https://www.qovery.com/docs/api-reference/terraform-actions/deploy-terraform.md): You must provide a git commit id. - [Uninstall terraform](https://www.qovery.com/docs/api-reference/terraform-actions/uninstall-terraform.md): Delete the resources of the terraform but keep Qovery configuration ### Job Deployment History - [List job deployments](https://www.qovery.com/docs/api-reference/job-deployment-history/list-job-deployments.md): Returns the 20 last job deployments - [List job deployments](https://www.qovery.com/docs/api-reference/job-deployment-history/list-job-deployments-1.md): Returns the 20 last job deployments ### Job Deployment Restriction - [Get job deployment restrictions](https://www.qovery.com/docs/api-reference/job-deployment-restriction/get-job-deployment-restrictions.md): Get job deployment restrictions - [Create a job deployment restriction](https://www.qovery.com/docs/api-reference/job-deployment-restriction/create-a-job-deployment-restriction.md): Create a job deployment restriction - [Edit a job deployment restriction](https://www.qovery.com/docs/api-reference/job-deployment-restriction/edit-a-job-deployment-restriction.md): Edit a job deployment restriction - [Delete a job deployment restriction](https://www.qovery.com/docs/api-reference/job-deployment-restriction/delete-a-job-deployment-restriction.md): Delete a job deployment restriction ### Job Environment Variable - [List environment variables](https://www.qovery.com/docs/api-reference/job-environment-variable/list-environment-variables.md) - [Add an environment variable to the job](https://www.qovery.com/docs/api-reference/job-environment-variable/add-an-environment-variable-to-the-job.md): - Add an environment variable to the job. - [Import variables](https://www.qovery.com/docs/api-reference/job-environment-variable/import-variables.md): Import environment variables in a defined scope, with a defined visibility. - [Edit an environment variable belonging to the job](https://www.qovery.com/docs/api-reference/job-environment-variable/edit-an-environment-variable-belonging-to-the-job.md): - You can't edit a BUILT_IN variable - 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 variable it is overriding (hierarchy is BUILT_IN > PROJECT > ENVIRONMENT > CONTAINER) - [Delete an environment variable from a job](https://www.qovery.com/docs/api-reference/job-environment-variable/delete-an-environment-variable-from-a-job.md): - To delete an environment variable from an job you must have the project user permission - You can't delete a BUILT_IN variable - If you delete a variable having override or alias, the associated override/alias will be deleted as well - [Create an environment variable override at the job level](https://www.qovery.com/docs/api-reference/job-environment-variable/create-an-environment-variable-override-at-the-job-level.md): - Allows you to override at job level an environment variable that has a higher scope. - You only have to specify a value in the request body - The system will create a new environment variable at job level with the same key as the one corresponding to the variable id in the path - The response body… - [Create an environment variable alias at the job level](https://www.qovery.com/docs/api-reference/job-environment-variable/create-an-environment-variable-alias-at-the-job-level.md): - Allows you to add an alias at job level on an existing environment variable having higher scope, in order to customize its key. - You only have to specify a key in the request body - The system will create a new environment variable at job level with the same value as the one corresponding to the… ### Job Secret - [List job secrets](https://www.qovery.com/docs/api-reference/job-secret/list-job-secrets.md): Secrets are like environment variables, but they are secured and can't be revealed. - [Add a secret to the job](https://www.qovery.com/docs/api-reference/job-secret/add-a-secret-to-the-job.md): - Add a secret to the job. - [Edit a secret belonging to the job](https://www.qovery.com/docs/api-reference/job-secret/edit-a-secret-belonging-to-the-job.md): - 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 > CONTAINER) - [Delete a secret from an job](https://www.qovery.com/docs/api-reference/job-secret/delete-a-secret-from-an-job.md): - To delete a secret you must have the project user permission - You can't delete a BUILT_IN secret - If you delete a secret having override or alias, the associated override/alias will be deleted as well - [Create a secret override at the job level](https://www.qovery.com/docs/api-reference/job-secret/create-a-secret-override-at-the-job-level.md): - Allows you to override at job level a secret that has a higher scope. - You only have to specify a value in the request body - The system will create a new secret at job level with the same key as the one corresponding to the secret id in the path - The response body will contain the newly created… - [Create a secret alias at the job level](https://www.qovery.com/docs/api-reference/job-secret/create-a-secret-alias-at-the-job-level.md): - Allows you to add an alias at job level on an existing secret having higher scope, in order to customize its key. - You only have to specify a key in the request body - The system will create a new secret at job level with the same value as the one corresponding to the secret id in the path - The… ### Service Main Calls - [Get git webhook status for a service](https://www.qovery.com/docs/api-reference/service-main-calls/get-git-webhook-status-for-a-service.md): Returns the webhook status for a git-based service. Checks if the Qovery webhook is correctly configured on the git provider (GitHub, GitLab, or Bitbucket). - [Synchronize git webhook for a service](https://www.qovery.com/docs/api-reference/service-main-calls/synchronize-git-webhook-for-a-service.md): Synchronizes the Qovery webhook configuration for a git-based service. - If no webhook exists, creates one with the correct configuration - If webhook exists but is misconfigured, updates it with the correct events - If webhook is already correctly configured, returns current status Works with GitHu… ### Variable Main Calls - [List variables](https://www.qovery.com/docs/api-reference/variable-main-calls/list-variables.md): Returns a list of variables. The result can be filtered by using the query parameters. - [Create a variable](https://www.qovery.com/docs/api-reference/variable-main-calls/create-a-variable.md): - Create a variable with the scope defined in the request body. - [Create a variable alias](https://www.qovery.com/docs/api-reference/variable-main-calls/create-a-variable-alias.md): - Allows you to create an alias of one of the existing variables. - You have to specify an alias (key) in the request body, the scope and the parent id of the alias (project id, environment id or service id) - The system will create a new variable at the requested level with the same value as the on… - [Create a variable override](https://www.qovery.com/docs/api-reference/variable-main-calls/create-a-variable-override.md): - Allows you to override a variable that has a higher scope. - You have to specify a value (override) in the request body and the scope and the parent id of the variable to override (project id, environment id or service id) - The system will create a new environment variable at the requested level… - [Edit a variable](https://www.qovery.com/docs/api-reference/variable-main-calls/edit-a-variable.md): - You can't edit a BUILT_IN variable - For an override, you can't edit the key - For an alias, you can't edit the value - [Delete a variable](https://www.qovery.com/docs/api-reference/variable-main-calls/delete-a-variable.md): - To delete a variable - You can't delete a BUILT_IN variable - If you delete a variable having override or alias, the associated override/alias will be deleted as well - [Import variables](https://www.qovery.com/docs/api-reference/variable-main-calls/import-variables.md): Import environment variables in a defined scope, with a defined visibility. ### Lifecycle Template Main Calls - [List available lifecycle template for this environment](https://www.qovery.com/docs/api-reference/lifecycle-template-main-calls/list-available-lifecycle-template-for-this-environment.md) - [Get specific lifecycle template](https://www.qovery.com/docs/api-reference/lifecycle-template-main-calls/get-specific-lifecycle-template.md) ### API Reference - [Get cluster token by clusterId](https://www.qovery.com/docs/api-reference/get-cluster-token-by-clusterid.md) - [Get Deployment Status By DeploymentRequestId](https://www.qovery.com/docs/api-reference/get-deployment-status-by-deploymentrequestid.md) ### Organization Cluster Lock - [List locked Cluster by organization](https://www.qovery.com/docs/api-reference/organization-cluster-lock/list-locked-cluster-by-organization.md) ### service_status - [Get Ingress Deployment Status By Service](https://www.qovery.com/docs/api-reference/service_status/get-ingress-deployment-status-by-service.md) ### Terraforms - [List terraforms](https://www.qovery.com/docs/api-reference/terraforms/list-terraforms.md) - [Create a terraform](https://www.qovery.com/docs/api-reference/terraforms/create-a-terraform.md) - [List default terraform advanced settings](https://www.qovery.com/docs/api-reference/terraforms/list-default-terraform-advanced-settings.md) - [Clone terraform](https://www.qovery.com/docs/api-reference/terraforms/clone-terraform.md): This will create a new terraform with the same configuration on the targeted environment Id. ### Agentic Workflows - [List agentic workflows](https://www.qovery.com/docs/api-reference/agentic-workflows/list-agentic-workflows.md) - [Create an agentic workflow](https://www.qovery.com/docs/api-reference/agentic-workflows/create-an-agentic-workflow.md) - [Get an agentic workflow](https://www.qovery.com/docs/api-reference/agentic-workflows/get-an-agentic-workflow.md) - [Edit an agentic workflow](https://www.qovery.com/docs/api-reference/agentic-workflows/edit-an-agentic-workflow.md) - [Delete an agentic workflow](https://www.qovery.com/docs/api-reference/agentic-workflows/delete-an-agentic-workflow.md): Delete an agentic workflow. This queues a deployment that removes the workflow's Kubernetes resources, and the workflow is deleted once that deployment completes. A workflow that was never deployed is removed immediately, with no deployment. - [Cancel agentic workflow deployment](https://www.qovery.com/docs/api-reference/agentic-workflows/cancel-agentic-workflow-deployment.md): Cancel the deployment currently running the agentic workflow. An agentic workflow only ever runs as part of a deployment of its environment, so this cancels that environment deployment and aborts the workflow's running job. - [List agentic workflow deployments](https://www.qovery.com/docs/api-reference/agentic-workflows/list-agentic-workflow-deployments.md): Returns the 20 last agentic workflow deployments ### Terraform Main Calls - [Get terraform by ID](https://www.qovery.com/docs/api-reference/terraform-main-calls/get-terraform-by-id.md) - [Edit Terraform](https://www.qovery.com/docs/api-reference/terraform-main-calls/edit-terraform.md) - [Delete Terraform](https://www.qovery.com/docs/api-reference/terraform-main-calls/delete-terraform.md) - [List available Terraform versions](https://www.qovery.com/docs/api-reference/terraform-main-calls/list-available-terraform-versions.md) - [List last commits](https://www.qovery.com/docs/api-reference/terraform-main-calls/list-last-commits.md): Returns list of the last 100 commits made on the repository linked to the terraform service ### Terraform Configuration - [Get Advanced settings](https://www.qovery.com/docs/api-reference/terraform-configuration/get-advanced-settings.md) - [Edit Advanced settings](https://www.qovery.com/docs/api-reference/terraform-configuration/edit-advanced-settings.md) ### Terraform Deployment History - [List terraform deployments](https://www.qovery.com/docs/api-reference/terraform-deployment-history/list-terraform-deployments.md): Returns the 20 last terraform deployments ### Terraform Deployment Restriction - [Get terraform deployment restrictions](https://www.qovery.com/docs/api-reference/terraform-deployment-restriction/get-terraform-deployment-restrictions.md): Get terraform deployment restrictions - [Create a terraform deployment restriction](https://www.qovery.com/docs/api-reference/terraform-deployment-restriction/create-a-terraform-deployment-restriction.md): Create a terraform deployment restriction - [Edit a terraform deployment restriction](https://www.qovery.com/docs/api-reference/terraform-deployment-restriction/edit-a-terraform-deployment-restriction.md): Edit a terraform deployment restriction - [Delete a terraform deployment restriction](https://www.qovery.com/docs/api-reference/terraform-deployment-restriction/delete-a-terraform-deployment-restriction.md): Delete a terraform deployment restriction ### Terraform Resources - [Get terraform resources from latest deployment](https://www.qovery.com/docs/api-reference/terraform-resources/get-terraform-resources-from-latest-deployment.md): Returns the list of Terraform resources from the most recent deployment execution ### Organization Enterprise Connection - [List enterprise connections](https://www.qovery.com/docs/api-reference/organization-enterprise-connection/list-enterprise-connections.md) - [Get enterprise connection](https://www.qovery.com/docs/api-reference/organization-enterprise-connection/get-enterprise-connection.md) - [Update enterprise connection](https://www.qovery.com/docs/api-reference/organization-enterprise-connection/update-enterprise-connection.md) ### Alert Receivers - [List alert receivers](https://www.qovery.com/docs/api-reference/alert-receivers/list-alert-receivers.md): Retrieve all alert receivers for a specific organization - [Create alert receiver](https://www.qovery.com/docs/api-reference/alert-receivers/create-alert-receiver.md): Create a new alert receiver - [Get alert receiver](https://www.qovery.com/docs/api-reference/alert-receivers/get-alert-receiver.md): Retrieve a specific alert receiver by its ID - [Update alert receiver](https://www.qovery.com/docs/api-reference/alert-receivers/update-alert-receiver.md): Update an existing alert receiver - [Delete alert receiver](https://www.qovery.com/docs/api-reference/alert-receivers/delete-alert-receiver.md): Delete an alert receiver - [Validate Existing Alert Receiver](https://www.qovery.com/docs/api-reference/alert-receivers/validate-existing-alert-receiver.md): Validate an existing alert receiver by sending a test message for example. - [Validate New Alert Receiver](https://www.qovery.com/docs/api-reference/alert-receivers/validate-new-alert-receiver.md): Validate a future alert receiver by sending a test message. ### Alert Rules - [Create alert rule](https://www.qovery.com/docs/api-reference/alert-rules/create-alert-rule.md): Create a new alert rule with PromQL expression - [Get alert rule](https://www.qovery.com/docs/api-reference/alert-rules/get-alert-rule.md): Retrieve a specific alert rule by its ID - [Update alert rule](https://www.qovery.com/docs/api-reference/alert-rules/update-alert-rule.md): Update an existing alert rule - [Delete alert rule](https://www.qovery.com/docs/api-reference/alert-rules/delete-alert-rule.md): Delete an alert rule - [List alert rules](https://www.qovery.com/docs/api-reference/alert-rules/list-alert-rules.md): Retrieve all alert rules for a specific organization ## OpenAPI Specs - [openapi](/docs/api-reference/openapi.yaml)