Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Qovery Organization Main Calls API

The Organization Main Calls API from Qovery — 13 operation(s) for organization main calls.

Qovery Organization Main Calls API is one of 94 APIs that Qovery publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Organization Main Calls. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, an API reference, authentication docs, and rate-limit docs.

This API exposes 19 operations across 13 paths, and defines 45 schemas. It is described by OpenAPI 3.0.0, at version 1.0.4.

Requests are made against a single base URL, https://api.qovery.com.

19 operations 13 paths 45 schemas 2 DELETE11 GET4 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.4
Base URL
https://api.qovery.com
Authentication
HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 2

Qovery Organization Main Calls API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). An API key is passed in the header as Authorization (ApiKeyAuth). By default, every request must be authenticated.

  • bearerAuth — JWT tokens should be used with OIDC account (human to machine). JWT tokens used by the Qovery console to communicate with the API have a TTL. Curl Example ' cu…
  • ApiKeyAuth — Token API are generated by Qovery to manage machine to machine interaction and do not have a TTL. Curl Example ' curl https://console.qovery.com/organization -…

Paths & Operations 19

Across 13 paths, the API surfaces 19 operations — 2 DELETE, 11 GET, 4 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Organization Main Calls 19
GET
/organization
List user organizations
listOrganization → 200401403404
POST
/organization
Create an organization
createOrganization body → 201400401403404409
GET
/organization/{organizationId}
Get organization by ID
getOrganization 1 param → 200401403404
PUT
/organization/{organizationId}
Edit an organization
editOrganization 1 param body → 200400401403404409
DELETE
/organization/{organizationId}
Delete an organization
deleteOrganization 1 param → 204401403404
GET
/organization/{organizationId}/availableRole
List organization available roles
listOrganizationAvailableRoles 1 param → 200401403404
GET
/organization/{organizationId}/gitToken
List organization git tokens
listOrganizationGitTokens 1 param → 200401403404
POST
/organization/{organizationId}/gitToken
Create a git token
createGitToken 1 param body → 201401403404
GET
/organization/{organizationId}/gitToken/{gitTokenId}
Get organization git token
getOrganizationGitToken 2 params → 200401403404
PUT
/organization/{organizationId}/gitToken/{gitTokenId}
Edit a git token
editGitToken 2 params body → 200400401403404
DELETE
/organization/{organizationId}/gitToken/{gitTokenId}
Delete a git token
deleteGitToken 2 params → 204401403404
GET
/organization/{organizationId}/gitToken/{gitTokenId}/associatedServices
Get organization git token associated services
getGitTokenAssociatedServices 2 params → 200401403404
GET
/organization/{organizationId}/containerRegistry/{containerRegistryId}/associatedServices
Get organization container registry associated services
getContainerRegistryAssociatedServices 2 params → 200401403404
GET
/organization/{organizationId}/helmRepository/{helmRepositoryId}/associatedServices
Get organization helm repository associated services
getHelmRepositoryAssociatedServices 2 params → 200401403404
GET
/organization/{organizationId}/services
List Services By OrganizationId
listServicesByOrganizationId 4 params → 200
GET
/organization/{organizationId}/environments
List Environments By OrganizationId
listEnvironmentsByOrganizationId 1 param → 200
POST
/organization/{organizationId}/parseTerraformVariablesFromGitRepo
Parse Terraform variables from Git repository
parseTerraformVariablesFromGitRepo 1 param body → 200400401403404
POST
/organization/{organizationId}/listTfVarsFilesFromGitRepo
List Terraform tfvars files from Git repository
listTfVarsFilesFromGitRepo 1 param body → 200400401403404
GET
/organization/{organizationId}/credentials
List credentials of an organization and their associated clusters
listOrganizationCredentials 1 param → 200400

Schemas 45

The contract defines 45 schemas that model the data the API accepts and returns. The most detailed are ServiceLightResponse (11 properties), OrganizationRequest (8 properties), HelmRepositoryAssociatedServicesResponse (7 properties), OrganizationEditRequest (7 properties). Each schema is shown below with its type and property counts.

ReferenceObject
object
1 property 1 required
OrganizationCrendentialsResponseList
object
1 property
GitTokenResponse
GenericClusterCredentials
object
3 properties 3 required
ContainerRegistryAssociatedServiceType
GcpStaticClusterCredentials
object
3 properties 3 required
AzureStaticClusterCredentials
object
7 properties 7 required
GitProviderEnum
string
OrganizationEditRequest
object
7 properties 2 required
CredentialCluster
object
3 properties
ClusterCredentials
OrganizationResponseList
object
1 property
GitTokenRequest
object
6 properties 3 required
OrganizationRequest
object
8 properties 2 required
HelmRepositoryAssociatedServiceType
GitTokenAssociatedServicesResponseList
object
1 property
AwsStaticClusterCredentials
object
4 properties 4 required
EksAnywhereVsphereClusterCredentials
object
6 properties 4 required
TerraformVariableParsingRequest
object
1 property 1 required
TerraformVariableDefinition
object
Represents a Terraform variable definition extracted from a Terraform file.
6 properties 3 required
ServiceTypeEnum
string
type of the service (application, database, job, ...)
GitTokenAssociatedServiceType
string
HelmRepositoryAssociatedServicesResponseList
object
1 property
ContainerRegistryAssociatedServicesResponse
object
7 properties 7 required
EnvironmentModeEnum
string
TfVarsFileResponse
object
Represents a Terraform tfvars file with its variables
2 properties 2 required
GitTokenAssociatedServiceResponse
object
7 properties 7 required
OrganizationAvailableRole
object
2 properties 2 required
TfVarsListRequest
object
Request to list Terraform tfvars files from a Git repository
2 properties 2 required
TfVarsDiscoveryModeAutoDiscover
object
Automatically discover all tfvars files in the repository
1 property 1 required
TfVarsDiscoveryModeSpecificPaths
object
Discover tfvars files at specific paths only
2 properties 2 required
CloudProviderEnum
string
ServiceLightResponse
object
11 properties 10 required
GitTokenResponseList
object
1 property
ContainerRegistryAssociatedServicesResponseList
object
1 property
OrganizationEnvironmentResponse
ApplicationGitRepositoryRequest
object
5 properties 4 required
HelmRepositoryAssociatedServicesResponse
object
7 properties 7 required
PlanEnum
string
FREE, BUSINESS & PROFESSIONAL are deprecated. 2025 plans are the new plans available.
TfVarsDiscoveryMode
Discovery mode for Terraform tfvars files - either auto-discover or specify paths
ScalewayClusterCredentials
object
6 properties 6 required
AwsRoleClusterCredentials
object
4 properties 4 required
Base
object
3 properties 2 required
OrganizationAvailableRoleList
object
1 property
Organization

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qovery-organization-main-calls-api-openapi.yml Raw ↑

Other APIs Qovery publishes across the network.

Qovery Account Info API
Qovery Alert Receivers API
Qovery Alert Rules API
Qovery Application Actions API
Qovery Application Configuration API
Qovery Application Custom Domain API
Qovery Application Deployment History API
Qovery Application Deployment Restriction API
Qovery Application Environment Variable API
Qovery Application Logs API
Qovery Application Main Calls API
Qovery Application Secret API