Categorygithub.com/qovery/qovery-client-go
repositorypackage
0.0.0-20240830090110-fb1c0bfbd6a3
Repository: https://github.com/qovery/qovery-client-go.git
Documentation: pkg.go.dev

# Packages

No description provided by the author

# README

Go API client for qovery

  • Qovery is the fastest way to deploy your full-stack apps on any Cloud provider.
  • ℹ️ The API is stable and still in development.

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version: 1.0.3
  • Package version: 1.0.3
  • Generator version: 7.6.0
  • Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://www.qovery.com

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import qovery "github.com/qovery/qovery-client-go"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value qovery.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), qovery.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value qovery.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), qovery.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using qovery.ContextOperationServerIndices and qovery.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), qovery.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), qovery.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://api.qovery.com

ClassMethodHTTP requestDescription
AccountInfoAPIEditAccountInformationPut /accountEdit account information
AccountInfoAPIGetAccountInformationGet /accountGet Account information
ApplicationActionsAPIDeployApplicationPost /application/{applicationId}/deployDeploy application
ApplicationActionsAPIRebootApplicationPost /application/{applicationId}/restart-serviceReboot application
ApplicationActionsAPIRedeployApplicationPost /application/{applicationId}/redeployRedeploy application
ApplicationActionsAPIStopApplicationPost /application/{applicationId}/stopStop application
ApplicationConfigurationAPIEditAdvancedSettingsPut /application/{applicationId}/advancedSettingsEdit advanced settings
ApplicationConfigurationAPIEditApplicationNetworkPut /application/{applicationId}/networkEdit Application Network
ApplicationConfigurationAPIGetAdvancedSettingsGet /application/{applicationId}/advancedSettingsGet advanced settings
ApplicationConfigurationAPIGetApplicationNetworkGet /application/{applicationId}/networkGet Application Network information
ApplicationDeploymentHistoryAPIListApplicationDeploymentHistoryGet /application/{applicationId}/deploymentHistoryList application deploys
ApplicationDeploymentRestrictionAPICreateApplicationDeploymentRestrictionPost /application/{applicationId}/deploymentRestrictionCreate an application deployment restriction
ApplicationDeploymentRestrictionAPIDeleteApplicationDeploymentRestrictionDelete /application/{applicationId}/deploymentRestriction/{deploymentRestrictionId}Delete an application deployment restriction
ApplicationDeploymentRestrictionAPIEditApplicationDeploymentRestrictionPut /application/{applicationId}/deploymentRestriction/{deploymentRestrictionId}Edit an application deployment restriction
ApplicationDeploymentRestrictionAPIGetApplicationDeploymentRestrictionsGet /application/{applicationId}/deploymentRestrictionGet application deployment restrictions
ApplicationEnvironmentVariableAPICreateApplicationEnvironmentVariablePost /application/{applicationId}/environmentVariableAdd an environment variable to the application
ApplicationEnvironmentVariableAPICreateApplicationEnvironmentVariableAliasPost /application/{applicationId}/environmentVariable/{environmentVariableId}/aliasCreate an environment variable alias at the application level
ApplicationEnvironmentVariableAPICreateApplicationEnvironmentVariableOverridePost /application/{applicationId}/environmentVariable/{environmentVariableId}/overrideCreate an environment variable override at the application level
ApplicationEnvironmentVariableAPIDeleteApplicationEnvironmentVariableDelete /application/{applicationId}/environmentVariable/{environmentVariableId}Delete an environment variable from an application
ApplicationEnvironmentVariableAPIEditApplicationEnvironmentVariablePut /application/{applicationId}/environmentVariable/{environmentVariableId}Edit an environment variable belonging to the application
ApplicationEnvironmentVariableAPIImportEnvironmentVariablePost /application/{applicationId}/environmentVariable/importImport variables
ApplicationEnvironmentVariableAPIListApplicationEnvironmentVariableGet /application/{applicationId}/environmentVariableList environment variables
ApplicationLogsAPIListApplicationLogGet /application/{applicationId}/logList logs
ApplicationMainCallsAPIDeleteApplicationDelete /application/{applicationId}Delete application
ApplicationMainCallsAPIEditApplicationPut /application/{applicationId}Edit application
ApplicationMainCallsAPIGetApplicationGet /application/{applicationId}Get application by ID
ApplicationMainCallsAPIGetApplicationStatusGet /application/{applicationId}/statusGet application status
ApplicationMainCallsAPIListApplicationCommitGet /application/{applicationId}/commitList last commits
ApplicationMainCallsAPIListApplicationContributorGet /application/{applicationId}/contributorList contributors
ApplicationMainCallsAPIListApplicationLinksGet /application/{applicationId}/linkList all URLs of the application
ApplicationSecretAPICreateApplicationSecretPost /application/{applicationId}/secretAdd a secret to the application
ApplicationSecretAPICreateApplicationSecretAliasPost /application/{applicationId}/secret/{secretId}/aliasCreate a secret alias at the application level
ApplicationSecretAPICreateApplicationSecretOverridePost /application/{applicationId}/secret/{secretId}/overrideCreate a secret override at the application level
ApplicationSecretAPIDeleteApplicationSecretDelete /application/{applicationId}/secret/{secretId}Delete a secret from an application
ApplicationSecretAPIEditApplicationSecretPut /application/{applicationId}/secret/{secretId}Edit a secret belonging to the application
ApplicationSecretAPIListApplicationSecretsGet /application/{applicationId}/secretList application secrets
ApplicationsAPICloneApplicationPost /application/{applicationId}/cloneClone application
ApplicationsAPICreateApplicationPost /environment/{environmentId}/applicationCreate an application
ApplicationsAPIGetDefaultApplicationAdvancedSettingsGet /defaultApplicationAdvancedSettingsList default application advanced settings
ApplicationsAPIGetEnvironmentApplicationStatusGet /environment/{environmentId}/application/statusList all environment applications statuses
ApplicationsAPIGetEnvironmentApplicationSupportedLanguagesGet /environment/{environmentId}/application/supportedLanguageList supported languages
ApplicationsAPIListApplicationGet /environment/{environmentId}/applicationList applications
BackupsAPIAddBackupDatabasePost /database/{databaseId}/backupAdd a backup to the Database
BackupsAPIListDatabaseBackupGet /database/{databaseId}/backupList database backups
BackupsAPIRemoveDatabaseBackupDelete /database/{databaseId}/backup/{backupId}Remove database backup
BillingAPIAddCreditCardPost /organization/{organizationId}/creditCardAdd credit card
BillingAPIAddCreditCodePost /organization/{organizationId}/creditCodeAdd credit code
BillingAPIChangePlanPost /organization/{organizationId}/changePlanChange organization plan
BillingAPIDeleteCreditCardDelete /organization/{organizationId}/creditCard/{creditCardId}Delete credit card
BillingAPIEditOrganizationBillingInfoPut /organization/{organizationId}/billingInfoEdit Organization Billing Info
BillingAPIGenerateBillingUsageReportPost /organization/{organizationId}/billingUsageReportGenerate organization billing usage report
BillingAPIGetClusterCurrentCostGet /organization/{organizationId}/cluster/{clusterId}/currentCostGet cluster current cost
BillingAPIGetOrganizationBillingExternalIdGet /organization/{organizationId}/billingExternalIdGet organization billing external ID
BillingAPIGetOrganizationBillingInfoGet /organization/{organizationId}/billingInfoGet organization billing info
BillingAPIGetOrganizationBillingStatusGet /organization/{organizationId}/billingStatusGet organization billing status
BillingAPIGetOrganizationCurrentCostGet /organization/{organizationId}/currentCostGet organization current cost
BillingAPIGetOrganizationInvoiceGet /organization/{organizationId}/invoice/{invoiceId}Get organization invoice
BillingAPIGetOrganizationInvoicePDFGet /organization/{organizationId}/invoice/{invoiceId}/downloadGet invoice link
BillingAPIListOrganizationCreditCardsGet /organization/{organizationId}/creditCardList organization credit cards
BillingAPIListOrganizationInvoiceGet /organization/{organizationId}/invoiceList organization invoices
BillingAPIOrganizationDownloadAllInvoicesPost /organization/{organizationId}/downloadInvoicesDownload all invoices
CloudProviderAPIListAWSEKSInstanceTypeGet /aws/eks/instanceType/{region}List AWS EKS available instance types
CloudProviderAPIListAWSEc2InstanceTypeGet /aws/ec2/instanceType/{region}List AWS EC2 available instance types
CloudProviderAPIListAWSFeaturesGet /aws/clusterFeatureList AWS features available
CloudProviderAPIListAWSInstanceTypeGet /aws/instanceTypeList AWS available instance types
CloudProviderAPIListAWSManagedDatabaseInstanceTypeGet /aws/managedDatabase/instanceType/{region}/{databaseType}List AWS available managed database instance types
CloudProviderAPIListAWSManagedDatabaseTypeGet /aws/managedDatabase/typeList AWS available managed database types
CloudProviderAPIListAWSRegionsGet /aws/regionList AWS regions
CloudProviderAPIListCloudProviderGet /cloudProviderList Cloud providers available
CloudProviderAPIListGcpFeaturesGet /gcp/clusterFeatureList GCP features available
CloudProviderAPIListGcpGkeInstanceTypeGet /gcp/instanceType/{region}List GCP GKE available instance types
CloudProviderAPIListGcpRegionsGet /gcp/regionList GCP regions
CloudProviderAPIListSCWManagedDatabaseInstanceTypeGet /scaleway/managedDatabase/instanceType/{zone}/{databaseType}List Scaleway available managed database instance types
CloudProviderAPIListSCWManagedDatabaseTypeGet /scaleway/managedDatabase/typeList Scaleway available managed database types
CloudProviderAPIListScalewayFeaturesGet /scaleway/clusterFeatureList Scaleway features available
CloudProviderAPIListScalewayInstanceTypeGet /scaleway/instanceTypeList Scaleway available instance types
CloudProviderAPIListScalewayKapsuleInstanceTypeGet /scaleway/instanceType/{zone}List Scaleway Kapsule available instance types
CloudProviderAPIListScalewayRegionsGet /scaleway/regionList Scaleway regions
CloudProviderCredentialsAPICreateAWSCredentialsPost /organization/{organizationId}/aws/credentialsCreate AWS credentials set
CloudProviderCredentialsAPICreateGcpCredentialsPost /organization/{organizationId}/gcp/credentialsCreate GCP credentials set
CloudProviderCredentialsAPICreateOnPremiseCredentialsPost /organization/{organizationId}/onPremise/credentialsCreate OnPremise credentials set
CloudProviderCredentialsAPICreateScalewayCredentialsPost /organization/{organizationId}/scaleway/credentialsCreate Scaleway credentials set
CloudProviderCredentialsAPIDeleteAWSCredentialsDelete /organization/{organizationId}/aws/credentials/{credentialsId}Delete a set of AWS credentials
CloudProviderCredentialsAPIDeleteGcpCredentialsDelete /organization/{organizationId}/gcp/credentials/{credentialsId}Delete a set of GCP credentials
CloudProviderCredentialsAPIDeleteOnPremiseCredentialsDelete /organization/{organizationId}/onPremise/credentials/{credentialsId}Delete a set of OnPremise credentials
CloudProviderCredentialsAPIDeleteScalewayCredentialsDelete /organization/{organizationId}/scaleway/credentials/{credentialsId}Delete a set of Scaleway credentials
CloudProviderCredentialsAPIEditAWSCredentialsPut /organization/{organizationId}/aws/credentials/{credentialsId}Edit a set of AWS credentials
CloudProviderCredentialsAPIEditGcpCredentialsPut /organization/{organizationId}/gcp/credentials/{credentialsId}Edit a set of GCP credentials
CloudProviderCredentialsAPIEditOnPremiseCredentialsPut /organization/{organizationId}/onPremise/credentials/{credentialsId}Edit a set of OnPremise credentials
CloudProviderCredentialsAPIEditScalewayCredentialsPut /organization/{organizationId}/scaleway/credentials/{credentialsId}Edit a set of Scaleway credentials
CloudProviderCredentialsAPIGetAWSCredentialsGet /organization/{organizationId}/aws/credentials/{credentialsId}Get a set of AWS credentials
CloudProviderCredentialsAPIGetGcpCredentialsGet /organization/{organizationId}/gcp/credentials/{credentialsId}Get a set of GCP credentials
CloudProviderCredentialsAPIGetOnPremiseCredentialsGet /organization/{organizationId}/onPremise/credentials/{credentialsId}Get a set of OnPremise credentials
CloudProviderCredentialsAPIGetScalewayCredentialsGet /organization/{organizationId}/scaleway/credentials/{credentialsId}Get a set of Scaleway credentials
CloudProviderCredentialsAPIListAWSCredentialsGet /organization/{organizationId}/aws/credentialsList AWS credentials
CloudProviderCredentialsAPIListGcpCredentialsGet /organization/{organizationId}/gcp/credentialsList GCP credentials
CloudProviderCredentialsAPIListOnPremiseCredentialsGet /organization/{organizationId}/onPremise/credentialsList OnPremise credentials
CloudProviderCredentialsAPIListScalewayCredentialsGet /organization/{organizationId}/scaleway/credentialsList Scaleway credentials
ClustersAPICreateClusterPost /organization/{organizationId}/clusterCreate a cluster
ClustersAPIDeleteClusterDelete /organization/{organizationId}/cluster/{clusterId}Delete a cluster
ClustersAPIDeployClusterPost /organization/{organizationId}/cluster/{clusterId}/deployDeploy a cluster
ClustersAPIEditClusterPut /organization/{organizationId}/cluster/{clusterId}Edit a cluster
ClustersAPIEditClusterAdvancedSettingsPut /organization/{organizationId}/cluster/{clusterId}/advancedSettingsEdit advanced settings
ClustersAPIEditClusterKubeconfigPut /organization/{organizationId}/cluster/{clusterId}/kubeconfigEdit cluster kubeconfig
ClustersAPIEditRoutingTablePut /organization/{organizationId}/cluster/{clusterId}/routingTableEdit routing table
ClustersAPIGetClusterAdvancedSettingsGet /organization/{organizationId}/cluster/{clusterId}/advancedSettingsGet advanced settings
ClustersAPIGetClusterKubeconfigGet /organization/{organizationId}/cluster/{clusterId}/kubeconfigGet cluster kubeconfig
ClustersAPIGetClusterReadinessStatusGet /organization/{organizationId}/cluster/{clusterId}/isReadyKnow if a cluster is ready to be deployed or not
ClustersAPIGetClusterStatusGet /organization/{organizationId}/cluster/{clusterId}/statusGet cluster status
ClustersAPIGetDefaultClusterAdvancedSettingsGet /defaultClusterAdvancedSettingsList default cluster advanced settings
ClustersAPIGetInstallationHelmValuesGet /organization/{organizationId}/cluster/{clusterId}/installationHelmValuesGet cluster helm values for self managed installation
ClustersAPIGetOrganizationCloudProviderInfoGet /organization/{organizationId}/cluster/{clusterId}/cloudProviderInfoGet cluster cloud provider info and credentials
ClustersAPIGetOrganizationClusterStatusGet /organization/{organizationId}/cluster/statusList all clusters statuses
ClustersAPIGetRoutingTableGet /organization/{organizationId}/cluster/{clusterId}/routingTableGet routing table
ClustersAPIListClusterLogsGet /organization/{organizationId}/cluster/{clusterId}/logsList Cluster Logs
ClustersAPIListOrganizationClusterGet /organization/{organizationId}/clusterList organization clusters
ClustersAPISpecifyClusterCloudProviderInfoPost /organization/{organizationId}/cluster/{clusterId}/cloudProviderInfoSpecify cluster cloud provider info and credentials
ClustersAPIStopClusterPost /organization/{organizationId}/cluster/{clusterId}/stopStop cluster
ContainerActionsAPIDeployContainerPost /container/{containerId}/deployDeploy container
ContainerActionsAPIRebootContainerPost /container/{containerId}/restart-serviceReboot container
ContainerActionsAPIRedeployContainerPost /container/{containerId}/redeployRedeploy container
ContainerActionsAPIStopContainerPost /container/{containerId}/stopStop container
ContainerConfigurationAPIEditContainerAdvancedSettingsPut /container/{containerId}/advancedSettingsEdit advanced settings
ContainerConfigurationAPIEditContainerNetworkPut /container/{containerId}/networkEdit Container Network
ContainerConfigurationAPIGetContainerAdvancedSettingsGet /container/{containerId}/advancedSettingsGet advanced settings
ContainerConfigurationAPIGetContainerNetworkGet /container/{containerId}/networkGet Container Network information
ContainerCustomDomainAPICreateContainerCustomDomainPost /container/{containerId}/customDomainAdd custom domain to the container.
ContainerCustomDomainAPIDeleteContainerCustomDomainDelete /container/{containerId}/customDomain/{customDomainId}Delete a Custom Domain
ContainerCustomDomainAPIEditContainerCustomDomainPut /container/{containerId}/customDomain/{customDomainId}Edit a Custom Domain
ContainerCustomDomainAPIGetContainerCustomDomainStatusGet /container/{containerId}/customDomain/{customDomainId}/statusGet Custom Domain status
ContainerCustomDomainAPIListContainerCustomDomainGet /container/{containerId}/customDomainList container custom domains
ContainerDeploymentHistoryAPIListContainerDeploymentHistoryGet /container/{containerId}/deploymentHistoryList container deployments
ContainerEnvironmentVariableAPICreateContainerEnvironmentVariablePost /container/{containerId}/environmentVariableAdd an environment variable to the container
ContainerEnvironmentVariableAPICreateContainerEnvironmentVariableAliasPost /container/{containerId}/environmentVariable/{environmentVariableId}/aliasCreate an environment variable alias at the container level
ContainerEnvironmentVariableAPICreateContainerEnvironmentVariableOverridePost /container/{containerId}/environmentVariable/{environmentVariableId}/overrideCreate an environment variable override at the container level
ContainerEnvironmentVariableAPIDeleteContainerEnvironmentVariableDelete /container/{containerId}/environmentVariable/{environmentVariableId}Delete an environment variable from a container
ContainerEnvironmentVariableAPIEditContainerEnvironmentVariablePut /container/{containerId}/environmentVariable/{environmentVariableId}Edit an environment variable belonging to the container
ContainerEnvironmentVariableAPIImportContainerEnvironmentVariablePost /container/{containerId}/environmentVariable/importImport variables
ContainerEnvironmentVariableAPIListContainerEnvironmentVariableGet /container/{containerId}/environmentVariableList environment variables
ContainerLogsAPIListContainerLogGet /container/{containerId}/logList logs
ContainerMainCallsAPIDeleteContainerDelete /container/{containerId}Delete container
ContainerMainCallsAPIEditContainerPut /container/{containerId}Edit container
ContainerMainCallsAPIGetContainerGet /container/{containerId}Get container by ID
ContainerMainCallsAPIGetContainerStatusGet /container/{containerId}/statusGet container status
ContainerMainCallsAPIListContainerLinksGet /container/{containerId}/linkList all URLs of the container
ContainerRegistriesAPICreateContainerRegistryPost /organization/{organizationId}/containerRegistryCreate a container registry
ContainerRegistriesAPIDeleteContainerRegistryDelete /organization/{organizationId}/containerRegistry/{containerRegistryId}Delete a container registry
ContainerRegistriesAPIEditContainerRegistryPut /organization/{organizationId}/containerRegistry/{containerRegistryId}Edit a container registry
ContainerRegistriesAPIGetContainerRegistryGet /organization/{organizationId}/containerRegistry/{containerRegistryId}Get a container registry
ContainerRegistriesAPIGetContainerVersionsGet /organization/{organizationId}/containerRegistry/{containerRegistryId}/imagesList image version for a container registry
ContainerRegistriesAPIListAvailableContainerRegistryGet /availableContainerRegistryList supported container registries
ContainerRegistriesAPIListContainerRegistryGet /organization/{organizationId}/containerRegistryList organization container registries
ContainerSecretAPICreateContainerSecretPost /container/{containerId}/secretAdd a secret to the container
ContainerSecretAPICreateContainerSecretAliasPost /container/{containerId}/secret/{secretId}/aliasCreate a secret alias at the container level
ContainerSecretAPICreateContainerSecretOverridePost /container/{containerId}/secret/{secretId}/overrideCreate a secret override at the container level
ContainerSecretAPIDeleteContainerSecretDelete /container/{containerId}/secret/{secretId}Delete a secret from an container
ContainerSecretAPIEditContainerSecretPut /container/{containerId}/secret/{secretId}Edit a secret belonging to the container
ContainerSecretAPIListContainerSecretsGet /container/{containerId}/secretList container secrets
ContainersAPIAutoDeployContainerEnvironmentsPost /organization/{organizationId}/container/deployAuto deploy containers
ContainersAPICloneContainerPost /container/{containerId}/cloneClone container
ContainersAPICreateContainerPost /environment/{environmentId}/containerCreate a container
ContainersAPIGetContainerRegistryContainerStatusGet /organization/{organizationId}/containerRegistry/{containerRegistryId}/container/statusList all container registry container statuses
ContainersAPIGetDefaultContainerAdvancedSettingsGet /defaultContainerAdvancedSettingsList default container advanced settings
ContainersAPIGetEnvironmentContainerStatusGet /environment/{environmentId}/container/statusList all environment container statuses
ContainersAPIListContainerGet /environment/{environmentId}/containerList containers
ContainersAPIPreviewContainerEnvironmentsPost /organization/{organizationId}/container/previewPreview container environments
CustomDomainAPICheckApplicationCustomDomainGet /application/{applicationId}/checkCustomDomainCheck Application Custom Domain
CustomDomainAPICheckContainerCustomDomainGet /container/{containerId}/checkCustomDomainCheck Container Custom Domain
CustomDomainAPICheckHelmCustomDomainGet /helm/{helmId}/checkCustomDomainCheck Helm Custom Domain
CustomDomainAPICreateApplicationCustomDomainPost /application/{applicationId}/customDomainAdd custom domain to the application.
CustomDomainAPIDeleteCustomDomainDelete /application/{applicationId}/customDomain/{customDomainId}Delete a Custom Domain
CustomDomainAPIEditCustomDomainPut /application/{applicationId}/customDomain/{customDomainId}Edit a Custom Domain
CustomDomainAPIGetCustomDomainStatusGet /application/{applicationId}/customDomain/{customDomainId}/statusGet Custom Domain status
CustomDomainAPIListApplicationCustomDomainGet /application/{applicationId}/customDomainList application custom domains
DatabaseActionsAPIDeployDatabasePost /database/{databaseId}/deployDeploy database
DatabaseActionsAPIRebootDatabasePost /database/{databaseId}/restart-serviceRetart database
DatabaseActionsAPIRedeployDatabasePost /database/{databaseId}/redeployRedeploy database
DatabaseActionsAPIStopDatabasePost /database/{databaseId}/stopStop database
DatabaseApplicationAPIListDatabaseApplicationGet /database/{databaseId}/applicationList applications using the database
DatabaseApplicationAPIRemoveApplicationFromDatabaseDelete /database/{databaseId}/application/{targetApplicationId}Remove an application from this database
DatabaseDeploymentHistoryAPIListDatabaseDeploymentHistoryGet /database/{databaseId}/deploymentHistoryList database deploys
DatabaseMainCallsAPIDeleteDatabaseDelete /database/{databaseId}Delete a database
DatabaseMainCallsAPIEditDatabasePut /database/{databaseId}Edit a database
DatabaseMainCallsAPIEditDatabaseCredentialsPut /database/{databaseId}/masterCredentialsEdit database master credentials
DatabaseMainCallsAPIGetDatabaseGet /database/{databaseId}Get database by ID
DatabaseMainCallsAPIGetDatabaseMasterCredentialsGet /database/{databaseId}/masterCredentialsGet master credentials of the database
DatabaseMainCallsAPIGetDatabaseStatusGet /database/{databaseId}/statusGet database status
DatabaseMainCallsAPIListDatabaseVersionGet /database/{databaseId}/versionList eligible versions for the database
DatabasesAPICloneDatabasePost /database/{databaseId}/cloneClone database
DatabasesAPICreateDatabasePost /environment/{environmentId}/databaseCreate a database
DatabasesAPIGetEnvironmentDatabaseStatusGet /environment/{environmentId}/database/statusList all environment databases statuses
DatabasesAPIListDatabaseGet /environment/{environmentId}/databaseList environment databases
DatabasesAPIListEnvironmentDatabaseConfigGet /environment/{environmentId}/databaseConfigurationList eligible database types, versions and modes for the environment
DefaultAPIGetClusterTokenByClusterIdGet /cluster/{clusterId}/tokenGet cluster token by clusterId
DefaultAPIGetHelmKubernetesServicesGet /helm/{helmId}/listServicesGet helm kubernetes services
DeploymentStageMainCallsAPIAttachServiceToDeploymentStagePut /deploymentStage/{deploymentStageId}/service/{serviceId}Attach service to deployment stage
DeploymentStageMainCallsAPICreateEnvironmentDeploymentStagePost /environment/{environmentId}/deploymentStageCreate environment deployment stage
DeploymentStageMainCallsAPIDeleteDeploymentStageDelete /deploymentStage/{deploymentStageId}Delete deployment stage
DeploymentStageMainCallsAPIEditDeploymentStagePut /deploymentStage/{deploymentStageId}Edit deployment stage
DeploymentStageMainCallsAPIGetDeploymentStageGet /deploymentStage/{deploymentStageId}Get Deployment Stage
DeploymentStageMainCallsAPIGetServiceDeploymentStageGet /service/{serviceId}/deploymentStageGet Service Deployment Stage
DeploymentStageMainCallsAPIListEnvironmentDeploymentStageGet /environment/{environmentId}/deploymentStageList environment deployment stage
DeploymentStageMainCallsAPIMoveAfterDeploymentStagePut /deploymentStage/{deploymentStageId}/moveAfter/{stageId}Move deployment stage after requested stage
DeploymentStageMainCallsAPIMoveBeforeDeploymentStagePut /deploymentStage/{deploymentStageId}/moveBefore/{stageId}Move deployment stage before requested stage
EnvironmentAPICheckContainerImagePost /environment/{environmentId}/checkContainerImageCheck container image configuration is correct
EnvironmentAPICheckDockerfilePost /environment/{environmentId}/checkDockerfileCheck dockerfile configuration is correct
EnvironmentAPICheckGitFilePost /environment/{environmentId}/checkGitFileCheck git file configuration is correct
EnvironmentAPICheckHelmRepositoryPost /environment/{environmentId}/checkHelmRepositoryCheck helm repository configuration is correct
EnvironmentAPIDeployAllApplicationsPost /environment/{environmentId}/application/deployDeploy applications
EnvironmentActionsAPICancelEnvironmentDeploymentPost /environment/{environmentId}/cancelDeploymentCancel environment deployment
EnvironmentActionsAPICleanFailedJobsPost /environment/{environmentId}/cleanFailedJobsClean failed jobs within an environment
EnvironmentActionsAPICloneEnvironmentPost /environment/{environmentId}/cloneClone environment
EnvironmentActionsAPIDeleteSelectedServicesPost /environment/{environmentId}/service/deleteDelete services
EnvironmentActionsAPIDeployAllServicesPost /environment/{environmentId}/service/deployDeploy services
EnvironmentActionsAPIDeployEnvironmentPost /environment/{environmentId}/deployDeploy environment
EnvironmentActionsAPIRebootServicesPost /environment/{environmentId}/service/restart-serviceReboot services
EnvironmentActionsAPIRedeployEnvironmentPost /environment/{environmentId}/redeployRedeploy environment
EnvironmentActionsAPIStopEnvironmentPost /environment/{environmentId}/stopStop environment
EnvironmentActionsAPIStopSelectedServicesPost /environment/{environmentId}/service/stopStop services
EnvironmentDeploymentHistoryAPIListEnvironmentDeploymentHistoryGet /environment/{environmentId}/deploymentHistoryList environment deployments
EnvironmentDeploymentRuleAPIEditEnvironmentDeploymentRulePut /environment/{environmentId}/deploymentRule/{deploymentRuleId}Edit an environment deployment rule
EnvironmentDeploymentRuleAPIGetEnvironmentDeploymentRuleGet /environment/{environmentId}/deploymentRuleGet environment deployment rule
EnvironmentExportAPIExportEnvironmentConfigurationIntoTerraformGet /environment/{environmentId}/terraformExportExport full environment and its resources into Terraform manifests
EnvironmentLogsAPIListEnvironmentLogGet /environment/{environmentId}/logList environment deployment logs
EnvironmentLogsAPIListEnvironmentLogsGet /environment/{environmentId}/logsList environment deployment logs v2
EnvironmentMainCallsAPIDeleteEnvironmentDelete /environment/{environmentId}Delete an environment
EnvironmentMainCallsAPIEditEnvironmentPut /environment/{environmentId}Edit an environment
EnvironmentMainCallsAPIGetEnvironmentGet /environment/{environmentId}Get environment by ID
EnvironmentMainCallsAPIGetEnvironmentStatusGet /environment/{environmentId}/statusGet environment status
EnvironmentMainCallsAPIGetEnvironmentStatusesGet /environment/{environmentId}/statusesGet environment statuses with services status
EnvironmentMainCallsAPIGetEnvironmentStatusesWithStagesGet /environment/{environmentId}/statusesWithStagesGet environment statuses with stages
EnvironmentSecretAPICreateEnvironmentSecretPost /environment/{environmentId}/secretAdd a secret to the environment
EnvironmentSecretAPICreateEnvironmentSecretAliasPost /environment/{environmentId}/secret/{secretId}/aliasCreate a secret alias at the environment level
EnvironmentSecretAPICreateEnvironmentSecretOverridePost /environment/{environmentId}/secret/{secretId}/overrideCreate a secret override at the environment level
EnvironmentSecretAPIDeleteEnvironmentSecretDelete /environment/{environmentId}/secret/{secretId}Delete a secret from the environment
EnvironmentSecretAPIEditEnvironmentSecretPut /environment/{environmentId}/secret/{secretId}Edit a secret belonging to the environment
EnvironmentSecretAPIListEnvironmentSecretsGet /environment/{environmentId}/secretList environment secrets
EnvironmentVariableAPICreateEnvironmentEnvironmentVariablePost /environment/{environmentId}/environmentVariableAdd an environment variable to the environment
EnvironmentVariableAPICreateEnvironmentEnvironmentVariableAliasPost /environment/{environmentId}/environmentVariable/{environmentVariableId}/aliasCreate an environment variable alias at the environment level
EnvironmentVariableAPICreateEnvironmentEnvironmentVariableOverridePost /environment/{environmentId}/environmentVariable/{environmentVariableId}/overrideCreate an environment variable override at the environment level
EnvironmentVariableAPIDeleteEnvironmentEnvironmentVariableDelete /environment/{environmentId}/environmentVariable/{environmentVariableId}Delete an environment variable from an environment
EnvironmentVariableAPIEditEnvironmentEnvironmentVariablePut /environment/{environmentId}/environmentVariable/{environmentVariableId}Edit an environment variable belonging to the environment
EnvironmentVariableAPIListEnvironmentEnvironmentVariableGet /environment/{environmentId}/environmentVariableList environment variables
EnvironmentsAPICreateEnvironmentPost /project/{projectId}/environmentCreate an environment
EnvironmentsAPIGetProjectEnvironmentServiceNumberGet /project/{projectId}/environment/statsList total number of services for each environment of the project
EnvironmentsAPIGetProjectEnvironmentsStatusGet /project/{projectId}/environment/statusList environments statuses
EnvironmentsAPIListEnvironmentGet /project/{projectId}/environmentList environments
GitRepositoriesAPIGetBitbucketRepositoriesGet /account/bitbucket/repositoryGet bitbucket repositories of the connected user
GitRepositoriesAPIGetBitbucketRepositoryBranchesGet /account/bitbucket/repository/branchGet bitbucket branches of the specified repository
GitRepositoriesAPIGetGitProviderAccountGet /account/gitAuthProviderGet git provider accounts
GitRepositoriesAPIGetGithubRepositoriesGet /account/github/repositoryGet github repositories of the connected user
GitRepositoriesAPIGetGithubRepositoryBranchesGet /account/github/repository/branchGet github branches of the specified repository
GitRepositoriesAPIGetGitlabRepositoriesGet /account/gitlab/repositoryGet gitlab repositories of the connected user
GitRepositoriesAPIGetGitlabRepositoryBranchesGet /account/gitlab/repository/branchGet gitlab branches of the specified repository
GithubAppAPIOrganizationGithubAppConnectPost /organization/{organizationId}/github/connectConnect a github account to an organization
GithubAppAPIOrganizationGithubAppDisconnectDelete /organization/{organizationId}/github/disconnectDisconnect a github account from an organization
HelmActionsAPIDeployHelmPost /helm/{helmId}/deployDeploy helm
HelmActionsAPIRedeployHelmPost /helm/{helmId}/redeployRedeploy helm
HelmActionsAPIStopHelmPost /helm/{helmId}/stopStop helm
HelmConfigurationAPIEditHelmAdvancedSettingsPut /helm/{helmId}/advancedSettingsEdit advanced settings
HelmConfigurationAPIGetHelmAdvancedSettingsGet /helm/{helmId}/advancedSettingsGet advanced settings
HelmCustomDomainAPICreateHelmCustomDomainPost /helm/{helmId}/customDomainAdd custom domain to the helm.
HelmCustomDomainAPIDeleteHelmCustomDomainDelete /helm/{helmId}/customDomain/{customDomainId}Delete a Custom Domain
HelmCustomDomainAPIEditHelmCustomDomainPut /helm/{helmId}/customDomain/{customDomainId}Edit a Custom Domain
HelmCustomDomainAPIGetHelmCustomDomainGet /helm/{helmId}/customDomain/{customDomainId}Get a Custom Domain
HelmCustomDomainAPIListHelmCustomDomainGet /helm/{helmId}/customDomainList helm custom domains
HelmDeploymentHistoryAPIListHelmDeploymentHistoryGet /helm/{helmId}/deploymentHistoryList helm deployments
HelmDeploymentRestrictionAPICreateHelmDeploymentRestrictionPost /helm/{helmId}/deploymentRestrictionCreate a helm deployment restriction
HelmDeploymentRestrictionAPIDeleteHelmDeploymentRestrictionDelete /helm/{helmId}/deploymentRestriction/{deploymentRestrictionId}Delete a helm deployment restriction
HelmDeploymentRestrictionAPIEditHelmDeploymentRestrictionPut /helm/{helmId}/deploymentRestriction/{deploymentRestrictionId}Edit a helm deployment restriction
HelmDeploymentRestrictionAPIGetHelmDeploymentRestrictionsGet /helm/{helmId}/deploymentRestrictionGet helm deployment restrictions
HelmMainCallsAPIDeleteHelmDelete /helm/{helmId}Delete helm
HelmMainCallsAPIEditHelmPut /helm/{helmId}Edit helm
HelmMainCallsAPIGetHelmGet /helm/{helmId}Get helm by ID
HelmMainCallsAPIGetHelmStatusGet /helm/{helmId}/statusGet helm status
HelmMainCallsAPIListHelmCommitGet /helm/{helmId}/commitList last helm commits
HelmMainCallsAPIListHelmLinksGet /helm/{helmId}/linkList all URLs of the helm
HelmRepositoriesAPICreateHelmRepositoryPost /organization/{organizationId}/helmRepositoryCreate a helm repository
HelmRepositoriesAPIDeleteHelmRepositoryDelete /organization/{organizationId}/helmRepository/{helmRepositoryId}Delete a helm repository
HelmRepositoriesAPIEditHelmRepositoryPut /organization/{organizationId}/helmRepository/{helmRepositoryId}Edit a helm repository
HelmRepositoriesAPIGetHelmChartsGet /organization/{organizationId}/helmRepository/{helmRepositoryId}/chartsList helm charts contained inside the repository
HelmRepositoriesAPIGetHelmRepositoryGet /organization/{organizationId}/helmRepository/{helmRepositoryId}Get a helm repository
HelmRepositoriesAPIListAvailableHelmRepositoryGet /availableHelmRepositoryList supported helm repository
HelmRepositoriesAPIListHelmRepositoryGet /organization/{organizationId}/helmRepositoryList organization helm repositories
HelmsAPICloneHelmPost /helm/{helmId}/cloneClone helm
HelmsAPICreateHelmPost /environment/{environmentId}/helmCreate a helm
HelmsAPICreateHelmDefaultValuesPost /environment/{environmentId}/helmDefaultValuesGet helm default values
HelmsAPIGetDefaultHelmAdvancedSettingsGet /defaultHelmAdvancedSettingsList default helm advanced settings
HelmsAPIGetEnvironmentHelmStatusGet /environment/{environmentId}/helm/statusList all environment helm statuses
HelmsAPIListHelmsGet /environment/{environmentId}/helmList helms
JobActionsAPICleanFailedJobPost /job/{jobId}/cleanFailedJobClean a failed job
JobActionsAPIDeployJobPost /job/{jobId}/deployDeploy job
JobActionsAPIRedeployJobPost /job/{jobId}/redeployRedeploy job
JobActionsAPIStopJobPost /job/{jobId}/stopStop job
JobConfigurationAPIEditJobAdvancedSettingsPut /job/{jobId}/advancedSettingsEdit advanced settings
JobConfigurationAPIGetJobAdvancedSettingsGet /job/{jobId}/advancedSettingsGet advanced settings
JobDeploymentHistoryAPIListJobDeploymentHistoryGet /job/{jobId}/deploymentHistoryList job deployments
JobDeploymentRestrictionAPICreateJobDeploymentRestrictionPost /job/{jobId}/deploymentRestrictionCreate a job deployment restriction
JobDeploymentRestrictionAPIDeleteJobDeploymentRestrictionDelete /job/{jobId}/deploymentRestriction/{deploymentRestrictionId}Delete a job deployment restriction
JobDeploymentRestrictionAPIEditJobDeploymentRestrictionPut /job/{jobId}/deploymentRestriction/{deploymentRestrictionId}Edit a job deployment restriction
JobDeploymentRestrictionAPIGetJobDeploymentRestrictionsGet /job/{jobId}/deploymentRestrictionGet job deployment restrictions
JobEnvironmentVariableAPICreateJobEnvironmentVariablePost /job/{jobId}/environmentVariableAdd an environment variable to the job
JobEnvironmentVariableAPICreateJobEnvironmentVariableAliasPost /job/{jobId}/environmentVariable/{environmentVariableId}/aliasCreate an environment variable alias at the job level
JobEnvironmentVariableAPICreateJobEnvironmentVariableOverridePost /job/{jobId}/environmentVariable/{environmentVariableId}/overrideCreate an environment variable override at the job level
JobEnvironmentVariableAPIDeleteJobEnvironmentVariableDelete /job/{jobId}/environmentVariable/{environmentVariableId}Delete an environment variable from a job
JobEnvironmentVariableAPIEditJobEnvironmentVariablePut /job/{jobId}/environmentVariable/{environmentVariableId}Edit an environment variable belonging to the job
JobEnvironmentVariableAPIImportJobEnvironmentVariablePost /job/{jobId}/environmentVariable/importImport variables
JobEnvironmentVariableAPIListJobEnvironmentVariableGet /job/{jobId}/environmentVariableList environment variables
JobMainCallsAPIDeleteJobDelete /job/{jobId}Delete job
JobMainCallsAPIEditJobPut /job/{jobId}Edit job
JobMainCallsAPIGetJobGet /job/{jobId}Get job by ID
JobMainCallsAPIGetJobStatusGet /job/{jobId}/statusGet job status
JobMainCallsAPIListJobCommitGet /job/{jobId}/commitList last job commits
JobSecretAPICreateJobSecretPost /job/{jobId}/secretAdd a secret to the job
JobSecretAPICreateJobSecretAliasPost /job/{jobId}/secret/{secretId}/aliasCreate a secret alias at the job level
JobSecretAPICreateJobSecretOverridePost /job/{jobId}/secret/{secretId}/overrideCreate a secret override at the job level
JobSecretAPIDeleteJobSecretDelete /job/{jobId}/secret/{secretId}Delete a secret from an job
JobSecretAPIEditJobSecretPut /job/{jobId}/secret/{secretId}Edit a secret belonging to the job
JobSecretAPIListJobSecretsGet /job/{jobId}/secretList job secrets
JobsAPIAutoDeployJobEnvironmentsPost /organization/{organizationId}/job/deployAuto deploy jobs
JobsAPICloneJobPost /job/{jobId}/cloneClone job
JobsAPICreateJobPost /environment/{environmentId}/jobCreate a job
JobsAPIGetDefaultJobAdvancedSettingsGet /defaultJobAdvancedSettingsList default job advanced settings
JobsAPIGetEnvironmentJobStatusGet /environment/{environmentId}/job/statusList all environment job statuses
JobsAPIListJobsGet /environment/{environmentId}/jobList jobs
LifecycleTemplateMainCallsAPIGetEnvironmentLifecycleTemplateGet /environment/{environmentId}/lifecycleTemplate/{lifecycleTemplateId}Get specific lifecycle template
LifecycleTemplateMainCallsAPIListEnvironmentLifecycleTemplatesGet /environment/{environmentId}/lifecycleTemplateList available lifecycle template for this environment
MembersAPIDeleteInviteMemberDelete /organization/{organizationId}/inviteMember/{inviteId}Remove an invited member
MembersAPIDeleteMemberDelete /organization/{organizationId}/memberRemove a member
MembersAPIEditOrganizationMemberRolePut /organization/{organizationId}/memberEdit an organization member role
MembersAPIGetMemberInvitationGet /organization/{organizationId}/inviteMember/{inviteId}Get member invitation
MembersAPIGetOrganizationInvitedMembersGet /organization/{organizationId}/inviteMemberGet invited members
MembersAPIGetOrganizationMembersGet /organization/{organizationId}/memberGet organization members
MembersAPIPostAcceptInviteMemberPost /organization/{organizationId}/inviteMember/{inviteId}Accept Invite in the organization
MembersAPIPostInviteMemberPost /organization/{organizationId}/inviteMemberInvite someone in the organization
MembersAPIPostOrganizationTransferOwnershipPost /organization/{organizationId}/transferOwnershipTransfer organization ownership to another user
OrganizationAccountGitRepositoriesAPIGetOrganizationBitbucketRepositoriesGet /organization/{organizationId}/account/bitbucket/repositoryGet bitbucket repositories of the connected user
OrganizationAccountGitRepositoriesAPIGetOrganizationBitbucketRepositoryBranchesGet /organization/{organizationId}/account/bitbucket/repository/branchGet bitbucket branches of the specified repository
OrganizationAccountGitRepositoriesAPIGetOrganizationGitProviderAccountGet /organization/{organizationId}/account/gitAuthProviderGet git provider accounts
OrganizationAccountGitRepositoriesAPIGetOrganizationGithubRepositoriesGet /organization/{organizationId}/account/github/repositoryGet github repositories of the connected user
OrganizationAccountGitRepositoriesAPIGetOrganizationGithubRepositoryBranchesGet /organization/{organizationId}/account/github/repository/branchGet github branches of the specified repository
OrganizationAccountGitRepositoriesAPIGetOrganizationGitlabRepositoriesGet /organization/{organizationId}/account/gitlab/repositoryGet gitlab repositories of the connected user
OrganizationAccountGitRepositoriesAPIGetOrganizationGitlabRepositoryBranchesGet /organization/{organizationId}/account/gitlab/repository/branchGet gitlab branches of the specified repository
OrganizationAnnotationsGroupAPICreateOrganizationAnnotationsGroupPost /organization/{organizationId}/annotationsGroupsCreate an organization annotations group
OrganizationAnnotationsGroupAPIDeleteOrganizationAnnotationsGroupDelete /organization/{organizationId}/annotationsGroups/{annotationsGroupId}Delete organization annotations group
OrganizationAnnotationsGroupAPIEditOrganizationAnnotationsGroupPut /organization/{organizationId}/annotationsGroups/{annotationsGroupId}Edit organization annotations group
OrganizationAnnotationsGroupAPIGetOrganizationAnnotationsGroupGet /organization/{organizationId}/annotationsGroups/{annotationsGroupId}Get organization annotations group
OrganizationAnnotationsGroupAPIGetOrganizationAnnotationsGroupAssociatedItemsGet /organization/{organizationId}/annotationsGroups/{annotationsGroupId}/associatedItemsGet organization annotations group associated items
OrganizationAnnotationsGroupAPIListOrganizationAnnotationsGroupGet /organization/{organizationId}/annotationsGroupsList organization annotations group
OrganizationApiTokenAPICreateOrganizationApiTokenPost /organization/{organizationId}/apiTokenCreate an organization api token
OrganizationApiTokenAPIDeleteOrganizationApiTokenDelete /organization/{organizationId}/apiToken/{apiTokenId}Delete organization api token
OrganizationApiTokenAPIListOrganizationApiTokensGet /organization/{organizationId}/apiTokenList organization api tokens
OrganizationCustomRoleAPICreateOrganizationCustomRolePost /organization/{organizationId}/customRoleCreate an organization custom role
OrganizationCustomRoleAPIDeleteOrganizationCustomRoleDelete /organization/{organizationId}/customRole/{customRoleId}Delete organization custom role
OrganizationCustomRoleAPIEditOrganizationCustomRolePut /organization/{organizationId}/customRole/{customRoleId}Edit an organization custom role
OrganizationCustomRoleAPIGetOrganizationCustomRoleGet /organization/{organizationId}/customRole/{customRoleId}Get an organization custom role
OrganizationCustomRoleAPIListOrganizationCustomRolesGet /organization/{organizationId}/customRoleList organization custom roles
OrganizationEventAPIGetOrganizationEventTargetsGet /organization/{organizationId}/targetsGet available event targets to filter events
OrganizationEventAPIGetOrganizationEventsGet /organization/{organizationId}/eventsGet all events inside the organization
OrganizationLabelsGroupAPICreateOrganizationLabelsGroupPost /organization/{organizationId}/labelsGroupsCreate an organization labels group
OrganizationLabelsGroupAPIDeleteOrganizationLabelsGroupDelete /organization/{organizationId}/labelsGroups/{labelsGroupId}Delete organization labels group
OrganizationLabelsGroupAPIEditOrganizationLabelsGroupPut /organization/{organizationId}/labelsGroups/{labelsGroupId}Edit organization labels group
OrganizationLabelsGroupAPIGetOrganizationLabelsGroupAssociatedItemsGet /organization/{organizationId}/labelsGroups/{labelsGroupId}/associatedItemsGet organization labels group associated items
OrganizationLabelsGroupAPIGetOrganizationLabelssGroupGet /organization/{organizationId}/labelsGroups/{labelsGroupId}Get organization labels group
OrganizationLabelsGroupAPIListOrganizationLabelsGroupGet /organization/{organizationId}/labelsGroupsList organization labels group
OrganizationMainCallsAPICreateGitTokenPost /organization/{organizationId}/gitTokenCreate a git token
OrganizationMainCallsAPICreateOrganizationPost /organizationCreate an organization
OrganizationMainCallsAPIDeleteGitTokenDelete /organization/{organizationId}/gitToken/{gitTokenId}Delete a git token
OrganizationMainCallsAPIDeleteOrganizationDelete /organization/{organizationId}Delete an organization
OrganizationMainCallsAPIEditGitTokenPut /organization/{organizationId}/gitToken/{gitTokenId}Edit a git token
OrganizationMainCallsAPIEditOrganizationPut /organization/{organizationId}Edit an organization
OrganizationMainCallsAPIGetContainerRegistryAssociatedServicesGet /organization/{organizationId}/containerRegistry/{containerRegistryId}/associatedServicesGet organization container registry associated services
OrganizationMainCallsAPIGetGitTokenAssociatedServicesGet /organization/{organizationId}/gitToken/{gitTokenId}/associatedServicesGet organization git token associated services
OrganizationMainCallsAPIGetHelmRepositoryAssociatedServicesGet /organization/{organizationId}/helmRepository/{helmRepositoryId}/associatedServicesGet organization helm repository associated services
OrganizationMainCallsAPIGetOrganizationGet /organization/{organizationId}Get organization by ID
OrganizationMainCallsAPIGetOrganizationGitTokenGet /organization/{organizationId}/gitToken/{gitTokenId}Get organization git token
OrganizationMainCallsAPIListOrganizationGet /organizationList user organizations
OrganizationMainCallsAPIListOrganizationAvailableRolesGet /organization/{organizationId}/availableRoleList organization available roles
OrganizationMainCallsAPIListOrganizationGitTokensGet /organization/{organizationId}/gitTokenList organization git tokens
OrganizationWebhookAPICreateOrganizationWebhookPost /organization/{organizationId}/webhookCreate an organization webhook
OrganizationWebhookAPIDeleteOrganizationWebhookDelete /organization/{organizationId}/webhook/{webhookId}Delete organization webhook
OrganizationWebhookAPIEditOrganizationWebhookPut /organization/{organizationId}/webhook/{webhookId}Edit an organization webhook
OrganizationWebhookAPIGetOrganizationWebhookGet /organization/{organizationId}/webhook/{webhookId}Get an Organization webhook
OrganizationWebhookAPIListOrganizationWebHooksGet /organization/{organizationId}/webhookList organization webhooks
ProjectDeploymentRuleAPICreateDeploymentRulePost /project/{projectId}/deploymentRuleCreate a deployment rule
ProjectDeploymentRuleAPIDeleteProjectDeploymentRuleDelete /project/{projectId}/deploymentRule/{deploymentRuleId}Delete a project deployment rule
ProjectDeploymentRuleAPIEditProjectDeployemtnRulePut /project/{projectId}/deploymentRule/{deploymentRuleId}Edit a project deployment rule
ProjectDeploymentRuleAPIGetProjectDeploymentRuleGet /project/{projectId}/deploymentRule/{deploymentRuleId}Get a project deployment rule
ProjectDeploymentRuleAPIListProjectDeploymentRulesGet /project/{projectId}/deploymentRuleList project deployment rules
ProjectDeploymentRuleAPIUpdateDeploymentRulesPriorityOrderPut /project/{projectId}/deploymentRule/orderUpdate deployment rules priority order
ProjectEnvironmentVariableAPICreateProjectEnvironmentVariablePost /project/{projectId}/environmentVariableAdd an environment variable to the project
ProjectEnvironmentVariableAPICreateProjectEnvironmentVariableAliasPost /project/{projectId}/environmentVariable/{environmentVariableId}/aliasCreate an environment variable alias at the project level
ProjectEnvironmentVariableAPICreateProjectEnvironmentVariableOverridePost /project/{projectId}/environmentVariable/{environmentVariableId}/overrideCreate an environment variable override at the project level
ProjectEnvironmentVariableAPIDeleteProjectEnvironmentVariableDelete /project/{projectId}/environmentVariable/{environmentVariableId}Delete an environment variable from a project
ProjectEnvironmentVariableAPIEditProjectEnvironmentVariablePut /project/{projectId}/environmentVariable/{environmentVariableId}Edit an environment variable belonging to the project
ProjectEnvironmentVariableAPIListProjectEnvironmentVariableGet /project/{projectId}/environmentVariableList project environment variables
ProjectMainCallsAPIDeleteProjectDelete /project/{projectId}Delete a project
ProjectMainCallsAPIEditProjectPut /project/{projectId}Edit a project
ProjectMainCallsAPIGetProjectGet /project/{projectId}Get project by ID
ProjectSecretAPICreateProjectSecretPost /project/{projectId}/secretAdd a secret to the project
ProjectSecretAPICreateProjectSecretAliasPost /project/{projectId}/secret/{secretId}/aliasCreate a secret alias at the project level
ProjectSecretAPICreateProjectSecretOverridePost /project/{projectId}/secret/{secretId}/overrideCreate a secret override at the project level
ProjectSecretAPIDeleteProjectSecretDelete /project/{projectId}/secret/{secretId}Delete a secret from a project
ProjectSecretAPIEditProjectSecretPut /project/{projectId}/secret/{secretId}Edit a secret belonging to the project
ProjectSecretAPIListProjectSecretsGet /project/{projectId}/secretList project secrets
ProjectsAPICreateProjectPost /organization/{organizationId}/projectCreate a project
ProjectsAPIGetOrganizationProjectStatsGet /organization/{organizationId}/project/statsList total number of services and environments for each project of the organization
ProjectsAPIListProjectGet /organization/{organizationId}/projectList projects
ReferralRewardsAPIGetAccountReferralGet /account/referralGet your referral information
ReferralRewardsAPIPostAccountRewardClaimPost /account/rewardClaimClaim a reward
UserSignUpAPICreateUserSignUpPost /admin/userSignUpSend Sign Up request
UserSignUpAPIGetUserSignUpGet /admin/userSignUpGet Sign up information
VariableMainCallsAPICreateVariablePost /variableCreate a variable
VariableMainCallsAPICreateVariableAliasPost /variable/{variableId}/aliasCreate a variable alias
VariableMainCallsAPICreateVariableOverridePost /variable/{variableId}/overrideCreate a variable override
VariableMainCallsAPIDeleteVariableDelete /variable/{variableId}Delete a variable
VariableMainCallsAPIEditVariablePut /variable/{variableId}Edit a variable
VariableMainCallsAPIImportEnvironmentVariablesPost /variable/importImport variables
VariableMainCallsAPIListVariablesGet /variableList variables

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

bearerAuth

  • Type: HTTP Bearer token authentication

Example

auth := context.WithValue(context.Background(), qovery.ContextAccessToken, "BEARER_TOKEN_STRING")
r, err := client.Service.Operation(auth, args)

ApiKeyAuth

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

Note, each API key must be added to a map of map[string]APIKey where the key is: Authorization and passed in as the auth context for each request.

Example

auth := context.WithValue(
		context.Background(),
		qovery.ContextAPIKeys,
		map[string]qovery.APIKey{
			"Authorization": {Key: "API_KEY_STRING"},
		},
	)
r, err := client.Service.Operation(auth, args)

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

  • PtrBool
  • PtrInt
  • PtrInt32
  • PtrInt64
  • PtrFloat
  • PtrFloat32
  • PtrFloat64
  • PtrString
  • PtrTime

Author

[email protected]