# Packages
# 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
Class | Method | HTTP request | Description |
---|---|---|---|
AccountInfoAPI | EditAccountInformation | Put /account | Edit account information |
AccountInfoAPI | GetAccountInformation | Get /account | Get Account information |
ApplicationActionsAPI | DeployApplication | Post /application/{applicationId}/deploy | Deploy application |
ApplicationActionsAPI | RebootApplication | Post /application/{applicationId}/restart-service | Reboot application |
ApplicationActionsAPI | RedeployApplication | Post /application/{applicationId}/redeploy | Redeploy application |
ApplicationActionsAPI | StopApplication | Post /application/{applicationId}/stop | Stop application |
ApplicationConfigurationAPI | EditAdvancedSettings | Put /application/{applicationId}/advancedSettings | Edit advanced settings |
ApplicationConfigurationAPI | EditApplicationNetwork | Put /application/{applicationId}/network | Edit Application Network |
ApplicationConfigurationAPI | GetAdvancedSettings | Get /application/{applicationId}/advancedSettings | Get advanced settings |
ApplicationConfigurationAPI | GetApplicationNetwork | Get /application/{applicationId}/network | Get Application Network information |
ApplicationDeploymentHistoryAPI | ListApplicationDeploymentHistory | Get /application/{applicationId}/deploymentHistory | List application deploys |
ApplicationDeploymentRestrictionAPI | CreateApplicationDeploymentRestriction | Post /application/{applicationId}/deploymentRestriction | Create an application deployment restriction |
ApplicationDeploymentRestrictionAPI | DeleteApplicationDeploymentRestriction | Delete /application/{applicationId}/deploymentRestriction/{deploymentRestrictionId} | Delete an application deployment restriction |
ApplicationDeploymentRestrictionAPI | EditApplicationDeploymentRestriction | Put /application/{applicationId}/deploymentRestriction/{deploymentRestrictionId} | Edit an application deployment restriction |
ApplicationDeploymentRestrictionAPI | GetApplicationDeploymentRestrictions | Get /application/{applicationId}/deploymentRestriction | Get application deployment restrictions |
ApplicationEnvironmentVariableAPI | CreateApplicationEnvironmentVariable | Post /application/{applicationId}/environmentVariable | Add an environment variable to the application |
ApplicationEnvironmentVariableAPI | CreateApplicationEnvironmentVariableAlias | Post /application/{applicationId}/environmentVariable/{environmentVariableId}/alias | Create an environment variable alias at the application level |
ApplicationEnvironmentVariableAPI | CreateApplicationEnvironmentVariableOverride | Post /application/{applicationId}/environmentVariable/{environmentVariableId}/override | Create an environment variable override at the application level |
ApplicationEnvironmentVariableAPI | DeleteApplicationEnvironmentVariable | Delete /application/{applicationId}/environmentVariable/{environmentVariableId} | Delete an environment variable from an application |
ApplicationEnvironmentVariableAPI | EditApplicationEnvironmentVariable | Put /application/{applicationId}/environmentVariable/{environmentVariableId} | Edit an environment variable belonging to the application |
ApplicationEnvironmentVariableAPI | ImportEnvironmentVariable | Post /application/{applicationId}/environmentVariable/import | Import variables |
ApplicationEnvironmentVariableAPI | ListApplicationEnvironmentVariable | Get /application/{applicationId}/environmentVariable | List environment variables |
ApplicationLogsAPI | ListApplicationLog | Get /application/{applicationId}/log | List logs |
ApplicationMainCallsAPI | DeleteApplication | Delete /application/{applicationId} | Delete application |
ApplicationMainCallsAPI | EditApplication | Put /application/{applicationId} | Edit application |
ApplicationMainCallsAPI | GetApplication | Get /application/{applicationId} | Get application by ID |
ApplicationMainCallsAPI | GetApplicationStatus | Get /application/{applicationId}/status | Get application status |
ApplicationMainCallsAPI | ListApplicationCommit | Get /application/{applicationId}/commit | List last commits |
ApplicationMainCallsAPI | ListApplicationContributor | Get /application/{applicationId}/contributor | List contributors |
ApplicationMainCallsAPI | ListApplicationLinks | Get /application/{applicationId}/link | List all URLs of the application |
ApplicationSecretAPI | CreateApplicationSecret | Post /application/{applicationId}/secret | Add a secret to the application |
ApplicationSecretAPI | CreateApplicationSecretAlias | Post /application/{applicationId}/secret/{secretId}/alias | Create a secret alias at the application level |
ApplicationSecretAPI | CreateApplicationSecretOverride | Post /application/{applicationId}/secret/{secretId}/override | Create a secret override at the application level |
ApplicationSecretAPI | DeleteApplicationSecret | Delete /application/{applicationId}/secret/{secretId} | Delete a secret from an application |
ApplicationSecretAPI | EditApplicationSecret | Put /application/{applicationId}/secret/{secretId} | Edit a secret belonging to the application |
ApplicationSecretAPI | ListApplicationSecrets | Get /application/{applicationId}/secret | List application secrets |
ApplicationsAPI | CloneApplication | Post /application/{applicationId}/clone | Clone application |
ApplicationsAPI | CreateApplication | Post /environment/{environmentId}/application | Create an application |
ApplicationsAPI | GetDefaultApplicationAdvancedSettings | Get /defaultApplicationAdvancedSettings | List default application advanced settings |
ApplicationsAPI | GetEnvironmentApplicationStatus | Get /environment/{environmentId}/application/status | List all environment applications statuses |
ApplicationsAPI | GetEnvironmentApplicationSupportedLanguages | Get /environment/{environmentId}/application/supportedLanguage | List supported languages |
ApplicationsAPI | ListApplication | Get /environment/{environmentId}/application | List applications |
BackupsAPI | AddBackupDatabase | Post /database/{databaseId}/backup | Add a backup to the Database |
BackupsAPI | ListDatabaseBackup | Get /database/{databaseId}/backup | List database backups |
BackupsAPI | RemoveDatabaseBackup | Delete /database/{databaseId}/backup/{backupId} | Remove database backup |
BillingAPI | AddCreditCard | Post /organization/{organizationId}/creditCard | Add credit card |
BillingAPI | AddCreditCode | Post /organization/{organizationId}/creditCode | Add credit code |
BillingAPI | ChangePlan | Post /organization/{organizationId}/changePlan | Change organization plan |
BillingAPI | DeleteCreditCard | Delete /organization/{organizationId}/creditCard/{creditCardId} | Delete credit card |
BillingAPI | EditOrganizationBillingInfo | Put /organization/{organizationId}/billingInfo | Edit Organization Billing Info |
BillingAPI | GenerateBillingUsageReport | Post /organization/{organizationId}/billingUsageReport | Generate organization billing usage report |
BillingAPI | GetClusterCurrentCost | Get /organization/{organizationId}/cluster/{clusterId}/currentCost | Get cluster current cost |
BillingAPI | GetOrganizationBillingExternalId | Get /organization/{organizationId}/billingExternalId | Get organization billing external ID |
BillingAPI | GetOrganizationBillingInfo | Get /organization/{organizationId}/billingInfo | Get organization billing info |
BillingAPI | GetOrganizationBillingStatus | Get /organization/{organizationId}/billingStatus | Get organization billing status |
BillingAPI | GetOrganizationCurrentCost | Get /organization/{organizationId}/currentCost | Get organization current cost |
BillingAPI | GetOrganizationInvoice | Get /organization/{organizationId}/invoice/{invoiceId} | Get organization invoice |
BillingAPI | GetOrganizationInvoicePDF | Get /organization/{organizationId}/invoice/{invoiceId}/download | Get invoice link |
BillingAPI | ListOrganizationCreditCards | Get /organization/{organizationId}/creditCard | List organization credit cards |
BillingAPI | ListOrganizationInvoice | Get /organization/{organizationId}/invoice | List organization invoices |
BillingAPI | OrganizationDownloadAllInvoices | Post /organization/{organizationId}/downloadInvoices | Download all invoices |
CloudProviderAPI | ListAWSEKSInstanceType | Get /aws/eks/instanceType/{region} | List AWS EKS available instance types |
CloudProviderAPI | ListAWSEc2InstanceType | Get /aws/ec2/instanceType/{region} | List AWS EC2 available instance types |
CloudProviderAPI | ListAWSFeatures | Get /aws/clusterFeature | List AWS features available |
CloudProviderAPI | ListAWSInstanceType | Get /aws/instanceType | List AWS available instance types |
CloudProviderAPI | ListAWSManagedDatabaseInstanceType | Get /aws/managedDatabase/instanceType/{region}/{databaseType} | List AWS available managed database instance types |
CloudProviderAPI | ListAWSManagedDatabaseType | Get /aws/managedDatabase/type | List AWS available managed database types |
CloudProviderAPI | ListAWSRegions | Get /aws/region | List AWS regions |
CloudProviderAPI | ListCloudProvider | Get /cloudProvider | List Cloud providers available |
CloudProviderAPI | ListGcpFeatures | Get /gcp/clusterFeature | List GCP features available |
CloudProviderAPI | ListGcpGkeInstanceType | Get /gcp/instanceType/{region} | List GCP GKE available instance types |
CloudProviderAPI | ListGcpRegions | Get /gcp/region | List GCP regions |
CloudProviderAPI | ListSCWManagedDatabaseInstanceType | Get /scaleway/managedDatabase/instanceType/{zone}/{databaseType} | List Scaleway available managed database instance types |
CloudProviderAPI | ListSCWManagedDatabaseType | Get /scaleway/managedDatabase/type | List Scaleway available managed database types |
CloudProviderAPI | ListScalewayFeatures | Get /scaleway/clusterFeature | List Scaleway features available |
CloudProviderAPI | ListScalewayInstanceType | Get /scaleway/instanceType | List Scaleway available instance types |
CloudProviderAPI | ListScalewayKapsuleInstanceType | Get /scaleway/instanceType/{zone} | List Scaleway Kapsule available instance types |
CloudProviderAPI | ListScalewayRegions | Get /scaleway/region | List Scaleway regions |
CloudProviderCredentialsAPI | CreateAWSCredentials | Post /organization/{organizationId}/aws/credentials | Create AWS credentials set |
CloudProviderCredentialsAPI | CreateGcpCredentials | Post /organization/{organizationId}/gcp/credentials | Create GCP credentials set |
CloudProviderCredentialsAPI | CreateOnPremiseCredentials | Post /organization/{organizationId}/onPremise/credentials | Create OnPremise credentials set |
CloudProviderCredentialsAPI | CreateScalewayCredentials | Post /organization/{organizationId}/scaleway/credentials | Create Scaleway credentials set |
CloudProviderCredentialsAPI | DeleteAWSCredentials | Delete /organization/{organizationId}/aws/credentials/{credentialsId} | Delete a set of AWS credentials |
CloudProviderCredentialsAPI | DeleteGcpCredentials | Delete /organization/{organizationId}/gcp/credentials/{credentialsId} | Delete a set of GCP credentials |
CloudProviderCredentialsAPI | DeleteOnPremiseCredentials | Delete /organization/{organizationId}/onPremise/credentials/{credentialsId} | Delete a set of OnPremise credentials |
CloudProviderCredentialsAPI | DeleteScalewayCredentials | Delete /organization/{organizationId}/scaleway/credentials/{credentialsId} | Delete a set of Scaleway credentials |
CloudProviderCredentialsAPI | EditAWSCredentials | Put /organization/{organizationId}/aws/credentials/{credentialsId} | Edit a set of AWS credentials |
CloudProviderCredentialsAPI | EditGcpCredentials | Put /organization/{organizationId}/gcp/credentials/{credentialsId} | Edit a set of GCP credentials |
CloudProviderCredentialsAPI | EditOnPremiseCredentials | Put /organization/{organizationId}/onPremise/credentials/{credentialsId} | Edit a set of OnPremise credentials |
CloudProviderCredentialsAPI | EditScalewayCredentials | Put /organization/{organizationId}/scaleway/credentials/{credentialsId} | Edit a set of Scaleway credentials |
CloudProviderCredentialsAPI | GetAWSCredentials | Get /organization/{organizationId}/aws/credentials/{credentialsId} | Get a set of AWS credentials |
CloudProviderCredentialsAPI | GetGcpCredentials | Get /organization/{organizationId}/gcp/credentials/{credentialsId} | Get a set of GCP credentials |
CloudProviderCredentialsAPI | GetOnPremiseCredentials | Get /organization/{organizationId}/onPremise/credentials/{credentialsId} | Get a set of OnPremise credentials |
CloudProviderCredentialsAPI | GetScalewayCredentials | Get /organization/{organizationId}/scaleway/credentials/{credentialsId} | Get a set of Scaleway credentials |
CloudProviderCredentialsAPI | ListAWSCredentials | Get /organization/{organizationId}/aws/credentials | List AWS credentials |
CloudProviderCredentialsAPI | ListGcpCredentials | Get /organization/{organizationId}/gcp/credentials | List GCP credentials |
CloudProviderCredentialsAPI | ListOnPremiseCredentials | Get /organization/{organizationId}/onPremise/credentials | List OnPremise credentials |
CloudProviderCredentialsAPI | ListScalewayCredentials | Get /organization/{organizationId}/scaleway/credentials | List Scaleway credentials |
ClustersAPI | CreateCluster | Post /organization/{organizationId}/cluster | Create a cluster |
ClustersAPI | DeleteCluster | Delete /organization/{organizationId}/cluster/{clusterId} | Delete a cluster |
ClustersAPI | DeployCluster | Post /organization/{organizationId}/cluster/{clusterId}/deploy | Deploy a cluster |
ClustersAPI | EditCluster | Put /organization/{organizationId}/cluster/{clusterId} | Edit a cluster |
ClustersAPI | EditClusterAdvancedSettings | Put /organization/{organizationId}/cluster/{clusterId}/advancedSettings | Edit advanced settings |
ClustersAPI | EditClusterKubeconfig | Put /organization/{organizationId}/cluster/{clusterId}/kubeconfig | Edit cluster kubeconfig |
ClustersAPI | EditRoutingTable | Put /organization/{organizationId}/cluster/{clusterId}/routingTable | Edit routing table |
ClustersAPI | GetClusterAdvancedSettings | Get /organization/{organizationId}/cluster/{clusterId}/advancedSettings | Get advanced settings |
ClustersAPI | GetClusterKubeconfig | Get /organization/{organizationId}/cluster/{clusterId}/kubeconfig | Get cluster kubeconfig |
ClustersAPI | GetClusterReadinessStatus | Get /organization/{organizationId}/cluster/{clusterId}/isReady | Know if a cluster is ready to be deployed or not |
ClustersAPI | GetClusterStatus | Get /organization/{organizationId}/cluster/{clusterId}/status | Get cluster status |
ClustersAPI | GetDefaultClusterAdvancedSettings | Get /defaultClusterAdvancedSettings | List default cluster advanced settings |
ClustersAPI | GetInstallationHelmValues | Get /organization/{organizationId}/cluster/{clusterId}/installationHelmValues | Get cluster helm values for self managed installation |
ClustersAPI | GetOrganizationCloudProviderInfo | Get /organization/{organizationId}/cluster/{clusterId}/cloudProviderInfo | Get cluster cloud provider info and credentials |
ClustersAPI | GetOrganizationClusterStatus | Get /organization/{organizationId}/cluster/status | List all clusters statuses |
ClustersAPI | GetRoutingTable | Get /organization/{organizationId}/cluster/{clusterId}/routingTable | Get routing table |
ClustersAPI | ListClusterLogs | Get /organization/{organizationId}/cluster/{clusterId}/logs | List Cluster Logs |
ClustersAPI | ListOrganizationCluster | Get /organization/{organizationId}/cluster | List organization clusters |
ClustersAPI | SpecifyClusterCloudProviderInfo | Post /organization/{organizationId}/cluster/{clusterId}/cloudProviderInfo | Specify cluster cloud provider info and credentials |
ClustersAPI | StopCluster | Post /organization/{organizationId}/cluster/{clusterId}/stop | Stop cluster |
ContainerActionsAPI | DeployContainer | Post /container/{containerId}/deploy | Deploy container |
ContainerActionsAPI | RebootContainer | Post /container/{containerId}/restart-service | Reboot container |
ContainerActionsAPI | RedeployContainer | Post /container/{containerId}/redeploy | Redeploy container |
ContainerActionsAPI | StopContainer | Post /container/{containerId}/stop | Stop container |
ContainerConfigurationAPI | EditContainerAdvancedSettings | Put /container/{containerId}/advancedSettings | Edit advanced settings |
ContainerConfigurationAPI | EditContainerNetwork | Put /container/{containerId}/network | Edit Container Network |
ContainerConfigurationAPI | GetContainerAdvancedSettings | Get /container/{containerId}/advancedSettings | Get advanced settings |
ContainerConfigurationAPI | GetContainerNetwork | Get /container/{containerId}/network | Get Container Network information |
ContainerCustomDomainAPI | CreateContainerCustomDomain | Post /container/{containerId}/customDomain | Add custom domain to the container. |
ContainerCustomDomainAPI | DeleteContainerCustomDomain | Delete /container/{containerId}/customDomain/{customDomainId} | Delete a Custom Domain |
ContainerCustomDomainAPI | EditContainerCustomDomain | Put /container/{containerId}/customDomain/{customDomainId} | Edit a Custom Domain |
ContainerCustomDomainAPI | GetContainerCustomDomainStatus | Get /container/{containerId}/customDomain/{customDomainId}/status | Get Custom Domain status |
ContainerCustomDomainAPI | ListContainerCustomDomain | Get /container/{containerId}/customDomain | List container custom domains |
ContainerDeploymentHistoryAPI | ListContainerDeploymentHistory | Get /container/{containerId}/deploymentHistory | List container deployments |
ContainerEnvironmentVariableAPI | CreateContainerEnvironmentVariable | Post /container/{containerId}/environmentVariable | Add an environment variable to the container |
ContainerEnvironmentVariableAPI | CreateContainerEnvironmentVariableAlias | Post /container/{containerId}/environmentVariable/{environmentVariableId}/alias | Create an environment variable alias at the container level |
ContainerEnvironmentVariableAPI | CreateContainerEnvironmentVariableOverride | Post /container/{containerId}/environmentVariable/{environmentVariableId}/override | Create an environment variable override at the container level |
ContainerEnvironmentVariableAPI | DeleteContainerEnvironmentVariable | Delete /container/{containerId}/environmentVariable/{environmentVariableId} | Delete an environment variable from a container |
ContainerEnvironmentVariableAPI | EditContainerEnvironmentVariable | Put /container/{containerId}/environmentVariable/{environmentVariableId} | Edit an environment variable belonging to the container |
ContainerEnvironmentVariableAPI | ImportContainerEnvironmentVariable | Post /container/{containerId}/environmentVariable/import | Import variables |
ContainerEnvironmentVariableAPI | ListContainerEnvironmentVariable | Get /container/{containerId}/environmentVariable | List environment variables |
ContainerLogsAPI | ListContainerLog | Get /container/{containerId}/log | List logs |
ContainerMainCallsAPI | DeleteContainer | Delete /container/{containerId} | Delete container |
ContainerMainCallsAPI | EditContainer | Put /container/{containerId} | Edit container |
ContainerMainCallsAPI | GetContainer | Get /container/{containerId} | Get container by ID |
ContainerMainCallsAPI | GetContainerStatus | Get /container/{containerId}/status | Get container status |
ContainerMainCallsAPI | ListContainerLinks | Get /container/{containerId}/link | List all URLs of the container |
ContainerRegistriesAPI | CreateContainerRegistry | Post /organization/{organizationId}/containerRegistry | Create a container registry |
ContainerRegistriesAPI | DeleteContainerRegistry | Delete /organization/{organizationId}/containerRegistry/{containerRegistryId} | Delete a container registry |
ContainerRegistriesAPI | EditContainerRegistry | Put /organization/{organizationId}/containerRegistry/{containerRegistryId} | Edit a container registry |
ContainerRegistriesAPI | GetContainerRegistry | Get /organization/{organizationId}/containerRegistry/{containerRegistryId} | Get a container registry |
ContainerRegistriesAPI | GetContainerVersions | Get /organization/{organizationId}/containerRegistry/{containerRegistryId}/images | List image version for a container registry |
ContainerRegistriesAPI | ListAvailableContainerRegistry | Get /availableContainerRegistry | List supported container registries |
ContainerRegistriesAPI | ListContainerRegistry | Get /organization/{organizationId}/containerRegistry | List organization container registries |
ContainerSecretAPI | CreateContainerSecret | Post /container/{containerId}/secret | Add a secret to the container |
ContainerSecretAPI | CreateContainerSecretAlias | Post /container/{containerId}/secret/{secretId}/alias | Create a secret alias at the container level |
ContainerSecretAPI | CreateContainerSecretOverride | Post /container/{containerId}/secret/{secretId}/override | Create a secret override at the container level |
ContainerSecretAPI | DeleteContainerSecret | Delete /container/{containerId}/secret/{secretId} | Delete a secret from an container |
ContainerSecretAPI | EditContainerSecret | Put /container/{containerId}/secret/{secretId} | Edit a secret belonging to the container |
ContainerSecretAPI | ListContainerSecrets | Get /container/{containerId}/secret | List container secrets |
ContainersAPI | AutoDeployContainerEnvironments | Post /organization/{organizationId}/container/deploy | Auto deploy containers |
ContainersAPI | CloneContainer | Post /container/{containerId}/clone | Clone container |
ContainersAPI | CreateContainer | Post /environment/{environmentId}/container | Create a container |
ContainersAPI | GetContainerRegistryContainerStatus | Get /organization/{organizationId}/containerRegistry/{containerRegistryId}/container/status | List all container registry container statuses |
ContainersAPI | GetDefaultContainerAdvancedSettings | Get /defaultContainerAdvancedSettings | List default container advanced settings |
ContainersAPI | GetEnvironmentContainerStatus | Get /environment/{environmentId}/container/status | List all environment container statuses |
ContainersAPI | ListContainer | Get /environment/{environmentId}/container | List containers |
ContainersAPI | PreviewContainerEnvironments | Post /organization/{organizationId}/container/preview | Preview container environments |
CustomDomainAPI | CheckApplicationCustomDomain | Get /application/{applicationId}/checkCustomDomain | Check Application Custom Domain |
CustomDomainAPI | CheckContainerCustomDomain | Get /container/{containerId}/checkCustomDomain | Check Container Custom Domain |
CustomDomainAPI | CheckHelmCustomDomain | Get /helm/{helmId}/checkCustomDomain | Check Helm Custom Domain |
CustomDomainAPI | CreateApplicationCustomDomain | Post /application/{applicationId}/customDomain | Add custom domain to the application. |
CustomDomainAPI | DeleteCustomDomain | Delete /application/{applicationId}/customDomain/{customDomainId} | Delete a Custom Domain |
CustomDomainAPI | EditCustomDomain | Put /application/{applicationId}/customDomain/{customDomainId} | Edit a Custom Domain |
CustomDomainAPI | GetCustomDomainStatus | Get /application/{applicationId}/customDomain/{customDomainId}/status | Get Custom Domain status |
CustomDomainAPI | ListApplicationCustomDomain | Get /application/{applicationId}/customDomain | List application custom domains |
DatabaseActionsAPI | DeployDatabase | Post /database/{databaseId}/deploy | Deploy database |
DatabaseActionsAPI | RebootDatabase | Post /database/{databaseId}/restart-service | Retart database |
DatabaseActionsAPI | RedeployDatabase | Post /database/{databaseId}/redeploy | Redeploy database |
DatabaseActionsAPI | StopDatabase | Post /database/{databaseId}/stop | Stop database |
DatabaseApplicationAPI | ListDatabaseApplication | Get /database/{databaseId}/application | List applications using the database |
DatabaseApplicationAPI | RemoveApplicationFromDatabase | Delete /database/{databaseId}/application/{targetApplicationId} | Remove an application from this database |
DatabaseDeploymentHistoryAPI | ListDatabaseDeploymentHistory | Get /database/{databaseId}/deploymentHistory | List database deploys |
DatabaseMainCallsAPI | DeleteDatabase | Delete /database/{databaseId} | Delete a database |
DatabaseMainCallsAPI | EditDatabase | Put /database/{databaseId} | Edit a database |
DatabaseMainCallsAPI | EditDatabaseCredentials | Put /database/{databaseId}/masterCredentials | Edit database master credentials |
DatabaseMainCallsAPI | GetDatabase | Get /database/{databaseId} | Get database by ID |
DatabaseMainCallsAPI | GetDatabaseMasterCredentials | Get /database/{databaseId}/masterCredentials | Get master credentials of the database |
DatabaseMainCallsAPI | GetDatabaseStatus | Get /database/{databaseId}/status | Get database status |
DatabaseMainCallsAPI | ListDatabaseVersion | Get /database/{databaseId}/version | List eligible versions for the database |
DatabasesAPI | CloneDatabase | Post /database/{databaseId}/clone | Clone database |
DatabasesAPI | CreateDatabase | Post /environment/{environmentId}/database | Create a database |
DatabasesAPI | GetEnvironmentDatabaseStatus | Get /environment/{environmentId}/database/status | List all environment databases statuses |
DatabasesAPI | ListDatabase | Get /environment/{environmentId}/database | List environment databases |
DatabasesAPI | ListEnvironmentDatabaseConfig | Get /environment/{environmentId}/databaseConfiguration | List eligible database types, versions and modes for the environment |
DefaultAPI | GetClusterTokenByClusterId | Get /cluster/{clusterId}/token | Get cluster token by clusterId |
DefaultAPI | GetHelmKubernetesServices | Get /helm/{helmId}/listServices | Get helm kubernetes services |
DeploymentStageMainCallsAPI | AttachServiceToDeploymentStage | Put /deploymentStage/{deploymentStageId}/service/{serviceId} | Attach service to deployment stage |
DeploymentStageMainCallsAPI | CreateEnvironmentDeploymentStage | Post /environment/{environmentId}/deploymentStage | Create environment deployment stage |
DeploymentStageMainCallsAPI | DeleteDeploymentStage | Delete /deploymentStage/{deploymentStageId} | Delete deployment stage |
DeploymentStageMainCallsAPI | EditDeploymentStage | Put /deploymentStage/{deploymentStageId} | Edit deployment stage |
DeploymentStageMainCallsAPI | GetDeploymentStage | Get /deploymentStage/{deploymentStageId} | Get Deployment Stage |
DeploymentStageMainCallsAPI | GetServiceDeploymentStage | Get /service/{serviceId}/deploymentStage | Get Service Deployment Stage |
DeploymentStageMainCallsAPI | ListEnvironmentDeploymentStage | Get /environment/{environmentId}/deploymentStage | List environment deployment stage |
DeploymentStageMainCallsAPI | MoveAfterDeploymentStage | Put /deploymentStage/{deploymentStageId}/moveAfter/{stageId} | Move deployment stage after requested stage |
DeploymentStageMainCallsAPI | MoveBeforeDeploymentStage | Put /deploymentStage/{deploymentStageId}/moveBefore/{stageId} | Move deployment stage before requested stage |
EnvironmentAPI | CheckContainerImage | Post /environment/{environmentId}/checkContainerImage | Check container image configuration is correct |
EnvironmentAPI | CheckDockerfile | Post /environment/{environmentId}/checkDockerfile | Check dockerfile configuration is correct |
EnvironmentAPI | CheckGitFile | Post /environment/{environmentId}/checkGitFile | Check git file configuration is correct |
EnvironmentAPI | CheckHelmRepository | Post /environment/{environmentId}/checkHelmRepository | Check helm repository configuration is correct |
EnvironmentAPI | DeployAllApplications | Post /environment/{environmentId}/application/deploy | Deploy applications |
EnvironmentActionsAPI | CancelEnvironmentDeployment | Post /environment/{environmentId}/cancelDeployment | Cancel environment deployment |
EnvironmentActionsAPI | CleanFailedJobs | Post /environment/{environmentId}/cleanFailedJobs | Clean failed jobs within an environment |
EnvironmentActionsAPI | CloneEnvironment | Post /environment/{environmentId}/clone | Clone environment |
EnvironmentActionsAPI | DeleteSelectedServices | Post /environment/{environmentId}/service/delete | Delete services |
EnvironmentActionsAPI | DeployAllServices | Post /environment/{environmentId}/service/deploy | Deploy services |
EnvironmentActionsAPI | DeployEnvironment | Post /environment/{environmentId}/deploy | Deploy environment |
EnvironmentActionsAPI | RebootServices | Post /environment/{environmentId}/service/restart-service | Reboot services |
EnvironmentActionsAPI | RedeployEnvironment | Post /environment/{environmentId}/redeploy | Redeploy environment |
EnvironmentActionsAPI | StopEnvironment | Post /environment/{environmentId}/stop | Stop environment |
EnvironmentActionsAPI | StopSelectedServices | Post /environment/{environmentId}/service/stop | Stop services |
EnvironmentDeploymentHistoryAPI | ListEnvironmentDeploymentHistory | Get /environment/{environmentId}/deploymentHistory | List environment deployments |
EnvironmentDeploymentRuleAPI | EditEnvironmentDeploymentRule | Put /environment/{environmentId}/deploymentRule/{deploymentRuleId} | Edit an environment deployment rule |
EnvironmentDeploymentRuleAPI | GetEnvironmentDeploymentRule | Get /environment/{environmentId}/deploymentRule | Get environment deployment rule |
EnvironmentExportAPI | ExportEnvironmentConfigurationIntoTerraform | Get /environment/{environmentId}/terraformExport | Export full environment and its resources into Terraform manifests |
EnvironmentLogsAPI | ListEnvironmentLog | Get /environment/{environmentId}/log | List environment deployment logs |
EnvironmentLogsAPI | ListEnvironmentLogs | Get /environment/{environmentId}/logs | List environment deployment logs v2 |
EnvironmentMainCallsAPI | DeleteEnvironment | Delete /environment/{environmentId} | Delete an environment |
EnvironmentMainCallsAPI | EditEnvironment | Put /environment/{environmentId} | Edit an environment |
EnvironmentMainCallsAPI | GetEnvironment | Get /environment/{environmentId} | Get environment by ID |
EnvironmentMainCallsAPI | GetEnvironmentStatus | Get /environment/{environmentId}/status | Get environment status |
EnvironmentMainCallsAPI | GetEnvironmentStatuses | Get /environment/{environmentId}/statuses | Get environment statuses with services status |
EnvironmentMainCallsAPI | GetEnvironmentStatusesWithStages | Get /environment/{environmentId}/statusesWithStages | Get environment statuses with stages |
EnvironmentSecretAPI | CreateEnvironmentSecret | Post /environment/{environmentId}/secret | Add a secret to the environment |
EnvironmentSecretAPI | CreateEnvironmentSecretAlias | Post /environment/{environmentId}/secret/{secretId}/alias | Create a secret alias at the environment level |
EnvironmentSecretAPI | CreateEnvironmentSecretOverride | Post /environment/{environmentId}/secret/{secretId}/override | Create a secret override at the environment level |
EnvironmentSecretAPI | DeleteEnvironmentSecret | Delete /environment/{environmentId}/secret/{secretId} | Delete a secret from the environment |
EnvironmentSecretAPI | EditEnvironmentSecret | Put /environment/{environmentId}/secret/{secretId} | Edit a secret belonging to the environment |
EnvironmentSecretAPI | ListEnvironmentSecrets | Get /environment/{environmentId}/secret | List environment secrets |
EnvironmentVariableAPI | CreateEnvironmentEnvironmentVariable | Post /environment/{environmentId}/environmentVariable | Add an environment variable to the environment |
EnvironmentVariableAPI | CreateEnvironmentEnvironmentVariableAlias | Post /environment/{environmentId}/environmentVariable/{environmentVariableId}/alias | Create an environment variable alias at the environment level |
EnvironmentVariableAPI | CreateEnvironmentEnvironmentVariableOverride | Post /environment/{environmentId}/environmentVariable/{environmentVariableId}/override | Create an environment variable override at the environment level |
EnvironmentVariableAPI | DeleteEnvironmentEnvironmentVariable | Delete /environment/{environmentId}/environmentVariable/{environmentVariableId} | Delete an environment variable from an environment |
EnvironmentVariableAPI | EditEnvironmentEnvironmentVariable | Put /environment/{environmentId}/environmentVariable/{environmentVariableId} | Edit an environment variable belonging to the environment |
EnvironmentVariableAPI | ListEnvironmentEnvironmentVariable | Get /environment/{environmentId}/environmentVariable | List environment variables |
EnvironmentsAPI | CreateEnvironment | Post /project/{projectId}/environment | Create an environment |
EnvironmentsAPI | GetProjectEnvironmentServiceNumber | Get /project/{projectId}/environment/stats | List total number of services for each environment of the project |
EnvironmentsAPI | GetProjectEnvironmentsStatus | Get /project/{projectId}/environment/status | List environments statuses |
EnvironmentsAPI | ListEnvironment | Get /project/{projectId}/environment | List environments |
GitRepositoriesAPI | GetBitbucketRepositories | Get /account/bitbucket/repository | Get bitbucket repositories of the connected user |
GitRepositoriesAPI | GetBitbucketRepositoryBranches | Get /account/bitbucket/repository/branch | Get bitbucket branches of the specified repository |
GitRepositoriesAPI | GetGitProviderAccount | Get /account/gitAuthProvider | Get git provider accounts |
GitRepositoriesAPI | GetGithubRepositories | Get /account/github/repository | Get github repositories of the connected user |
GitRepositoriesAPI | GetGithubRepositoryBranches | Get /account/github/repository/branch | Get github branches of the specified repository |
GitRepositoriesAPI | GetGitlabRepositories | Get /account/gitlab/repository | Get gitlab repositories of the connected user |
GitRepositoriesAPI | GetGitlabRepositoryBranches | Get /account/gitlab/repository/branch | Get gitlab branches of the specified repository |
GithubAppAPI | OrganizationGithubAppConnect | Post /organization/{organizationId}/github/connect | Connect a github account to an organization |
GithubAppAPI | OrganizationGithubAppDisconnect | Delete /organization/{organizationId}/github/disconnect | Disconnect a github account from an organization |
HelmActionsAPI | DeployHelm | Post /helm/{helmId}/deploy | Deploy helm |
HelmActionsAPI | RedeployHelm | Post /helm/{helmId}/redeploy | Redeploy helm |
HelmActionsAPI | StopHelm | Post /helm/{helmId}/stop | Stop helm |
HelmConfigurationAPI | EditHelmAdvancedSettings | Put /helm/{helmId}/advancedSettings | Edit advanced settings |
HelmConfigurationAPI | GetHelmAdvancedSettings | Get /helm/{helmId}/advancedSettings | Get advanced settings |
HelmCustomDomainAPI | CreateHelmCustomDomain | Post /helm/{helmId}/customDomain | Add custom domain to the helm. |
HelmCustomDomainAPI | DeleteHelmCustomDomain | Delete /helm/{helmId}/customDomain/{customDomainId} | Delete a Custom Domain |
HelmCustomDomainAPI | EditHelmCustomDomain | Put /helm/{helmId}/customDomain/{customDomainId} | Edit a Custom Domain |
HelmCustomDomainAPI | GetHelmCustomDomain | Get /helm/{helmId}/customDomain/{customDomainId} | Get a Custom Domain |
HelmCustomDomainAPI | ListHelmCustomDomain | Get /helm/{helmId}/customDomain | List helm custom domains |
HelmDeploymentHistoryAPI | ListHelmDeploymentHistory | Get /helm/{helmId}/deploymentHistory | List helm deployments |
HelmDeploymentRestrictionAPI | CreateHelmDeploymentRestriction | Post /helm/{helmId}/deploymentRestriction | Create a helm deployment restriction |
HelmDeploymentRestrictionAPI | DeleteHelmDeploymentRestriction | Delete /helm/{helmId}/deploymentRestriction/{deploymentRestrictionId} | Delete a helm deployment restriction |
HelmDeploymentRestrictionAPI | EditHelmDeploymentRestriction | Put /helm/{helmId}/deploymentRestriction/{deploymentRestrictionId} | Edit a helm deployment restriction |
HelmDeploymentRestrictionAPI | GetHelmDeploymentRestrictions | Get /helm/{helmId}/deploymentRestriction | Get helm deployment restrictions |
HelmMainCallsAPI | DeleteHelm | Delete /helm/{helmId} | Delete helm |
HelmMainCallsAPI | EditHelm | Put /helm/{helmId} | Edit helm |
HelmMainCallsAPI | GetHelm | Get /helm/{helmId} | Get helm by ID |
HelmMainCallsAPI | GetHelmStatus | Get /helm/{helmId}/status | Get helm status |
HelmMainCallsAPI | ListHelmCommit | Get /helm/{helmId}/commit | List last helm commits |
HelmMainCallsAPI | ListHelmLinks | Get /helm/{helmId}/link | List all URLs of the helm |
HelmRepositoriesAPI | CreateHelmRepository | Post /organization/{organizationId}/helmRepository | Create a helm repository |
HelmRepositoriesAPI | DeleteHelmRepository | Delete /organization/{organizationId}/helmRepository/{helmRepositoryId} | Delete a helm repository |
HelmRepositoriesAPI | EditHelmRepository | Put /organization/{organizationId}/helmRepository/{helmRepositoryId} | Edit a helm repository |
HelmRepositoriesAPI | GetHelmCharts | Get /organization/{organizationId}/helmRepository/{helmRepositoryId}/charts | List helm charts contained inside the repository |
HelmRepositoriesAPI | GetHelmRepository | Get /organization/{organizationId}/helmRepository/{helmRepositoryId} | Get a helm repository |
HelmRepositoriesAPI | ListAvailableHelmRepository | Get /availableHelmRepository | List supported helm repository |
HelmRepositoriesAPI | ListHelmRepository | Get /organization/{organizationId}/helmRepository | List organization helm repositories |
HelmsAPI | CloneHelm | Post /helm/{helmId}/clone | Clone helm |
HelmsAPI | CreateHelm | Post /environment/{environmentId}/helm | Create a helm |
HelmsAPI | CreateHelmDefaultValues | Post /environment/{environmentId}/helmDefaultValues | Get helm default values |
HelmsAPI | GetDefaultHelmAdvancedSettings | Get /defaultHelmAdvancedSettings | List default helm advanced settings |
HelmsAPI | GetEnvironmentHelmStatus | Get /environment/{environmentId}/helm/status | List all environment helm statuses |
HelmsAPI | ListHelms | Get /environment/{environmentId}/helm | List helms |
JobActionsAPI | CleanFailedJob | Post /job/{jobId}/cleanFailedJob | Clean a failed job |
JobActionsAPI | DeployJob | Post /job/{jobId}/deploy | Deploy job |
JobActionsAPI | RedeployJob | Post /job/{jobId}/redeploy | Redeploy job |
JobActionsAPI | StopJob | Post /job/{jobId}/stop | Stop job |
JobConfigurationAPI | EditJobAdvancedSettings | Put /job/{jobId}/advancedSettings | Edit advanced settings |
JobConfigurationAPI | GetJobAdvancedSettings | Get /job/{jobId}/advancedSettings | Get advanced settings |
JobDeploymentHistoryAPI | ListJobDeploymentHistory | Get /job/{jobId}/deploymentHistory | List job deployments |
JobDeploymentRestrictionAPI | CreateJobDeploymentRestriction | Post /job/{jobId}/deploymentRestriction | Create a job deployment restriction |
JobDeploymentRestrictionAPI | DeleteJobDeploymentRestriction | Delete /job/{jobId}/deploymentRestriction/{deploymentRestrictionId} | Delete a job deployment restriction |
JobDeploymentRestrictionAPI | EditJobDeploymentRestriction | Put /job/{jobId}/deploymentRestriction/{deploymentRestrictionId} | Edit a job deployment restriction |
JobDeploymentRestrictionAPI | GetJobDeploymentRestrictions | Get /job/{jobId}/deploymentRestriction | Get job deployment restrictions |
JobEnvironmentVariableAPI | CreateJobEnvironmentVariable | Post /job/{jobId}/environmentVariable | Add an environment variable to the job |
JobEnvironmentVariableAPI | CreateJobEnvironmentVariableAlias | Post /job/{jobId}/environmentVariable/{environmentVariableId}/alias | Create an environment variable alias at the job level |
JobEnvironmentVariableAPI | CreateJobEnvironmentVariableOverride | Post /job/{jobId}/environmentVariable/{environmentVariableId}/override | Create an environment variable override at the job level |
JobEnvironmentVariableAPI | DeleteJobEnvironmentVariable | Delete /job/{jobId}/environmentVariable/{environmentVariableId} | Delete an environment variable from a job |
JobEnvironmentVariableAPI | EditJobEnvironmentVariable | Put /job/{jobId}/environmentVariable/{environmentVariableId} | Edit an environment variable belonging to the job |
JobEnvironmentVariableAPI | ImportJobEnvironmentVariable | Post /job/{jobId}/environmentVariable/import | Import variables |
JobEnvironmentVariableAPI | ListJobEnvironmentVariable | Get /job/{jobId}/environmentVariable | List environment variables |
JobMainCallsAPI | DeleteJob | Delete /job/{jobId} | Delete job |
JobMainCallsAPI | EditJob | Put /job/{jobId} | Edit job |
JobMainCallsAPI | GetJob | Get /job/{jobId} | Get job by ID |
JobMainCallsAPI | GetJobStatus | Get /job/{jobId}/status | Get job status |
JobMainCallsAPI | ListJobCommit | Get /job/{jobId}/commit | List last job commits |
JobSecretAPI | CreateJobSecret | Post /job/{jobId}/secret | Add a secret to the job |
JobSecretAPI | CreateJobSecretAlias | Post /job/{jobId}/secret/{secretId}/alias | Create a secret alias at the job level |
JobSecretAPI | CreateJobSecretOverride | Post /job/{jobId}/secret/{secretId}/override | Create a secret override at the job level |
JobSecretAPI | DeleteJobSecret | Delete /job/{jobId}/secret/{secretId} | Delete a secret from an job |
JobSecretAPI | EditJobSecret | Put /job/{jobId}/secret/{secretId} | Edit a secret belonging to the job |
JobSecretAPI | ListJobSecrets | Get /job/{jobId}/secret | List job secrets |
JobsAPI | AutoDeployJobEnvironments | Post /organization/{organizationId}/job/deploy | Auto deploy jobs |
JobsAPI | CloneJob | Post /job/{jobId}/clone | Clone job |
JobsAPI | CreateJob | Post /environment/{environmentId}/job | Create a job |
JobsAPI | GetDefaultJobAdvancedSettings | Get /defaultJobAdvancedSettings | List default job advanced settings |
JobsAPI | GetEnvironmentJobStatus | Get /environment/{environmentId}/job/status | List all environment job statuses |
JobsAPI | ListJobs | Get /environment/{environmentId}/job | List jobs |
LifecycleTemplateMainCallsAPI | GetEnvironmentLifecycleTemplate | Get /environment/{environmentId}/lifecycleTemplate/{lifecycleTemplateId} | Get specific lifecycle template |
LifecycleTemplateMainCallsAPI | ListEnvironmentLifecycleTemplates | Get /environment/{environmentId}/lifecycleTemplate | List available lifecycle template for this environment |
MembersAPI | DeleteInviteMember | Delete /organization/{organizationId}/inviteMember/{inviteId} | Remove an invited member |
MembersAPI | DeleteMember | Delete /organization/{organizationId}/member | Remove a member |
MembersAPI | EditOrganizationMemberRole | Put /organization/{organizationId}/member | Edit an organization member role |
MembersAPI | GetMemberInvitation | Get /organization/{organizationId}/inviteMember/{inviteId} | Get member invitation |
MembersAPI | GetOrganizationInvitedMembers | Get /organization/{organizationId}/inviteMember | Get invited members |
MembersAPI | GetOrganizationMembers | Get /organization/{organizationId}/member | Get organization members |
MembersAPI | PostAcceptInviteMember | Post /organization/{organizationId}/inviteMember/{inviteId} | Accept Invite in the organization |
MembersAPI | PostInviteMember | Post /organization/{organizationId}/inviteMember | Invite someone in the organization |
MembersAPI | PostOrganizationTransferOwnership | Post /organization/{organizationId}/transferOwnership | Transfer organization ownership to another user |
OrganizationAccountGitRepositoriesAPI | GetOrganizationBitbucketRepositories | Get /organization/{organizationId}/account/bitbucket/repository | Get bitbucket repositories of the connected user |
OrganizationAccountGitRepositoriesAPI | GetOrganizationBitbucketRepositoryBranches | Get /organization/{organizationId}/account/bitbucket/repository/branch | Get bitbucket branches of the specified repository |
OrganizationAccountGitRepositoriesAPI | GetOrganizationGitProviderAccount | Get /organization/{organizationId}/account/gitAuthProvider | Get git provider accounts |
OrganizationAccountGitRepositoriesAPI | GetOrganizationGithubRepositories | Get /organization/{organizationId}/account/github/repository | Get github repositories of the connected user |
OrganizationAccountGitRepositoriesAPI | GetOrganizationGithubRepositoryBranches | Get /organization/{organizationId}/account/github/repository/branch | Get github branches of the specified repository |
OrganizationAccountGitRepositoriesAPI | GetOrganizationGitlabRepositories | Get /organization/{organizationId}/account/gitlab/repository | Get gitlab repositories of the connected user |
OrganizationAccountGitRepositoriesAPI | GetOrganizationGitlabRepositoryBranches | Get /organization/{organizationId}/account/gitlab/repository/branch | Get gitlab branches of the specified repository |
OrganizationAnnotationsGroupAPI | CreateOrganizationAnnotationsGroup | Post /organization/{organizationId}/annotationsGroups | Create an organization annotations group |
OrganizationAnnotationsGroupAPI | DeleteOrganizationAnnotationsGroup | Delete /organization/{organizationId}/annotationsGroups/{annotationsGroupId} | Delete organization annotations group |
OrganizationAnnotationsGroupAPI | EditOrganizationAnnotationsGroup | Put /organization/{organizationId}/annotationsGroups/{annotationsGroupId} | Edit organization annotations group |
OrganizationAnnotationsGroupAPI | GetOrganizationAnnotationsGroup | Get /organization/{organizationId}/annotationsGroups/{annotationsGroupId} | Get organization annotations group |
OrganizationAnnotationsGroupAPI | GetOrganizationAnnotationsGroupAssociatedItems | Get /organization/{organizationId}/annotationsGroups/{annotationsGroupId}/associatedItems | Get organization annotations group associated items |
OrganizationAnnotationsGroupAPI | ListOrganizationAnnotationsGroup | Get /organization/{organizationId}/annotationsGroups | List organization annotations group |
OrganizationApiTokenAPI | CreateOrganizationApiToken | Post /organization/{organizationId}/apiToken | Create an organization api token |
OrganizationApiTokenAPI | DeleteOrganizationApiToken | Delete /organization/{organizationId}/apiToken/{apiTokenId} | Delete organization api token |
OrganizationApiTokenAPI | ListOrganizationApiTokens | Get /organization/{organizationId}/apiToken | List organization api tokens |
OrganizationCustomRoleAPI | CreateOrganizationCustomRole | Post /organization/{organizationId}/customRole | Create an organization custom role |
OrganizationCustomRoleAPI | DeleteOrganizationCustomRole | Delete /organization/{organizationId}/customRole/{customRoleId} | Delete organization custom role |
OrganizationCustomRoleAPI | EditOrganizationCustomRole | Put /organization/{organizationId}/customRole/{customRoleId} | Edit an organization custom role |
OrganizationCustomRoleAPI | GetOrganizationCustomRole | Get /organization/{organizationId}/customRole/{customRoleId} | Get an organization custom role |
OrganizationCustomRoleAPI | ListOrganizationCustomRoles | Get /organization/{organizationId}/customRole | List organization custom roles |
OrganizationEventAPI | GetOrganizationEventTargets | Get /organization/{organizationId}/targets | Get available event targets to filter events |
OrganizationEventAPI | GetOrganizationEvents | Get /organization/{organizationId}/events | Get all events inside the organization |
OrganizationLabelsGroupAPI | CreateOrganizationLabelsGroup | Post /organization/{organizationId}/labelsGroups | Create an organization labels group |
OrganizationLabelsGroupAPI | DeleteOrganizationLabelsGroup | Delete /organization/{organizationId}/labelsGroups/{labelsGroupId} | Delete organization labels group |
OrganizationLabelsGroupAPI | EditOrganizationLabelsGroup | Put /organization/{organizationId}/labelsGroups/{labelsGroupId} | Edit organization labels group |
OrganizationLabelsGroupAPI | GetOrganizationLabelsGroupAssociatedItems | Get /organization/{organizationId}/labelsGroups/{labelsGroupId}/associatedItems | Get organization labels group associated items |
OrganizationLabelsGroupAPI | GetOrganizationLabelssGroup | Get /organization/{organizationId}/labelsGroups/{labelsGroupId} | Get organization labels group |
OrganizationLabelsGroupAPI | ListOrganizationLabelsGroup | Get /organization/{organizationId}/labelsGroups | List organization labels group |
OrganizationMainCallsAPI | CreateGitToken | Post /organization/{organizationId}/gitToken | Create a git token |
OrganizationMainCallsAPI | CreateOrganization | Post /organization | Create an organization |
OrganizationMainCallsAPI | DeleteGitToken | Delete /organization/{organizationId}/gitToken/{gitTokenId} | Delete a git token |
OrganizationMainCallsAPI | DeleteOrganization | Delete /organization/{organizationId} | Delete an organization |
OrganizationMainCallsAPI | EditGitToken | Put /organization/{organizationId}/gitToken/{gitTokenId} | Edit a git token |
OrganizationMainCallsAPI | EditOrganization | Put /organization/{organizationId} | Edit an organization |
OrganizationMainCallsAPI | GetContainerRegistryAssociatedServices | Get /organization/{organizationId}/containerRegistry/{containerRegistryId}/associatedServices | Get organization container registry associated services |
OrganizationMainCallsAPI | GetGitTokenAssociatedServices | Get /organization/{organizationId}/gitToken/{gitTokenId}/associatedServices | Get organization git token associated services |
OrganizationMainCallsAPI | GetHelmRepositoryAssociatedServices | Get /organization/{organizationId}/helmRepository/{helmRepositoryId}/associatedServices | Get organization helm repository associated services |
OrganizationMainCallsAPI | GetOrganization | Get /organization/{organizationId} | Get organization by ID |
OrganizationMainCallsAPI | GetOrganizationGitToken | Get /organization/{organizationId}/gitToken/{gitTokenId} | Get organization git token |
OrganizationMainCallsAPI | ListOrganization | Get /organization | List user organizations |
OrganizationMainCallsAPI | ListOrganizationAvailableRoles | Get /organization/{organizationId}/availableRole | List organization available roles |
OrganizationMainCallsAPI | ListOrganizationGitTokens | Get /organization/{organizationId}/gitToken | List organization git tokens |
OrganizationWebhookAPI | CreateOrganizationWebhook | Post /organization/{organizationId}/webhook | Create an organization webhook |
OrganizationWebhookAPI | DeleteOrganizationWebhook | Delete /organization/{organizationId}/webhook/{webhookId} | Delete organization webhook |
OrganizationWebhookAPI | EditOrganizationWebhook | Put /organization/{organizationId}/webhook/{webhookId} | Edit an organization webhook |
OrganizationWebhookAPI | GetOrganizationWebhook | Get /organization/{organizationId}/webhook/{webhookId} | Get an Organization webhook |
OrganizationWebhookAPI | ListOrganizationWebHooks | Get /organization/{organizationId}/webhook | List organization webhooks |
ProjectDeploymentRuleAPI | CreateDeploymentRule | Post /project/{projectId}/deploymentRule | Create a deployment rule |
ProjectDeploymentRuleAPI | DeleteProjectDeploymentRule | Delete /project/{projectId}/deploymentRule/{deploymentRuleId} | Delete a project deployment rule |
ProjectDeploymentRuleAPI | EditProjectDeployemtnRule | Put /project/{projectId}/deploymentRule/{deploymentRuleId} | Edit a project deployment rule |
ProjectDeploymentRuleAPI | GetProjectDeploymentRule | Get /project/{projectId}/deploymentRule/{deploymentRuleId} | Get a project deployment rule |
ProjectDeploymentRuleAPI | ListProjectDeploymentRules | Get /project/{projectId}/deploymentRule | List project deployment rules |
ProjectDeploymentRuleAPI | UpdateDeploymentRulesPriorityOrder | Put /project/{projectId}/deploymentRule/order | Update deployment rules priority order |
ProjectEnvironmentVariableAPI | CreateProjectEnvironmentVariable | Post /project/{projectId}/environmentVariable | Add an environment variable to the project |
ProjectEnvironmentVariableAPI | CreateProjectEnvironmentVariableAlias | Post /project/{projectId}/environmentVariable/{environmentVariableId}/alias | Create an environment variable alias at the project level |
ProjectEnvironmentVariableAPI | CreateProjectEnvironmentVariableOverride | Post /project/{projectId}/environmentVariable/{environmentVariableId}/override | Create an environment variable override at the project level |
ProjectEnvironmentVariableAPI | DeleteProjectEnvironmentVariable | Delete /project/{projectId}/environmentVariable/{environmentVariableId} | Delete an environment variable from a project |
ProjectEnvironmentVariableAPI | EditProjectEnvironmentVariable | Put /project/{projectId}/environmentVariable/{environmentVariableId} | Edit an environment variable belonging to the project |
ProjectEnvironmentVariableAPI | ListProjectEnvironmentVariable | Get /project/{projectId}/environmentVariable | List project environment variables |
ProjectMainCallsAPI | DeleteProject | Delete /project/{projectId} | Delete a project |
ProjectMainCallsAPI | EditProject | Put /project/{projectId} | Edit a project |
ProjectMainCallsAPI | GetProject | Get /project/{projectId} | Get project by ID |
ProjectSecretAPI | CreateProjectSecret | Post /project/{projectId}/secret | Add a secret to the project |
ProjectSecretAPI | CreateProjectSecretAlias | Post /project/{projectId}/secret/{secretId}/alias | Create a secret alias at the project level |
ProjectSecretAPI | CreateProjectSecretOverride | Post /project/{projectId}/secret/{secretId}/override | Create a secret override at the project level |
ProjectSecretAPI | DeleteProjectSecret | Delete /project/{projectId}/secret/{secretId} | Delete a secret from a project |
ProjectSecretAPI | EditProjectSecret | Put /project/{projectId}/secret/{secretId} | Edit a secret belonging to the project |
ProjectSecretAPI | ListProjectSecrets | Get /project/{projectId}/secret | List project secrets |
ProjectsAPI | CreateProject | Post /organization/{organizationId}/project | Create a project |
ProjectsAPI | GetOrganizationProjectStats | Get /organization/{organizationId}/project/stats | List total number of services and environments for each project of the organization |
ProjectsAPI | ListProject | Get /organization/{organizationId}/project | List projects |
ReferralRewardsAPI | GetAccountReferral | Get /account/referral | Get your referral information |
ReferralRewardsAPI | PostAccountRewardClaim | Post /account/rewardClaim | Claim a reward |
UserSignUpAPI | CreateUserSignUp | Post /admin/userSignUp | Send Sign Up request |
UserSignUpAPI | GetUserSignUp | Get /admin/userSignUp | Get Sign up information |
VariableMainCallsAPI | CreateVariable | Post /variable | Create a variable |
VariableMainCallsAPI | CreateVariableAlias | Post /variable/{variableId}/alias | Create a variable alias |
VariableMainCallsAPI | CreateVariableOverride | Post /variable/{variableId}/override | Create a variable override |
VariableMainCallsAPI | DeleteVariable | Delete /variable/{variableId} | Delete a variable |
VariableMainCallsAPI | EditVariable | Put /variable/{variableId} | Edit a variable |
VariableMainCallsAPI | ImportEnvironmentVariables | Post /variable/import | Import variables |
VariableMainCallsAPI | ListVariables | Get /variable | List variables |
Documentation For Models
- APIVariableScopeEnum
- APIVariableTypeEnum
- AccountInfo
- AccountInfoEditRequest
- Annotation
- AnnotationsGroupAssociatedItemType
- Application
- ApplicationAdvancedSettings
- ApplicationDeploymentRestriction
- ApplicationDeploymentRestrictionRequest
- ApplicationDeploymentRestrictionResponseList
- ApplicationEditRequest
- ApplicationGitRepository
- ApplicationGitRepositoryRequest
- ApplicationNetwork
- ApplicationNetworkRequest
- ApplicationRequest
- ApplicationResponseList
- AvailableContainerRegistryResponse
- AvailableContainerRegistryResponseList
- AvailableHelmRepositoryResponse
- AvailableHelmRepositoryResponseList
- AwsClusterCredentials
- AwsCredentialsRequest
- Backup
- BackupPaginatedResponseList
- BackupRequest
- BackupResponseList
- Base
- BaseJobResponse
- BaseJobResponseAllOfSource
- BaseJobResponseAllOfSourceOneOf
- BaseJobResponseAllOfSourceOneOf1
- BillingExternalId
- BillingInfo
- BillingInfoRequest
- BillingStatus
- Budget
- BuildModeEnum
- BuildPackLanguageEnum
- CancelEnvironmentDeploymentRequest
- CheckedCustomDomainResponse
- CheckedCustomDomainStatus
- CheckedCustomDomainsResponse
- CleanFailedJob200Response
- CleanFailedJobs200Response
- CleanFailedJobsRequest
- CloneEnvironmentRequest
- CloneServiceRequest
- CloudProvider
- CloudProviderEnum
- CloudProviderResponseList
- Cluster
- ClusterAdvancedSettings
- ClusterCloudProviderInfo
- ClusterCloudProviderInfoCredentials
- ClusterCloudProviderInfoRequest
- ClusterCredentials
- ClusterCredentialsResponseList
- ClusterDeleteMode
- ClusterDeploymentStatusEnum
- ClusterFeatureAwsExistingVpc
- ClusterFeatureAwsExistingVpcResponse
- ClusterFeatureBooleanResponse
- ClusterFeatureGcpExistingVpc
- ClusterFeatureGcpExistingVpcResponse
- ClusterFeatureKarpenterParameters
- ClusterFeatureKarpenterParametersResponse
- ClusterFeatureResponse
- ClusterFeatureResponseAcceptedValuesInner
- ClusterFeatureResponseList
- ClusterFeatureResponseTypeEnum
- ClusterFeatureResponseValueObject
- ClusterFeatureStringResponse
- ClusterInstanceTypeResponseList
- ClusterInstanceTypeResponseListResultsInner
- ClusterLogs
- ClusterLogsDetails
- ClusterLogsError
- ClusterLogsErrorEventDetails
- ClusterLogsErrorEventDetailsTransmitter
- ClusterLogsErrorUnderlyingError
- ClusterLogsMessage
- ClusterLogsResponseList
- ClusterReadinessStatus
- ClusterRegion
- ClusterRegionResponseList
- ClusterRequest
- ClusterRequestFeaturesInner
- ClusterRequestFeaturesInnerValue
- ClusterResponseList
- ClusterRoutingTable
- ClusterRoutingTableRequest
- ClusterRoutingTableResultsInner
- ClusterStateEnum
- ClusterStatus
- ClusterStatusGet
- ClusterStatusResponseList
- Commit
- CommitResponseList
- CompanySizeEnum
- ContainerAdvancedSettings
- ContainerDeployRequest
- ContainerImageCheckRequest
- ContainerNetwork
- ContainerNetworkRequest
- ContainerRegistryAssociatedServiceType
- ContainerRegistryAssociatedServicesResponse
- ContainerRegistryAssociatedServicesResponseList
- ContainerRegistryKindEnum
- ContainerRegistryProviderDetailsResponse
- ContainerRegistryRequest
- ContainerRegistryRequestConfig
- ContainerRegistryResponse
- ContainerRegistryResponseAllOfCluster
- ContainerRegistryResponseAllOfConfig
- ContainerRegistryResponseList
- ContainerRequest
- ContainerResponse
- ContainerResponseList
- ContainerSource
- ContainerVersionResponse
- ContainerVersionResponseList
- Cost
- CostRange
- CpuArchitectureEnum
- CreateEnvironmentModeEnum
- CreateEnvironmentRequest
- Credentials
- CredentialsRequest
- CreditCard
- CreditCardRequest
- CreditCardResponseList
- CronJobResponse
- CronJobResponseAllOfSchedule
- CronJobResponseAllOfScheduleCronjob
- CurrentCost
- CustomDomain
- CustomDomainRequest
- CustomDomainResponseList
- CustomDomainStatusEnum
- Database
- DatabaseAccessibilityEnum
- DatabaseConfiguration
- DatabaseConfigurationResponseList
- DatabaseEditRequest
- DatabaseModeEnum
- DatabaseRequest
- DatabaseResponseList
- DatabaseTypeEnum
- DatabaseVersionMode
- DeleteMemberRequest
- DeployAllRequest
- DeployAllRequestApplicationsInner
- DeployAllRequestContainersInner
- DeployAllRequestHelmsInner
- DeployAllRequestJobsInner
- DeployRequest
- DeploymentHistory
- DeploymentHistoryApplication
- DeploymentHistoryContainer
- DeploymentHistoryDatabase
- DeploymentHistoryEnvironment
- DeploymentHistoryEnvironmentPaginatedResponseList
- DeploymentHistoryHelmResponse
- DeploymentHistoryHelmResponseAllOfRepository
- DeploymentHistoryJobResponse
- DeploymentHistoryJobResponseAllOfSchedule
- DeploymentHistoryPaginatedResponseList
- DeploymentHistoryStatusEnum
- DeploymentRestrictionModeEnum
- DeploymentRestrictionTypeEnum
- DeploymentStageRequest
- DeploymentStageResponse
- DeploymentStageResponseList
- DeploymentStageServiceResponse
- DeploymentStageWithServicesStatuses
- DockerfileCheckRequest
- DockerfileCheckResponse
- Environment
- EnvironmentAllOfCloudProvider
- EnvironmentApplicationsSupportedLanguage
- EnvironmentApplicationsSupportedLanguageList
- EnvironmentDeploymentRule
- EnvironmentDeploymentRuleEditRequest
- EnvironmentEditRequest
- EnvironmentLog
- EnvironmentLogResponseList
- EnvironmentLogScope
- EnvironmentLogTypeEnum
- EnvironmentLogs
- EnvironmentLogsDetails
- EnvironmentLogsDetailsStage
- EnvironmentLogsDetailsTransmitter
- EnvironmentLogsError
- EnvironmentLogsErrorUnderlyingError
- EnvironmentLogsMessage
- EnvironmentModeEnum
- EnvironmentResponseList
- EnvironmentServiceIdsAllRequest
- EnvironmentStats
- EnvironmentStatsResponseList
- EnvironmentStatus
- EnvironmentStatusEventOriginEnum
- EnvironmentStatusList
- EnvironmentStatuses
- EnvironmentStatusesWithStages
- EnvironmentTotalNumber
- EnvironmentVariable
- EnvironmentVariableAlias
- EnvironmentVariableEditRequest
- EnvironmentVariableOverride
- EnvironmentVariableRequest
- EnvironmentVariableResponseList
- GcpCredentialsRequest
- GenericClusterCredentials
- GenericObjectCurrentCost
- GetClusterTokenByClusterId200Response
- GetClusterTokenByClusterId200ResponseStatus
- GitAuthProvider
- GitAuthProviderResponseList
- GitFileCheckRequest
- GitProviderEnum
- GitRepository
- GitRepositoryBranch
- GitRepositoryBranchResponseList
- GitRepositoryResponseList
- GitTokenAssociatedServiceResponse
- GitTokenAssociatedServiceType
- GitTokenAssociatedServicesResponseList
- GitTokenRequest
- GitTokenResponse
- GitTokenResponseList
- Healthcheck
- HelmAdvancedSettings
- HelmCheckRequest
- HelmDefaultValuesRequest
- HelmDefaultValuesRequestAllOfSource
- HelmDeployRequest
- HelmDeploymentRestrictionRequest
- HelmDeploymentRestrictionResponse
- HelmDeploymentRestrictionResponseList
- HelmForceEvent
- HelmGitRepositoryRequest
- HelmPortProtocolEnum
- HelmPortRequest
- HelmPortRequestPortsInner
- HelmRepositoryAssociatedServiceType
- HelmRepositoryAssociatedServicesResponse
- HelmRepositoryAssociatedServicesResponseList
- HelmRepositoryKindEnum
- HelmRepositoryRequest
- HelmRepositoryRequestConfig
- HelmRepositoryResponse
- HelmRepositoryResponseAllOfConfig
- HelmRepositoryResponseList
- HelmRequest
- HelmRequestAllOfSource
- HelmRequestAllOfSourceOneOf
- HelmRequestAllOfSourceOneOf1
- HelmRequestAllOfSourceOneOf1HelmRepository
- HelmRequestAllOfValuesOverride
- HelmRequestAllOfValuesOverrideFile
- HelmRequestAllOfValuesOverrideFileGit
- HelmRequestAllOfValuesOverrideFileRaw
- HelmRequestAllOfValuesOverrideFileRawValues
- HelmResponse
- HelmResponseAllOfPorts
- HelmResponseAllOfSource
- HelmResponseAllOfSourceOneOf
- HelmResponseAllOfSourceOneOf1
- HelmResponseAllOfValuesOverride
- HelmResponseAllOfValuesOverrideFile
- HelmResponseAllOfValuesOverrideFileGit
- HelmResponseAllOfValuesOverrideFileRaw
- HelmResponseAllOfValuesOverrideFileRawValues
- HelmResponseList
- HelmSourceGitResponse
- HelmSourceRepositoryResponse
- HelmSourceRepositoryResponseRepository
- HelmVersionResponse
- HelmVersionResponseList
- InviteMember
- InviteMemberRequest
- InviteMemberResponseList
- InviteMemberRoleEnum
- InviteStatusEnum
- Invoice
- InvoiceResponseList
- InvoiceStatusEnum
- JobAdvancedSettings
- JobDeployRequest
- JobDeploymentRestrictionRequest
- JobDeploymentRestrictionResponse
- JobDeploymentRestrictionResponseList
- JobForceEvent
- JobLifecycleTypeEnum
- JobRequest
- JobRequestAllOfSchedule
- JobRequestAllOfScheduleCronjob
- JobRequestAllOfScheduleOnStart
- JobRequestAllOfSource
- JobRequestAllOfSourceDocker
- JobRequestAllOfSourceImage
- JobResponse
- JobResponseList
- JobScheduleEvent
- JobSourceDockerResponse
- Key
- KubernetesEnum
- KubernetesMetadata
- KubernetesSelector
- KubernetesService
- KubernetesServicePort
- KubernetesServiceSpec
- Label
- LabelsGroupAssociatedItemType
- LifecycleJobResponse
- LifecycleJobResponseAllOfSchedule
- LifecycleTemplateListResponse
- LifecycleTemplateListResponseResultsInner
- LifecycleTemplateResponse
- LifecycleTemplateResponseEventsInner
- LifecycleTemplateResponseResources
- LifecycleTemplateResponseVariablesInner
- LifecycleTemplateResponseVariablesInnerFile
- Link
- LinkResponseList
- LinkedServiceTypeEnum
- ListContainerDeploymentHistory200Response
- ListDatabaseDeploymentHistory200Response
- ListHelmDeploymentHistory200Response
- ListJobDeploymentHistory200Response
- ListOrganizationAnnotationsGroup200Response
- ListOrganizationLabelsGroup200Response
- Log
- LogResponseList
- ManagedDatabaseInstanceTypeResponse
- ManagedDatabaseInstanceTypeResponseList
- ManagedDatabaseTypeResponse
- ManagedDatabaseTypeResponseList
- Member
- MemberResponseList
- MemberRoleUpdateRequest
- OnPremiseCredentialsRequest
- Organization
- OrganizationAllOfOrganizationPlan
- OrganizationAnnotationsGroupAssociatedItemsResponseList
- OrganizationAnnotationsGroupAssociatedItemsResponseListResultsInner
- OrganizationAnnotationsGroupCreateRequest
- OrganizationAnnotationsGroupEnrichedResponse
- OrganizationAnnotationsGroupResponse
- OrganizationAnnotationsGroupScopeEnum
- OrganizationApiToken
- OrganizationApiTokenCreate
- OrganizationApiTokenCreateRequest
- OrganizationApiTokenResponseList
- OrganizationApiTokenScope
- OrganizationAvailableRole
- OrganizationAvailableRoleList
- OrganizationBillingUsageReportRequest
- OrganizationBillingUsageReportResponse
- OrganizationChangePlanRequest
- OrganizationContainerAutoDeployRequest
- OrganizationContainerPreviewRequest
- OrganizationCreditCodeRequest
- OrganizationCurrentCost
- OrganizationCustomRole
- OrganizationCustomRoleClusterPermission
- OrganizationCustomRoleClusterPermissionsInner
- OrganizationCustomRoleCreateRequest
- OrganizationCustomRoleList
- OrganizationCustomRoleProjectPermission
- OrganizationCustomRoleProjectPermissionsInner
- OrganizationCustomRoleUpdateRequest
- OrganizationCustomRoleUpdateRequestClusterPermissionsInner
- OrganizationCustomRoleUpdateRequestProjectPermissionsInner
- OrganizationCustomRoleUpdateRequestProjectPermissionsInnerPermissionsInner
- OrganizationEditRequest
- OrganizationEventOrigin
- OrganizationEventResponse
- OrganizationEventResponseList
- OrganizationEventResponseListLinks
- OrganizationEventSubTargetType
- OrganizationEventTargetResponseList
- OrganizationEventTargetType
- OrganizationEventType
- OrganizationGithubAppConnectRequest
- OrganizationJobAutoDeployRequest
- OrganizationLabelsGroupAssociatedItemsResponseList
- OrganizationLabelsGroupAssociatedItemsResponseListResultsInner
- OrganizationLabelsGroupCreateRequest
- OrganizationLabelsGroupEnrichedResponse
- OrganizationLabelsGroupResponse
- OrganizationRequest
- OrganizationResponseList
- OrganizationWebhookCreateRequest
- OrganizationWebhookCreateResponse
- OrganizationWebhookEventEnum
- OrganizationWebhookKindEnum
- OrganizationWebhookResponse
- OrganizationWebhookResponseList
- PaginationData
- PlanEnum
- PortProtocolEnum
- Probe
- ProbeType
- ProbeTypeExec
- ProbeTypeGrpc
- ProbeTypeHttp
- ProbeTypeTcp
- Project
- ProjectCurrentCost
- ProjectCurrentCostResponseList
- ProjectDeploymentRule
- ProjectDeploymentRuleRequest
- ProjectDeploymentRuleResponseList
- ProjectDeploymentRulesPriorityOrderRequest
- ProjectRequest
- ProjectResponseList
- ProjectStats
- ProjectStatsResponseList
- RebootServicesRequest
- ReferenceObject
- ReferenceObjectStatus
- ReferenceObjectStatusResponseList
- Referral
- RegistryMirroringModeEnum
- RewardClaim
- ScalewayClusterCredentials
- ScalewayCredentialsRequest
- Secret
- SecretAlias
- SecretEditRequest
- SecretOverride
- SecretRequest
- SecretResponseList
- Service
- ServiceAnnotationRequest
- ServiceDeploymentStatusEnum
- ServiceLabelRequest
- ServicePort
- ServicePortRequest
- ServicePortRequestPortsInner
- ServiceStepMetric
- ServiceStepMetricNameEnum
- ServiceStepMetrics
- ServiceStorage
- ServiceStorageRequest
- ServiceStorageRequestStorageInner
- ServiceStorageStorageInner
- ServiceTotalNumber
- ServiceTypeEnum
- ServiceTypeForVariableEnum
- SignUp
- SignUpRequest
- Stage
- StageStepMetric
- StageStepMetricNameEnum
- StageStepMetrics
- StateEnum
- Status
- StatusKindEnum
- StepMetricStatusEnum
- StorageTypeEnum
- TransferOwnershipRequest
- TypeOfUseEnum
- User
- UserResponseList
- Value
- VariableAlias
- VariableAliasRequest
- VariableEditRequest
- VariableImport
- VariableImportRequest
- VariableImportRequestVarsInner
- VariableImportSuccessfulImportedVariablesInner
- VariableOverride
- VariableOverrideRequest
- VariableRequest
- VariableResponse
- VariableResponseList
- Version
- VersionResponseList
- WeekdayEnum
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