diff --git a/index.html b/index.html index 12d03ab3..c81e864d 100644 --- a/index.html +++ b/index.html @@ -2214,7 +2214,7 @@ -
Qovery
API docs by Redocly
Qovery
API docs by Redocly
401

Access token is missing or invalid

Response samples

Content type
application/json
{
  • "results": [
    ]
}

List tags

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

-

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Add application tag

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

-
Request Body schema: application/json
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Delete application tag

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

-
tagId
required
string <uuid>

Tag ID

-

Responses

List last commits

Returns list of the last 100 commits made on the repository linked to the application

+

Response samples

Content type
application/json
{
  • "results": [
    ]
}

List last commits

Returns list of the last 100 commits made on the repository linked to the application

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

query Parameters
startId
string <uuid>

Starting point after which to return results

gitCommitId
string <uuid>

Git Commit ID

@@ -3900,13 +3883,13 @@

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Application Actions

Deploy application

You must provide a git commit id

+

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Application Actions

Deploy application

You must provide a git commit id

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

Request Body schema: application/json
git_commit_id
required
string

Commit ID to deploy

Responses

Request samples

Content type
application/json
{
  • "git_commit_id": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "BUILDING",
  • "service_deployment_status": "NEVER_DEPLOYED",
  • "last_deployment_date": "2019-08-24T14:15:22Z",
  • "is_part_last_deployment": true
}

Stop application

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

+

Request samples

Content type
application/json
{
  • "git_commit_id": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "BUILDING",
  • "service_deployment_status": "NEVER_DEPLOYED",
  • "last_deployment_date": "2019-08-24T14:15:22Z",
  • "is_part_last_deployment": true
}

Stop application

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "BUILDING",
  • "service_deployment_status": "NEVER_DEPLOYED",
  • "last_deployment_date": "2019-08-24T14:15:22Z",
  • "is_part_last_deployment": true
}

Deprecated - Restart application

Deprecated - Please use the "Redeploy application" endpoint now

+

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "BUILDING",
  • "service_deployment_status": "NEVER_DEPLOYED",
  • "last_deployment_date": "2019-08-24T14:15:22Z",
  • "is_part_last_deployment": true
}

Deprecated - Restart application

Deprecated - Please use the "Redeploy application" endpoint now

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "BUILDING",
  • "service_deployment_status": "NEVER_DEPLOYED",
  • "last_deployment_date": "2019-08-24T14:15:22Z",
  • "is_part_last_deployment": true
}

Redeploy application

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

+

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "BUILDING",
  • "service_deployment_status": "NEVER_DEPLOYED",
  • "last_deployment_date": "2019-08-24T14:15:22Z",
  • "is_part_last_deployment": true
}

Redeploy application

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "BUILDING",
  • "service_deployment_status": "NEVER_DEPLOYED",
  • "last_deployment_date": "2019-08-24T14:15:22Z",
  • "is_part_last_deployment": true
}

Reboot application

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

+

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "BUILDING",
  • "service_deployment_status": "NEVER_DEPLOYED",
  • "last_deployment_date": "2019-08-24T14:15:22Z",
  • "is_part_last_deployment": true
}

Reboot application

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "BUILDING",
  • "service_deployment_status": "NEVER_DEPLOYED",
  • "last_deployment_date": "2019-08-24T14:15:22Z",
  • "is_part_last_deployment": true
}

Application Configuration

Get Application Network information

Get status of the application network settings.

+

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "BUILDING",
  • "service_deployment_status": "NEVER_DEPLOYED",
  • "last_deployment_date": "2019-08-24T14:15:22Z",
  • "is_part_last_deployment": true
}

Application Configuration

Get Application Network information

Get status of the application network settings.

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

Responses

Response samples

Content type
application/json
{
  • "sticky_session": false
}

Edit Application Network

Edit the Network settings of the application.

+

Response samples

Content type
application/json
{
  • "sticky_session": false
}

Edit Application Network

Edit the Network settings of the application.

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

Request Body schema: application/json
sticky_session
boolean
Default: false

Specify if the sticky session option (also called persistant session) is activated or not for this application. If activated, user will be redirected by the load balancer to the same instance each time he access to the application.

@@ -3955,13 +3938,13 @@

Request samples

Content type
application/json
{
  • "sticky_session": false
}

Response samples

Content type
application/json
{
  • "sticky_session": false
}

Get advanced settings

Get list and values of the advanced settings of the application.

+

Request samples

Content type
application/json
{
  • "sticky_session": false
}

Response samples

Content type
application/json
{
  • "sticky_session": false
}

Get advanced settings

Get list and values of the advanced settings of the application.

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

Responses

Response samples

Content type
application/json
{
  • "deployment.custom_domain_check_enabled": true,
  • "deployment.termination_grace_period_seconds": 60,
  • "deployment.affinity.node.required": {
    },
  • "deployment.antiaffinity.pod": "Preferred",
  • "deployment.update_strategy.type": "RollingUpdate",
  • "deployment.update_strategy.rolling_update.max_unavailable_percent": 25,
  • "deployment.update_strategy.rolling_update.max_surge_percent": 25,
  • "build.timeout_max_sec": 1800,
  • "build.cpu_max_in_milli": 4000,
  • "build.ram_max_in_gib": 8,
  • "network.ingress.proxy_body_size_mb": 100,
  • "network.ingress.enable_cors": false,
  • "network.ingress.cors_allow_origin": "*",
  • "network.ingress.cors_allow_methods": "GET, PUT, POST, DELETE, PATCH, OPTIONS",
  • "network.ingress.cors_allow_headers": "DNT,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range,Authorization",
  • "network.ingress.proxy_buffer_size_kb": 4,
  • "network.ingress.keepalive_time_seconds": 3600,
  • "network.ingress.keepalive_timeout_seconds": 60,
  • "network.ingress.send_timeout_seconds": 60,
  • "network.ingress.proxy_connect_timeout_seconds": 60,
  • "network.ingress.proxy_send_timeout_seconds": 60,
  • "network.ingress.proxy_read_timeout_seconds": 60,
  • "network.ingress.whitelist_source_range": "0.0.0.0/0",
  • "network.ingress.denylist_source_range": "",
  • "network.ingress.basic_auth_env_var": "",
  • "network.ingress.enable_sticky_session": false,
  • "network.ingress.grpc_send_timeout_seconds": 60,
  • "network.ingress.grpc_read_timeout_seconds": 60,
  • "hpa.cpu.average_utilization_percent": 60,
  • "security.service_account_name": ""
}

Edit advanced settings

Edit advanced settings by returning table of advanced settings.

+

Response samples

Content type
application/json
{
  • "deployment.custom_domain_check_enabled": true,
  • "deployment.termination_grace_period_seconds": 60,
  • "deployment.affinity.node.required": {
    },
  • "deployment.antiaffinity.pod": "Preferred",
  • "deployment.update_strategy.type": "RollingUpdate",
  • "deployment.update_strategy.rolling_update.max_unavailable_percent": 25,
  • "deployment.update_strategy.rolling_update.max_surge_percent": 25,
  • "build.timeout_max_sec": 1800,
  • "build.cpu_max_in_milli": 4000,
  • "build.ram_max_in_gib": 8,
  • "network.ingress.proxy_body_size_mb": 100,
  • "network.ingress.enable_cors": false,
  • "network.ingress.cors_allow_origin": "*",
  • "network.ingress.cors_allow_methods": "GET, PUT, POST, DELETE, PATCH, OPTIONS",
  • "network.ingress.cors_allow_headers": "DNT,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range,Authorization",
  • "network.ingress.proxy_buffer_size_kb": 4,
  • "network.ingress.keepalive_time_seconds": 3600,
  • "network.ingress.keepalive_timeout_seconds": 60,
  • "network.ingress.send_timeout_seconds": 60,
  • "network.ingress.proxy_connect_timeout_seconds": 60,
  • "network.ingress.proxy_send_timeout_seconds": 60,
  • "network.ingress.proxy_read_timeout_seconds": 60,
  • "network.ingress.whitelist_source_range": "0.0.0.0/0",
  • "network.ingress.denylist_source_range": "",
  • "network.ingress.basic_auth_env_var": "",
  • "network.ingress.enable_sticky_session": false,
  • "network.ingress.grpc_send_timeout_seconds": 60,
  • "network.ingress.grpc_read_timeout_seconds": 60,
  • "hpa.cpu.average_utilization_percent": 60,
  • "security.service_account_name": ""
}

Edit advanced settings

Edit advanced settings by returning table of advanced settings.

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

Request Body schema: application/json
deployment.custom_domain_check_enabled
boolean
Default: true

disable custom domain check when deploying an application

deployment.termination_grace_period_seconds
integer
Default: 60

define how long in seconds an application is supposed to be stopped gracefully

@@ -4005,12 +3988,12 @@

Request samples

Content type
application/json
{
  • "deployment.custom_domain_check_enabled": true,
  • "deployment.termination_grace_period_seconds": 60,
  • "deployment.affinity.node.required": {
    },
  • "deployment.antiaffinity.pod": "Preferred",
  • "deployment.update_strategy.type": "RollingUpdate",
  • "deployment.update_strategy.rolling_update.max_unavailable_percent": 25,
  • "deployment.update_strategy.rolling_update.max_surge_percent": 25,
  • "build.timeout_max_sec": 1800,
  • "build.cpu_max_in_milli": 4000,
  • "build.ram_max_in_gib": 8,
  • "network.ingress.proxy_body_size_mb": 100,
  • "network.ingress.enable_cors": false,
  • "network.ingress.cors_allow_origin": "*",
  • "network.ingress.cors_allow_methods": "GET, PUT, POST, DELETE, PATCH, OPTIONS",
  • "network.ingress.cors_allow_headers": "DNT,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range,Authorization",
  • "network.ingress.proxy_buffer_size_kb": 4,
  • "network.ingress.keepalive_time_seconds": 3600,
  • "network.ingress.keepalive_timeout_seconds": 60,
  • "network.ingress.send_timeout_seconds": 60,
  • "network.ingress.proxy_connect_timeout_seconds": 60,
  • "network.ingress.proxy_send_timeout_seconds": 60,
  • "network.ingress.proxy_read_timeout_seconds": 60,
  • "network.ingress.whitelist_source_range": "0.0.0.0/0",
  • "network.ingress.denylist_source_range": "",
  • "network.ingress.basic_auth_env_var": "",
  • "network.ingress.enable_sticky_session": false,
  • "network.ingress.grpc_send_timeout_seconds": 60,
  • "network.ingress.grpc_read_timeout_seconds": 60,
  • "hpa.cpu.average_utilization_percent": 60,
  • "security.service_account_name": ""
}

Response samples

Content type
application/json
{
  • "deployment.custom_domain_check_enabled": true,
  • "deployment.termination_grace_period_seconds": 60,
  • "deployment.affinity.node.required": {
    },
  • "deployment.antiaffinity.pod": "Preferred",
  • "deployment.update_strategy.type": "RollingUpdate",
  • "deployment.update_strategy.rolling_update.max_unavailable_percent": 25,
  • "deployment.update_strategy.rolling_update.max_surge_percent": 25,
  • "build.timeout_max_sec": 1800,
  • "build.cpu_max_in_milli": 4000,
  • "build.ram_max_in_gib": 8,
  • "network.ingress.proxy_body_size_mb": 100,
  • "network.ingress.enable_cors": false,
  • "network.ingress.cors_allow_origin": "*",
  • "network.ingress.cors_allow_methods": "GET, PUT, POST, DELETE, PATCH, OPTIONS",
  • "network.ingress.cors_allow_headers": "DNT,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range,Authorization",
  • "network.ingress.proxy_buffer_size_kb": 4,
  • "network.ingress.keepalive_time_seconds": 3600,
  • "network.ingress.keepalive_timeout_seconds": 60,
  • "network.ingress.send_timeout_seconds": 60,
  • "network.ingress.proxy_connect_timeout_seconds": 60,
  • "network.ingress.proxy_send_timeout_seconds": 60,
  • "network.ingress.proxy_read_timeout_seconds": 60,
  • "network.ingress.whitelist_source_range": "0.0.0.0/0",
  • "network.ingress.denylist_source_range": "",
  • "network.ingress.basic_auth_env_var": "",
  • "network.ingress.enable_sticky_session": false,
  • "network.ingress.grpc_send_timeout_seconds": 60,
  • "network.ingress.grpc_read_timeout_seconds": 60,
  • "hpa.cpu.average_utilization_percent": 60,
  • "security.service_account_name": ""
}

Custom Domain

List application custom domains

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

+

Request samples

Content type
application/json
{
  • "deployment.custom_domain_check_enabled": true,
  • "deployment.termination_grace_period_seconds": 60,
  • "deployment.affinity.node.required": {
    },
  • "deployment.antiaffinity.pod": "Preferred",
  • "deployment.update_strategy.type": "RollingUpdate",
  • "deployment.update_strategy.rolling_update.max_unavailable_percent": 25,
  • "deployment.update_strategy.rolling_update.max_surge_percent": 25,
  • "build.timeout_max_sec": 1800,
  • "build.cpu_max_in_milli": 4000,
  • "build.ram_max_in_gib": 8,
  • "network.ingress.proxy_body_size_mb": 100,
  • "network.ingress.enable_cors": false,
  • "network.ingress.cors_allow_origin": "*",
  • "network.ingress.cors_allow_methods": "GET, PUT, POST, DELETE, PATCH, OPTIONS",
  • "network.ingress.cors_allow_headers": "DNT,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range,Authorization",
  • "network.ingress.proxy_buffer_size_kb": 4,
  • "network.ingress.keepalive_time_seconds": 3600,
  • "network.ingress.keepalive_timeout_seconds": 60,
  • "network.ingress.send_timeout_seconds": 60,
  • "network.ingress.proxy_connect_timeout_seconds": 60,
  • "network.ingress.proxy_send_timeout_seconds": 60,
  • "network.ingress.proxy_read_timeout_seconds": 60,
  • "network.ingress.whitelist_source_range": "0.0.0.0/0",
  • "network.ingress.denylist_source_range": "",
  • "network.ingress.basic_auth_env_var": "",
  • "network.ingress.enable_sticky_session": false,
  • "network.ingress.grpc_send_timeout_seconds": 60,
  • "network.ingress.grpc_read_timeout_seconds": 60,
  • "hpa.cpu.average_utilization_percent": 60,
  • "security.service_account_name": ""
}

Response samples

Content type
application/json
{
  • "deployment.custom_domain_check_enabled": true,
  • "deployment.termination_grace_period_seconds": 60,
  • "deployment.affinity.node.required": {
    },
  • "deployment.antiaffinity.pod": "Preferred",
  • "deployment.update_strategy.type": "RollingUpdate",
  • "deployment.update_strategy.rolling_update.max_unavailable_percent": 25,
  • "deployment.update_strategy.rolling_update.max_surge_percent": 25,
  • "build.timeout_max_sec": 1800,
  • "build.cpu_max_in_milli": 4000,
  • "build.ram_max_in_gib": 8,
  • "network.ingress.proxy_body_size_mb": 100,
  • "network.ingress.enable_cors": false,
  • "network.ingress.cors_allow_origin": "*",
  • "network.ingress.cors_allow_methods": "GET, PUT, POST, DELETE, PATCH, OPTIONS",
  • "network.ingress.cors_allow_headers": "DNT,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range,Authorization",
  • "network.ingress.proxy_buffer_size_kb": 4,
  • "network.ingress.keepalive_time_seconds": 3600,
  • "network.ingress.keepalive_timeout_seconds": 60,
  • "network.ingress.send_timeout_seconds": 60,
  • "network.ingress.proxy_connect_timeout_seconds": 60,
  • "network.ingress.proxy_send_timeout_seconds": 60,
  • "network.ingress.proxy_read_timeout_seconds": 60,
  • "network.ingress.whitelist_source_range": "0.0.0.0/0",
  • "network.ingress.denylist_source_range": "",
  • "network.ingress.basic_auth_env_var": "",
  • "network.ingress.enable_sticky_session": false,
  • "network.ingress.grpc_send_timeout_seconds": 60,
  • "network.ingress.grpc_read_timeout_seconds": 60,
  • "hpa.cpu.average_utilization_percent": 60,
  • "security.service_account_name": ""
}

Custom Domain

List application custom domains

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Add custom domain to the application.

Add a custom domain to this application in order not to use qovery autogenerated domain

+

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Add custom domain to the application.

Add a custom domain to this application in order not to use qovery autogenerated domain

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

Request Body schema: application/json
domain
required
string

your custom domain

Responses

Request samples

Content type
application/json
{
  • "domain": "my.domain.tld"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "domain": "my.domain.tld",
  • "validation_domain": "string",
  • "status": "VALIDATION_PENDING"
}

Edit a Custom Domain

To edit a Custom Domain you must have the project user permission

+

Request samples

Content type
application/json
{
  • "domain": "my.domain.tld"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "domain": "my.domain.tld",
  • "validation_domain": "string",
  • "status": "VALIDATION_PENDING"
}

Edit a Custom Domain

To edit a Custom Domain you must have the project user permission

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

customDomainId
required
string <uuid>

Custom Domain ID

Request Body schema: application/json
domain
required
string

your custom domain

@@ -4027,7 +4010,7 @@

Request samples

Content type
application/json
{
  • "domain": "my.domain.tld"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "domain": "my.domain.tld",
  • "validation_domain": "string",
  • "status": "VALIDATION_PENDING"
}

Delete a Custom Domain

To delete an CustomDomain you must have the project user permission

+

Request samples

Content type
application/json
{
  • "domain": "my.domain.tld"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "domain": "my.domain.tld",
  • "validation_domain": "string",
  • "status": "VALIDATION_PENDING"
}

Delete a Custom Domain

To delete an CustomDomain you must have the project user permission

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

customDomainId
required
string <uuid>

Custom Domain ID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "domain": "my.domain.tld",
  • "validation_domain": "string",
  • "status": "VALIDATION_PENDING"
}

Application Metrics

List currently running instances of the application with their CPU and RAM metrics

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

+

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "domain": "my.domain.tld",
  • "validation_domain": "string",
  • "status": "VALIDATION_PENDING"
}

Application Metrics

List currently running instances of the application with their CPU and RAM metrics

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

List current storage disk usage

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

+

Response samples

Content type
application/json
{
  • "results": [
    ]
}

List current storage disk usage

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Get current scaling of the application

Returns min, max, and running number of instances of the application

+

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Get current scaling of the application

Returns min, max, and running number of instances of the application

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

Responses

Response samples

Content type
application/json
{
  • "min": 0,
  • "max": 0,
  • "running": 0,
  • "running_in_percent": 0,
  • "warning_threshold_in_percent": 0,
  • "alert_threshold_in_percent": 0,
  • "status": "Alert",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Get CPU consumption metric over time for the application

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

+

Response samples

Content type
application/json
{
  • "min": 0,
  • "max": 0,
  • "running": 0,
  • "running_in_percent": 0,
  • "warning_threshold_in_percent": 0,
  • "alert_threshold_in_percent": 0,
  • "status": "Alert",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Get CPU consumption metric over time for the application

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

query Parameters
lastSeconds
required
number

Up to how many seconds in the past to ask analytics results

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Get Memory consumption metric over time for the application

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

+

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Get Memory consumption metric over time for the application

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

query Parameters
lastSeconds
required
number

Up to how many seconds in the past to ask analytics results

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Get Health Check latency metric over time for the application

The value returned corresponds to the 95th centile

+

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Get Health Check latency metric over time for the application

The value returned corresponds to the 95th centile

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

query Parameters
lastSeconds
required
number

Up to how many seconds in the past to ask analytics results

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Get Storage consumption metric over time for the application

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

+

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Get Storage consumption metric over time for the application

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

query Parameters
lastSeconds
required
number

Up to how many seconds in the past to ask analytics results

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Application Database

Application Logs

List logs

This will list the last 1000 logs of the application

+

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Application Database

Application Logs

List logs

This will list the last 1000 logs of the application

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Application Deployment Restriction

Get application deployment restrictions

Get application deployment restrictions

+

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Application Deployment Restriction

Get application deployment restrictions

Get application deployment restrictions

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Create an application deployment restriction

Create an application deployment restriction

+

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Create an application deployment restriction

Create an application deployment restriction

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

Request Body schema: application/json
mode
required
string (DeploymentRestrictionModeEnum)
Enum: "EXCLUDE" "MATCH"

Match mode will rebuild app only if specified items are updated. Exclude mode will not rebuild app if specified items are updated.

type
required
string (DeploymentRestrictionTypeEnum)
Value: "PATH"
value
required
string

For PATH restrictions, the value must not start with /

@@ -4102,7 +4085,7 @@

Request samples

Content type
application/json
{
  • "mode": "MATCH",
  • "type": "PATH",
  • "value": "application1/src/"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "mode": "MATCH",
  • "type": "PATH",
  • "value": "application1/src/"
}

Edit an application deployment restriction

Edit an application deployment restriction

+

Request samples

Content type
application/json
{
  • "mode": "MATCH",
  • "type": "PATH",
  • "value": "application1/src/"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "mode": "MATCH",
  • "type": "PATH",
  • "value": "application1/src/"
}

Edit an application deployment restriction

Edit an application deployment restriction

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

deploymentRestrictionId
required
string <uuid>

Deployment Restriction ID

Request Body schema: application/json
mode
required
string (DeploymentRestrictionModeEnum)
Enum: "EXCLUDE" "MATCH"

Match mode will rebuild app only if specified items are updated. Exclude mode will not rebuild app if specified items are updated.

@@ -4112,7 +4095,7 @@

Request samples

Content type
application/json
{
  • "mode": "MATCH",
  • "type": "PATH",
  • "value": "application1/src/"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "mode": "MATCH",
  • "type": "PATH",
  • "value": "application1/src/"
}

Delete an application deployment restriction

Delete an application deployment restriction

+

Request samples

Content type
application/json
{
  • "mode": "MATCH",
  • "type": "PATH",
  • "value": "application1/src/"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "mode": "MATCH",
  • "type": "PATH",
  • "value": "application1/src/"
}

Delete an application deployment restriction

Delete an application deployment restriction

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

deploymentRestrictionId
required
string <uuid>

Deployment Restriction ID

Responses

Response samples

Content type
application/json
{
  • "page": 1,
  • "page_size": 20,
  • "results": [
    ]
}

Application Environment Variable

List environment variables

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

+

Response samples

Content type
application/json
{
  • "page": 1,
  • "page_size": 20,
  • "results": [
    ]
}

Application Environment Variable

List environment variables

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Add an environment variable to the application

    +

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Add an environment variable to the application

  • Add an environment variable to the application.
Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

@@ -4143,14 +4126,14 @@

Request samples

Content type
application/json
{
  • "key": "string",
  • "value": "string",
  • "mount_path": null
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "value": "string",
  • "mount_path": null,
  • "overridden_variable": {
    },
  • "aliased_variable": {
    },
  • "scope": "APPLICATION",
  • "variable_type": "VALUE",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION",
  • "owned_by": "string"
}

Import variables

Import environment variables in a defined scope, with a defined visibility.

+

Request samples

Content type
application/json
{
  • "key": "string",
  • "value": "string",
  • "mount_path": null
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "value": "string",
  • "mount_path": null,
  • "overridden_variable": {
    },
  • "aliased_variable": {
    },
  • "scope": "APPLICATION",
  • "variable_type": "VALUE",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION",
  • "owned_by": "string"
}

Import variables

Import environment variables in a defined scope, with a defined visibility.

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

Request Body schema: application/json
overwrite
required
boolean
Default: false
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "overwrite": false,
  • "vars": [
    ]
}

Response samples

Content type
application/json
{
  • "total_variables_to_import": 0,
  • "successful_imported_variables": [
    ]
}

Delete an environment variable from an application

    +

Request samples

Content type
application/json
{
  • "overwrite": false,
  • "vars": [
    ]
}

Response samples

Content type
application/json
{
  • "total_variables_to_import": 0,
  • "successful_imported_variables": [
    ]
}

Delete an environment variable from an application

  • To delete an environment variable from an application you must have the project user permission
  • You can't delete a BUILT_IN variable
  • If you delete a variable having override or alias, the associated override/alias will be deleted as well
    • @@ -4176,7 +4159,7 @@

Request samples

Content type
application/json
{
  • "key": "string",
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "value": "string",
  • "mount_path": null,
  • "overridden_variable": {
    },
  • "aliased_variable": {
    },
  • "scope": "APPLICATION",
  • "variable_type": "VALUE",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION",
  • "owned_by": "string"
}

Create an environment variable override at the application level

    +

Request samples

Content type
application/json
{
  • "key": "string",
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "value": "string",
  • "mount_path": null,
  • "overridden_variable": {
    },
  • "aliased_variable": {
    },
  • "scope": "APPLICATION",
  • "variable_type": "VALUE",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION",
  • "owned_by": "string"
}

Create an environment variable override at the application level

  • Allows you to override at application level an environment variable that has a higher scope.
  • You only have to specify a value in the request body
  • The system will create a new environment variable at application level with the same key as the one corresponding to the variable id in the path
    • @@ -4190,7 +4173,7 @@

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "value": "string",
  • "mount_path": null,
  • "overridden_variable": {
    },
  • "aliased_variable": {
    },
  • "scope": "APPLICATION",
  • "variable_type": "VALUE",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION",
  • "owned_by": "string"
}

Create an environment variable alias at the application level

    +

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "value": "string",
  • "mount_path": null,
  • "overridden_variable": {
    },
  • "aliased_variable": {
    },
  • "scope": "APPLICATION",
  • "variable_type": "VALUE",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION",
  • "owned_by": "string"
}

Create an environment variable alias at the application level

  • Allows you to add an alias at application level on an existing environment variable having higher scope, in order to customize its key.
  • You only have to specify a key in the request body
  • The system will create a new environment variable at application level with the same value as the one corresponding to the variable id in the path
    • @@ -4205,13 +4188,13 @@

Request samples

Content type
application/json
{
  • "key": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "value": "string",
  • "mount_path": null,
  • "overridden_variable": {
    },
  • "aliased_variable": {
    },
  • "scope": "APPLICATION",
  • "variable_type": "VALUE",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION",
  • "owned_by": "string"
}

Application Secret

List application secrets

Secrets are like environment variables, but they are secured and can't be revealed.

+

Request samples

Content type
application/json
{
  • "key": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "value": "string",
  • "mount_path": null,
  • "overridden_variable": {
    },
  • "aliased_variable": {
    },
  • "scope": "APPLICATION",
  • "variable_type": "VALUE",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION",
  • "owned_by": "string"
}

Application Secret

List application secrets

Secrets are like environment variables, but they are secured and can't be revealed.

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Add a secret to the application

    +

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Add a secret to the application

  • Add a secret to the application.
Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

@@ -4223,7 +4206,7 @@

Request samples

Content type
application/json
{
  • "key": "string",
  • "value": "string",
  • "mount_path": null
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "overridden_secret": {
    },
  • "aliased_secret": {
    },
  • "scope": "APPLICATION",
  • "variable_type": "VALUE",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION",
  • "owned_by": "string"
}

Delete a secret from an application

    +

Request samples

Content type
application/json
{
  • "key": "string",
  • "value": "string",
  • "mount_path": null
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "overridden_secret": {
    },
  • "aliased_secret": {
    },
  • "scope": "APPLICATION",
  • "variable_type": "VALUE",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION",
  • "owned_by": "string"
}

Delete a secret from an application

  • To delete a secret you must have the project user permission
  • You can't delete a BUILT_IN secret
  • If you delete a secret having override or alias, the associated override/alias will be deleted as well
    • @@ -4247,7 +4230,7 @@

Request samples

Content type
application/json
{
  • "value": "string",
  • "key": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "overridden_secret": {
    },
  • "aliased_secret": {
    },
  • "scope": "APPLICATION",
  • "variable_type": "VALUE",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION",
  • "owned_by": "string"
}

Create a secret override at the application level

    +

Request samples

Content type
application/json
{
  • "value": "string",
  • "key": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "overridden_secret": {
    },
  • "aliased_secret": {
    },
  • "scope": "APPLICATION",
  • "variable_type": "VALUE",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION",
  • "owned_by": "string"
}

Create a secret override at the application level

  • Allows you to override at application level a secret that has a higher scope.
  • You only have to specify a value in the request body
  • The system will create a new secret at application level with the same key as the one corresponding to the secret id in the path
    • @@ -4261,7 +4244,7 @@

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "overridden_secret": {
    },
  • "aliased_secret": {
    },
  • "scope": "APPLICATION",
  • "variable_type": "VALUE",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION",
  • "owned_by": "string"
}

Create a secret alias at the application level

    +

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "overridden_secret": {
    },
  • "aliased_secret": {
    },
  • "scope": "APPLICATION",
  • "variable_type": "VALUE",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION",
  • "owned_by": "string"
}

Create a secret alias at the application level

  • Allows you to add an alias at application level on an existing secret having higher scope, in order to customize its key.
  • You only have to specify a key in the request body
  • The system will create a new secret at application level with the same value as the one corresponding to the secret id in the path
    • @@ -4276,19 +4259,19 @@

Request samples

Content type
application/json
{
  • "key": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "overridden_secret": {
    },
  • "aliased_secret": {
    },
  • "scope": "APPLICATION",
  • "variable_type": "VALUE",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION",
  • "owned_by": "string"
}

Application Event

List application events

By default it returns the 20 last results. The response is paginated. In order to request the next page, you can use the startId query parameter

+

Request samples

Content type
application/json
{
  • "key": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "overridden_secret": {
    },
  • "aliased_secret": {
    },
  • "scope": "APPLICATION",
  • "variable_type": "VALUE",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION",
  • "owned_by": "string"
}

Application Event

List application events

By default it returns the 20 last results. The response is paginated. In order to request the next page, you can use the startId query parameter

Authorizations:
bearerAuth
path Parameters
applicationId
required
string <uuid>

Application ID

query Parameters
startId
string <uuid>

Starting point after which to return results

Responses

Response samples

Content type
application/json
{
  • "page": 1,
  • "page_size": 20,
  • "results": [
    ]
}

Container Main Calls

Get container by ID

Authorizations:
bearerAuth
path Parameters
containerId
required
string <uuid>

Container ID

+

Response samples

Content type
application/json
{
  • "page": 1,
  • "page_size": 20,
  • "results": [
    ]
}

Container Main Calls

Get container by ID

Authorizations:
bearerAuth
path Parameters
containerId
required
string <uuid>

Container ID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "storage": [
    ],
  • "environment": {
    },
  • "registry": {
    },
  • "maximum_cpu": 16000,
  • "maximum_memory": 16384,
  • "name": "string",
  • "description": "string",
  • "image_name": "string",
  • "tag": "string",
  • "arguments": [
    ],
  • "entrypoint": "string",
  • "cpu": 1250,
  • "memory": 1024,
  • "min_running_instances": 1,
  • "max_running_instances": 1,
  • "healthchecks": {
    },
  • "auto_preview": true,
  • "ports": [
    ]
}

Edit container

    +

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "storage": [
    ],
  • "environment": {
    },
  • "registry": {
    },
  • "maximum_cpu": 16000,
  • "maximum_memory": 16384,
  • "name": "string",
  • "description": "string",
  • "image_name": "string",
  • "tag": "string",
  • "arguments": [
    ],
  • "entrypoint": "string",
  • "cpu": 1250,
  • "memory": 1024,
  • "min_running_instances": 1,
  • "max_running_instances": 1,
  • "healthchecks": {
    },
  • "auto_preview": true,
  • "ports": [
    ]
}

Edit container

  • To edit the container you must have the admin permission.
  • For port edition, if you provide a port id, we will update the corresponding port. If you don't we will create a new one. If you remove a port from the payload, we will delete it.
  • For storage edition, if you provide a storage id, we will update the corresponding storage. If you don't we will create a new one. If you remove a storage from the payload, we will delete it.
    • @@ -4319,7 +4302,7 @@

Request samples

Content type
application/json
{
  • "storage": [
    ],
  • "ports": [
    ],
  • "name": "string",
  • "description": "string",
  • "registry_id": "string",
  • "image_name": "string",
  • "tag": "string",
  • "arguments": [
    ],
  • "entrypoint": "string",
  • "cpu": 1250,
  • "memory": 1024,
  • "min_running_instances": 1,
  • "max_running_instances": 1,
  • "healthchecks": {
    },
  • "auto_preview": true
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "storage": [
    ],
  • "environment": {
    },
  • "registry": {
    },
  • "maximum_cpu": 16000,
  • "maximum_memory": 16384,
  • "name": "string",
  • "description": "string",
  • "image_name": "string",
  • "tag": "string",
  • "arguments": [
    ],
  • "entrypoint": "string",
  • "cpu": 1250,
  • "memory": 1024,
  • "min_running_instances": 1,
  • "max_running_instances": 1,
  • "healthchecks": {
    },
  • "auto_preview": true,
  • "ports": [
    ]
}

Delete container

To delete the container you must have the admin permission

+

Request samples

Content type
application/json
{
  • "storage": [
    ],
  • "ports": [
    ],
  • "name": "string",
  • "description": "string",
  • "registry_id": "string",
  • "image_name": "string",
  • "tag": "string",
  • "arguments": [
    ],
  • "entrypoint": "string",
  • "cpu": 1250,
  • "memory": 1024,
  • "min_running_instances": 1,
  • "max_running_instances": 1,
  • "healthchecks": {
    },
  • "auto_preview": true
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "storage": [
    ],
  • "environment": {
    },
  • "registry": {
    },
  • "maximum_cpu": 16000,
  • "maximum_memory": 16384,
  • "name": "string",
  • "description": "string",
  • "image_name": "string",
  • "tag": "string",
  • "arguments": [
    ],
  • "entrypoint": "string",
  • "cpu": 1250,
  • "memory": 1024,
  • "min_running_instances": 1,
  • "max_running_instances": 1,
  • "healthchecks": {
    },
  • "auto_preview": true,
  • "ports": [
    ]
}

Delete container

To delete the container you must have the admin permission

Authorizations:
bearerAuth
path Parameters
containerId
required
string <uuid>

Container ID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "BUILDING",
  • "service_deployment_status": "NEVER_DEPLOYED",
  • "last_deployment_date": "2019-08-24T14:15:22Z",
  • "is_part_last_deployment": true
}

Container Actions

Deploy container

You must provide a git commit id

+

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Container Actions

Deploy container

You must provide a git commit id

Authorizations:
bearerAuth
path Parameters
containerId
required
string <uuid>

Container ID

Request Body schema: application/json
image_tag
required
string

Image tag to deploy

Responses

Request samples

Content type
application/json
{
  • "image_tag": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "BUILDING",
  • "service_deployment_status": "NEVER_DEPLOYED",
  • "last_deployment_date": "2019-08-24T14:15:22Z",
  • "is_part_last_deployment": true
}

Stop container

Authorizations:
bearerAuth
path Parameters
containerId
required
string <uuid>

Container ID

+

Request samples

Content type
application/json
{
  • "image_tag": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "BUILDING",
  • "service_deployment_status": "NEVER_DEPLOYED",
  • "last_deployment_date": "2019-08-24T14:15:22Z",
  • "is_part_last_deployment": true
}

Stop container

Authorizations:
bearerAuth
path Parameters
containerId
required
string <uuid>

Container ID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "BUILDING",
  • "service_deployment_status": "NEVER_DEPLOYED",
  • "last_deployment_date": "2019-08-24T14:15:22Z",
  • "is_part_last_deployment": true
}

Deprecated - Restart container

Deprecated - Please use the "Redeploy container" endpoint now

+

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "BUILDING",
  • "service_deployment_status": "NEVER_DEPLOYED",
  • "last_deployment_date": "2019-08-24T14:15:22Z",
  • "is_part_last_deployment": true
}

Deprecated - Restart container

Deprecated - Please use the "Redeploy container" endpoint now

Authorizations:
bearerAuth
path Parameters
containerId
required
string <uuid>

Container ID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "BUILDING",
  • "service_deployment_status": "NEVER_DEPLOYED",
  • "last_deployment_date": "2019-08-24T14:15:22Z",
  • "is_part_last_deployment": true
}

Redeploy container

Authorizations:
bearerAuth
path Parameters
containerId
required
string <uuid>

Container ID

+

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "BUILDING",
  • "service_deployment_status": "NEVER_DEPLOYED",
  • "last_deployment_date": "2019-08-24T14:15:22Z",
  • "is_part_last_deployment": true
}

Redeploy container

Authorizations:
bearerAuth
path Parameters
containerId
required
string <uuid>

Container ID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "BUILDING",
  • "service_deployment_status": "NEVER_DEPLOYED",
  • "last_deployment_date": "2019-08-24T14:15:22Z",
  • "is_part_last_deployment": true
}

Reboot container

Authorizations:
bearerAuth
path Parameters
containerId
required
string <uuid>

Container ID

+

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "BUILDING",
  • "service_deployment_status": "NEVER_DEPLOYED",
  • "last_deployment_date": "2019-08-24T14:15:22Z",
  • "is_part_last_deployment": true
}

Reboot container

Authorizations:
bearerAuth
path Parameters
containerId
required
string <uuid>

Container ID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "BUILDING",
  • "service_deployment_status": "NEVER_DEPLOYED",
  • "last_deployment_date": "2019-08-24T14:15:22Z",
  • "is_part_last_deployment": true
}

Container Configuration

Get advanced settings

Get list and values of the advanced settings of the container.

+

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "BUILDING",
  • "service_deployment_status": "NEVER_DEPLOYED",
  • "last_deployment_date": "2019-08-24T14:15:22Z",
  • "is_part_last_deployment": true
}

Container Configuration

Get advanced settings

Get list and values of the advanced settings of the container.

Authorizations:
bearerAuth
path Parameters
containerId
required
string <uuid>

Container ID

Responses

Response samples

Content type
application/json
{
  • "deployment.custom_domain_check_enabled": true,
  • "deployment.termination_grace_period_seconds": 60,
  • "deployment.affinity.node.required": {
    },
  • "deployment.antiaffinity.pod": "Preferred",
  • "deployment.update_strategy.type": "RollingUpdate",
  • "deployment.update_strategy.rolling_update.max_unavailable_percent": 25,
  • "deployment.update_strategy.rolling_update.max_surge_percent": 25,
  • "network.ingress.proxy_body_size_mb": 100,
  • "network.ingress.enable_cors": false,
  • "network.ingress.cors_allow_origin": "*",
  • "network.ingress.cors_allow_methods": "GET, PUT, POST, DELETE, PATCH, OPTIONS",
  • "network.ingress.cors_allow_headers": "DNT,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range,Authorization",
  • "network.ingress.proxy_buffer_size_kb": 4,
  • "network.ingress.keepalive_time_seconds": 3600,
  • "network.ingress.keepalive_timeout_seconds": 60,
  • "network.ingress.send_timeout_seconds": 60,
  • "network.ingress.proxy_connect_timeout_seconds": 60,
  • "network.ingress.proxy_send_timeout_seconds": 60,
  • "network.ingress.proxy_read_timeout_seconds": 60,
  • "network.ingress.grpc_send_timeout_seconds": 60,
  • "network.ingress.grpc_read_timeout_seconds": 60,
  • "network.ingress.whitelist_source_range": "0.0.0.0/0",
  • "network.ingress.denylist_source_range": "",
  • "network.ingress.basic_auth_env_var": "",
  • "network.ingress.enable_sticky_session": false,
  • "security.service_account_name": "",
  • "hpa.cpu.average_utilization_percent": 60
}

Edit advanced settings

Edit advanced settings by returning table of advanced settings.

+

Response samples

Content type
application/json
{
  • "deployment.custom_domain_check_enabled": true,
  • "deployment.termination_grace_period_seconds": 60,
  • "deployment.affinity.node.required": {
    },
  • "deployment.antiaffinity.pod": "Preferred",
  • "deployment.update_strategy.type": "RollingUpdate",
  • "deployment.update_strategy.rolling_update.max_unavailable_percent": 25,
  • "deployment.update_strategy.rolling_update.max_surge_percent": 25,
  • "network.ingress.proxy_body_size_mb": 100,
  • "network.ingress.enable_cors": false,
  • "network.ingress.cors_allow_origin": "*",
  • "network.ingress.cors_allow_methods": "GET, PUT, POST, DELETE, PATCH, OPTIONS",
  • "network.ingress.cors_allow_headers": "DNT,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range,Authorization",
  • "network.ingress.proxy_buffer_size_kb": 4,
  • "network.ingress.keepalive_time_seconds": 3600,
  • "network.ingress.keepalive_timeout_seconds": 60,
  • "network.ingress.send_timeout_seconds": 60,
  • "network.ingress.proxy_connect_timeout_seconds": 60,
  • "network.ingress.proxy_send_timeout_seconds": 60,
  • "network.ingress.proxy_read_timeout_seconds": 60,
  • "network.ingress.grpc_send_timeout_seconds": 60,
  • "network.ingress.grpc_read_timeout_seconds": 60,
  • "network.ingress.whitelist_source_range": "0.0.0.0/0",
  • "network.ingress.denylist_source_range": "",
  • "network.ingress.basic_auth_env_var": "",
  • "network.ingress.enable_sticky_session": false,
  • "security.service_account_name": "",
  • "hpa.cpu.average_utilization_percent": 60
}

Edit advanced settings

Edit advanced settings by returning table of advanced settings.

Authorizations:
bearerAuth
path Parameters
containerId
required
string <uuid>

Container ID

Request Body schema: application/json
deployment.custom_domain_check_enabled
boolean
Default: true

disable custom domain check when deploying an application

deployment.termination_grace_period_seconds
integer
Default: 60

define how long in seconds an application is supposed to be stopped gracefully

@@ -4418,13 +4401,13 @@

Request samples

Content type
application/json
{
  • "deployment.custom_domain_check_enabled": true,
  • "deployment.termination_grace_period_seconds": 60,
  • "deployment.affinity.node.required": {
    },
  • "deployment.antiaffinity.pod": "Preferred",
  • "deployment.update_strategy.type": "RollingUpdate",
  • "deployment.update_strategy.rolling_update.max_unavailable_percent": 25,
  • "deployment.update_strategy.rolling_update.max_surge_percent": 25,
  • "network.ingress.proxy_body_size_mb": 100,
  • "network.ingress.enable_cors": false,
  • "network.ingress.cors_allow_origin": "*",
  • "network.ingress.cors_allow_methods": "GET, PUT, POST, DELETE, PATCH, OPTIONS",
  • "network.ingress.cors_allow_headers": "DNT,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range,Authorization",
  • "network.ingress.proxy_buffer_size_kb": 4,
  • "network.ingress.keepalive_time_seconds": 3600,
  • "network.ingress.keepalive_timeout_seconds": 60,
  • "network.ingress.send_timeout_seconds": 60,
  • "network.ingress.proxy_connect_timeout_seconds": 60,
  • "network.ingress.proxy_send_timeout_seconds": 60,
  • "network.ingress.proxy_read_timeout_seconds": 60,
  • "network.ingress.grpc_send_timeout_seconds": 60,
  • "network.ingress.grpc_read_timeout_seconds": 60,
  • "network.ingress.whitelist_source_range": "0.0.0.0/0",
  • "network.ingress.denylist_source_range": "",
  • "network.ingress.basic_auth_env_var": "",
  • "network.ingress.enable_sticky_session": false,
  • "security.service_account_name": "",
  • "hpa.cpu.average_utilization_percent": 60
}

Response samples

Content type
application/json
{
  • "deployment.custom_domain_check_enabled": true,
  • "deployment.termination_grace_period_seconds": 60,
  • "deployment.affinity.node.required": {
    },
  • "deployment.antiaffinity.pod": "Preferred",
  • "deployment.update_strategy.type": "RollingUpdate",
  • "deployment.update_strategy.rolling_update.max_unavailable_percent": 25,
  • "deployment.update_strategy.rolling_update.max_surge_percent": 25,
  • "network.ingress.proxy_body_size_mb": 100,
  • "network.ingress.enable_cors": false,
  • "network.ingress.cors_allow_origin": "*",
  • "network.ingress.cors_allow_methods": "GET, PUT, POST, DELETE, PATCH, OPTIONS",
  • "network.ingress.cors_allow_headers": "DNT,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range,Authorization",
  • "network.ingress.proxy_buffer_size_kb": 4,
  • "network.ingress.keepalive_time_seconds": 3600,
  • "network.ingress.keepalive_timeout_seconds": 60,
  • "network.ingress.send_timeout_seconds": 60,
  • "network.ingress.proxy_connect_timeout_seconds": 60,
  • "network.ingress.proxy_send_timeout_seconds": 60,
  • "network.ingress.proxy_read_timeout_seconds": 60,
  • "network.ingress.grpc_send_timeout_seconds": 60,
  • "network.ingress.grpc_read_timeout_seconds": 60,
  • "network.ingress.whitelist_source_range": "0.0.0.0/0",
  • "network.ingress.denylist_source_range": "",
  • "network.ingress.basic_auth_env_var": "",
  • "network.ingress.enable_sticky_session": false,
  • "security.service_account_name": "",
  • "hpa.cpu.average_utilization_percent": 60
}

Get Container Network information

Get status of the container network settings.

+

Request samples

Content type
application/json
{
  • "deployment.custom_domain_check_enabled": true,
  • "deployment.termination_grace_period_seconds": 60,
  • "deployment.affinity.node.required": {
    },
  • "deployment.antiaffinity.pod": "Preferred",
  • "deployment.update_strategy.type": "RollingUpdate",
  • "deployment.update_strategy.rolling_update.max_unavailable_percent": 25,
  • "deployment.update_strategy.rolling_update.max_surge_percent": 25,
  • "network.ingress.proxy_body_size_mb": 100,
  • "network.ingress.enable_cors": false,
  • "network.ingress.cors_allow_origin": "*",
  • "network.ingress.cors_allow_methods": "GET, PUT, POST, DELETE, PATCH, OPTIONS",
  • "network.ingress.cors_allow_headers": "DNT,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range,Authorization",
  • "network.ingress.proxy_buffer_size_kb": 4,
  • "network.ingress.keepalive_time_seconds": 3600,
  • "network.ingress.keepalive_timeout_seconds": 60,
  • "network.ingress.send_timeout_seconds": 60,
  • "network.ingress.proxy_connect_timeout_seconds": 60,
  • "network.ingress.proxy_send_timeout_seconds": 60,
  • "network.ingress.proxy_read_timeout_seconds": 60,
  • "network.ingress.grpc_send_timeout_seconds": 60,
  • "network.ingress.grpc_read_timeout_seconds": 60,
  • "network.ingress.whitelist_source_range": "0.0.0.0/0",
  • "network.ingress.denylist_source_range": "",
  • "network.ingress.basic_auth_env_var": "",
  • "network.ingress.enable_sticky_session": false,
  • "security.service_account_name": "",
  • "hpa.cpu.average_utilization_percent": 60
}

Response samples

Content type
application/json
{
  • "deployment.custom_domain_check_enabled": true,
  • "deployment.termination_grace_period_seconds": 60,
  • "deployment.affinity.node.required": {
    },
  • "deployment.antiaffinity.pod": "Preferred",
  • "deployment.update_strategy.type": "RollingUpdate",
  • "deployment.update_strategy.rolling_update.max_unavailable_percent": 25,
  • "deployment.update_strategy.rolling_update.max_surge_percent": 25,
  • "network.ingress.proxy_body_size_mb": 100,
  • "network.ingress.enable_cors": false,
  • "network.ingress.cors_allow_origin": "*",
  • "network.ingress.cors_allow_methods": "GET, PUT, POST, DELETE, PATCH, OPTIONS",
  • "network.ingress.cors_allow_headers": "DNT,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range,Authorization",
  • "network.ingress.proxy_buffer_size_kb": 4,
  • "network.ingress.keepalive_time_seconds": 3600,
  • "network.ingress.keepalive_timeout_seconds": 60,
  • "network.ingress.send_timeout_seconds": 60,
  • "network.ingress.proxy_connect_timeout_seconds": 60,
  • "network.ingress.proxy_send_timeout_seconds": 60,
  • "network.ingress.proxy_read_timeout_seconds": 60,
  • "network.ingress.grpc_send_timeout_seconds": 60,
  • "network.ingress.grpc_read_timeout_seconds": 60,
  • "network.ingress.whitelist_source_range": "0.0.0.0/0",
  • "network.ingress.denylist_source_range": "",
  • "network.ingress.basic_auth_env_var": "",
  • "network.ingress.enable_sticky_session": false,
  • "security.service_account_name": "",
  • "hpa.cpu.average_utilization_percent": 60
}

Get Container Network information

Get status of the container network settings.

Authorizations:
bearerAuth
path Parameters
containerId
required
string <uuid>

Container ID

Responses

Response samples

Content type
application/json
{
  • "sticky_session": false
}

Edit Container Network

Edit the Network settings of the container.

+

Response samples

Content type
application/json
{
  • "sticky_session": false
}

Edit Container Network

Edit the Network settings of the container.

Authorizations:
bearerAuth
path Parameters
containerId
required
string <uuid>

Container ID

Request Body schema: application/json
sticky_session
boolean
Default: false

Specify if the sticky session option (also called persistant session) is activated or not for this container. If activated, user will be redirected by the load balancer to the same instance each time he access to the container.

@@ -4433,12 +4416,12 @@

Request samples

Content type
application/json
{
  • "sticky_session": false
}

Response samples

Content type
application/json
{
  • "sticky_session": false
}

Container Custom Domain

List container custom domains

Authorizations:
bearerAuth
path Parameters
containerId
required
string <uuid>

Container ID

+

Request samples

Content type
application/json
{
  • "sticky_session": false
}

Response samples

Content type
application/json
{
  • "sticky_session": false
}

Container Custom Domain

List container custom domains

Authorizations:
bearerAuth
path Parameters
containerId
required
string <uuid>

Container ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Add custom domain to the container.

Add a custom domain to this container in order not to use qovery autogenerated domain

+

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Add custom domain to the container.

Add a custom domain to this container in order not to use qovery autogenerated domain

Authorizations:
bearerAuth
path Parameters
containerId
required
string <uuid>

Container ID

Request Body schema: application/json
domain
required
string

your custom domain

Responses

Request samples

Content type
application/json
{
  • "domain": "my.domain.tld"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "domain": "my.domain.tld",
  • "validation_domain": "string",
  • "status": "VALIDATION_PENDING"
}

Edit a Custom Domain

To edit a Custom Domain you must have the project user permission

+

Request samples

Content type
application/json
{
  • "domain": "my.domain.tld"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "domain": "my.domain.tld",
  • "validation_domain": "string",
  • "status": "VALIDATION_PENDING"
}

Edit a Custom Domain

To edit a Custom Domain you must have the project user permission

Authorizations:
bearerAuth
path Parameters
containerId
required
string <uuid>

Container ID

customDomainId
required
string <uuid>

Custom Domain ID

Request Body schema: application/json
domain
required
string

your custom domain

@@ -4455,7 +4438,7 @@

Request samples

Content type
application/json
{
  • "domain": "my.domain.tld"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "domain": "my.domain.tld",
  • "validation_domain": "string",
  • "status": "VALIDATION_PENDING"
}

Delete a Custom Domain

To delete an CustomDomain you must have the project user permission

+

Request samples

Content type
application/json
{
  • "domain": "my.domain.tld"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "domain": "my.domain.tld",
  • "validation_domain": "string",
  • "status": "VALIDATION_PENDING"
}

Delete a Custom Domain

To delete an CustomDomain you must have the project user permission

Authorizations:
bearerAuth
path Parameters
containerId
required
string <uuid>

Container ID

customDomainId
required
string <uuid>

Custom Domain ID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "domain": "my.domain.tld",
  • "validation_domain": "string",
  • "status": "VALIDATION_PENDING"
}

Container Metrics

List currently running instances of the container with their CPU and RAM metrics

Authorizations:
bearerAuth
path Parameters
containerId
required
string <uuid>

Container ID

+

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "domain": "my.domain.tld",
  • "validation_domain": "string",
  • "status": "VALIDATION_PENDING"
}

Container Metrics

List currently running instances of the container with their CPU and RAM metrics

Authorizations:
bearerAuth
path Parameters
containerId
required
string <uuid>

Container ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

List current storage disk usage

Authorizations:
bearerAuth
path Parameters
containerId
required
string <uuid>

Container ID

+

Response samples

Content type
application/json
{
  • "results": [
    ]
}

List current storage disk usage

Authorizations:
bearerAuth
path Parameters
containerId
required
string <uuid>

Container ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Get current scaling of the container

Returns min, max, and running number of instances of the application

+

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Get current scaling of the container

Returns min, max, and running number of instances of the application

Authorizations:
bearerAuth
path Parameters
containerId
required
string <uuid>

Container ID

Responses

Response samples

Content type
application/json
{
  • "min": 0,
  • "max": 0,
  • "running": 0,
  • "running_in_percent": 0,
  • "warning_threshold_in_percent": 0,
  • "alert_threshold_in_percent": 0,
  • "status": "Alert",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Container Database

Container Logs

List logs

This will list the last 1000 logs of the container

+

Response samples

Content type
application/json
{
  • "min": 0,
  • "max": 0,
  • "running": 0,
  • "running_in_percent": 0,
  • "warning_threshold_in_percent": 0,
  • "alert_threshold_in_percent": 0,
  • "status": "Alert",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Container Database

Container Logs

List logs

This will list the last 1000 logs of the container

Authorizations:
bearerAuth
path Parameters
containerId
required
string <uuid>

Container ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Container Deployment History

List container deployments

Returns the 20 last container deployments

+

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Container Deployment History

List container deployments

Returns the 20 last container deployments

Authorizations:
bearerAuth
path Parameters
containerId
required
string <uuid>

Container ID

Responses

Response samples

Content type
application/json
{
  • "page": 1,
  • "page_size": 20,
  • "results": [
    ]
}

Container Environment Variable

List environment variables

Authorizations:
bearerAuth
path Parameters
containerId
required
string <uuid>

Container ID

+

Response samples

Content type
application/json
{
  • "page": 1,
  • "page_size": 20,
  • "results": [
    ]
}

Container Environment Variable

List environment variables

Authorizations:
bearerAuth
path Parameters
containerId
required
string <uuid>

Container ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Add an environment variable to the container

    +

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Add an environment variable to the container

  • Add an environment variable to the container.
Authorizations:
bearerAuth
path Parameters
containerId
required
string <uuid>

Container ID

@@ -4513,14 +4496,14 @@

Request samples

Content type
application/json
{
  • "key": "string",
  • "value": "string",
  • "mount_path": null
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "value": "string",
  • "mount_path": null,
  • "overridden_variable": {
    },
  • "aliased_variable": {
    },
  • "scope": "APPLICATION",
  • "variable_type": "VALUE",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION",
  • "owned_by": "string"
}

Import variables

Import environment variables in a defined scope, with a defined visibility.

+

Request samples

Content type
application/json
{
  • "key": "string",
  • "value": "string",
  • "mount_path": null
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "value": "string",
  • "mount_path": null,
  • "overridden_variable": {
    },
  • "aliased_variable": {
    },
  • "scope": "APPLICATION",
  • "variable_type": "VALUE",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION",
  • "owned_by": "string"
}

Import variables

Import environment variables in a defined scope, with a defined visibility.

Authorizations:
bearerAuth
path Parameters
containerId
required
string <uuid>

Container ID

Request Body schema: application/json
overwrite
required
boolean
Default: false
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "overwrite": false,
  • "vars": [
    ]
}

Response samples

Content type
application/json
{
  • "total_variables_to_import": 0,
  • "successful_imported_variables": [
    ]
}

Delete an environment variable from a container

    +

Request samples

Content type
application/json
{
  • "overwrite": false,
  • "vars": [
    ]
}

Response samples

Content type
application/json
{
  • "total_variables_to_import": 0,
  • "successful_imported_variables": [
    ]
}

Delete an environment variable from a container

  • To delete an environment variable from an container you must have the project user permission
  • You can't delete a BUILT_IN variable
  • If you delete a variable having override or alias, the associated override/alias will be deleted as well
    • @@ -4546,7 +4529,7 @@

Request samples

Content type
application/json
{
  • "key": "string",
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "value": "string",
  • "mount_path": null,
  • "overridden_variable": {
    },
  • "aliased_variable": {
    },
  • "scope": "APPLICATION",
  • "variable_type": "VALUE",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION",
  • "owned_by": "string"
}

Create an environment variable override at the container level

    +

Request samples

Content type
application/json
{
  • "key": "string",
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "value": "string",
  • "mount_path": null,
  • "overridden_variable": {
    },
  • "aliased_variable": {
    },
  • "scope": "APPLICATION",
  • "variable_type": "VALUE",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION",
  • "owned_by": "string"
}

Create an environment variable override at the container level

  • Allows you to override at container level an environment variable that has a higher scope.
  • You only have to specify a value in the request body
  • The system will create a new environment variable at container level with the same key as the one corresponding to the variable id in the path
    • @@ -4560,7 +4543,7 @@

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "value": "string",
  • "mount_path": null,
  • "overridden_variable": {
    },
  • "aliased_variable": {
    },
  • "scope": "APPLICATION",
  • "variable_type": "VALUE",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION",
  • "owned_by": "string"
}

Create an environment variable alias at the container level

    +

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "value": "string",
  • "mount_path": null,
  • "overridden_variable": {
    },
  • "aliased_variable": {
    },
  • "scope": "APPLICATION",
  • "variable_type": "VALUE",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION",
  • "owned_by": "string"
}

Create an environment variable alias at the container level

  • Allows you to add an alias at container level on an existing environment variable having higher scope, in order to customize its key.
  • You only have to specify a key in the request body
  • The system will create a new environment variable at container level with the same value as the one corresponding to the variable id in the path
    • @@ -4575,13 +4558,13 @@

Request samples

Content type
application/json
{
  • "key": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "value": "string",
  • "mount_path": null,
  • "overridden_variable": {
    },
  • "aliased_variable": {
    },
  • "scope": "APPLICATION",
  • "variable_type": "VALUE",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION",
  • "owned_by": "string"
}

Container Secret

List container secrets

Secrets are like environment variables, but they are secured and can't be revealed.

+

Request samples

Content type
application/json
{
  • "key": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "value": "string",
  • "mount_path": null,
  • "overridden_variable": {
    },
  • "aliased_variable": {
    },
  • "scope": "APPLICATION",
  • "variable_type": "VALUE",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION",
  • "owned_by": "string"
}

Container Secret

List container secrets

Secrets are like environment variables, but they are secured and can't be revealed.

Authorizations:
bearerAuth
path Parameters
containerId
required
string <uuid>

Container ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Add a secret to the container

    +

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Add a secret to the container

  • Add a secret to the container.
Authorizations:
bearerAuth
path Parameters
containerId
required
string <uuid>

Container ID

@@ -4593,7 +4576,7 @@

Request samples

Content type
application/json
{
  • "key": "string",
  • "value": "string",
  • "mount_path": null
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "overridden_secret": {
    },
  • "aliased_secret": {
    },
  • "scope": "APPLICATION",
  • "variable_type": "VALUE",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION",
  • "owned_by": "string"
}

Delete a secret from an container

    +

Request samples

Content type
application/json
{
  • "key": "string",
  • "value": "string",
  • "mount_path": null
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "overridden_secret": {
    },
  • "aliased_secret": {
    },
  • "scope": "APPLICATION",
  • "variable_type": "VALUE",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION",
  • "owned_by": "string"
}

Delete a secret from an container

  • To delete a secret you must have the project user permission
  • You can't delete a BUILT_IN secret
  • If you delete a secret having override or alias, the associated override/alias will be deleted as well
    • @@ -4617,7 +4600,7 @@

Request samples

Content type
application/json
{
  • "value": "string",
  • "key": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "overridden_secret": {
    },
  • "aliased_secret": {
    },
  • "scope": "APPLICATION",
  • "variable_type": "VALUE",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION",
  • "owned_by": "string"
}

Create a secret override at the container level

    +

Request samples

Content type
application/json
{
  • "value": "string",
  • "key": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "overridden_secret": {
    },
  • "aliased_secret": {
    },
  • "scope": "APPLICATION",
  • "variable_type": "VALUE",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION",
  • "owned_by": "string"
}

Create a secret override at the container level

  • Allows you to override at container level a secret that has a higher scope.
  • You only have to specify a value in the request body
  • The system will create a new secret at container level with the same key as the one corresponding to the secret id in the path
    • @@ -4631,7 +4614,7 @@

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "overridden_secret": {
    },
  • "aliased_secret": {
    },
  • "scope": "APPLICATION",
  • "variable_type": "VALUE",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION",
  • "owned_by": "string"
}

Create a secret alias at the container level

    +

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "overridden_secret": {
    },
  • "aliased_secret": {
    },
  • "scope": "APPLICATION",
  • "variable_type": "VALUE",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION",
  • "owned_by": "string"
}

Create a secret alias at the container level

  • Allows you to add an alias at container level on an existing secret having higher scope, in order to customize its key.
  • You only have to specify a key in the request body
  • The system will create a new secret at container level with the same value as the one corresponding to the secret id in the path
    • @@ -4646,12 +4629,12 @@

Request samples

Content type
application/json
{
  • "key": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "overridden_secret": {
    },
  • "aliased_secret": {
    },
  • "scope": "APPLICATION",
  • "variable_type": "VALUE",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION",
  • "owned_by": "string"
}

Container Event

Database Main Calls

Get database by ID

Authorizations:
bearerAuth
path Parameters
databaseId
required
string <uuid>

Database ID

+

Request samples

Content type
application/json
{
  • "key": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "overridden_secret": {
    },
  • "aliased_secret": {
    },
  • "scope": "APPLICATION",
  • "variable_type": "VALUE",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION",
  • "owned_by": "string"
}

Container Event

Database Main Calls

Get database by ID

Authorizations:
bearerAuth
path Parameters
databaseId
required
string <uuid>

Database ID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "type": "MONGODB",
  • "version": "10.1",
  • "mode": "CONTAINER",
  • "accessibility": "PRIVATE",
  • "cpu": 1250,
  • "instance_type": "db.t3.medium",
  • "memory": 1024,
  • "storage": 10,
  • "environment": {
    },
  • "host": "string",
  • "port": 5432,
  • "maximum_cpu": 1250,
  • "maximum_memory": 1024,
  • "disk_encrypted": true
}

Edit a database

To edit a database you must have the admin permission

+

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "type": "MONGODB",
  • "version": "10.1",
  • "mode": "CONTAINER",
  • "accessibility": "PRIVATE",
  • "cpu": 1250,
  • "instance_type": "db.t3.medium",
  • "memory": 1024,
  • "storage": 10,
  • "environment": {
    },
  • "host": "string",
  • "port": 5432,
  • "maximum_cpu": 1250,
  • "maximum_memory": 1024,
  • "disk_encrypted": true
}

Edit a database

To edit a database you must have the admin permission

Authorizations:
bearerAuth
path Parameters
databaseId
required
string <uuid>

Database ID

Request Body schema: application/json
name
string

name is case-insensitive

description
string

give a description to this database

@@ -4678,7 +4661,7 @@

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "version": "10.1",
  • "accessibility": "PRIVATE",
  • "cpu": 1250,
  • "memory": 1024,
  • "storage": 4,
  • "instance_type": "db.t3.medium"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "type": "MONGODB",
  • "version": "10.1",
  • "mode": "CONTAINER",
  • "accessibility": "PRIVATE",
  • "cpu": 1250,
  • "instance_type": "db.t3.medium",
  • "memory": 1024,
  • "storage": 10,
  • "environment": {
    },
  • "host": "string",
  • "port": 5432,
  • "maximum_cpu": 1250,
  • "maximum_memory": 1024,
  • "disk_encrypted": true
}

Delete a database

To delete a database you must have the admin permission

+

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "version": "10.1",
  • "accessibility": "PRIVATE",
  • "cpu": 1250,
  • "memory": 1024,
  • "storage": 4,
  • "instance_type": "db.t3.medium"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "type": "MONGODB",
  • "version": "10.1",
  • "mode": "CONTAINER",
  • "accessibility": "PRIVATE",
  • "cpu": 1250,
  • "instance_type": "db.t3.medium",
  • "memory": 1024,
  • "storage": 10,
  • "environment": {
    },
  • "host": "string",
  • "port": 5432,
  • "maximum_cpu": 1250,
  • "maximum_memory": 1024,
  • "disk_encrypted": true
}

Delete a database

To delete a database you must have the admin permission

Authorizations:
bearerAuth
path Parameters
databaseId
required
string <uuid>

Database ID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "BUILDING",
  • "service_deployment_status": "NEVER_DEPLOYED",
  • "last_deployment_date": "2019-08-24T14:15:22Z",
  • "is_part_last_deployment": true
}

List eligible versions for the database

Authorizations:
bearerAuth
path Parameters
databaseId
required
string <uuid>

Database ID

+

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "BUILDING",
  • "service_deployment_status": "NEVER_DEPLOYED",
  • "last_deployment_date": "2019-08-24T14:15:22Z",
  • "is_part_last_deployment": true
}

List eligible versions for the database

Authorizations:
bearerAuth
path Parameters
databaseId
required
string <uuid>

Database ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Get master credentials of the database

Authorizations:
bearerAuth
path Parameters
databaseId
required
string <uuid>

Database ID

+

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Get master credentials of the database

Authorizations:
bearerAuth
path Parameters
databaseId
required
string <uuid>

Database ID

Responses

Response samples

Content type
application/json
{
  • "host": "string",
  • "port": 0,
  • "login": "string",
  • "password": "string"
}

Edit database master credentials

Authorizations:
bearerAuth
path Parameters
databaseId
required
string <uuid>

Database ID

+

Response samples

Content type
application/json
{
  • "host": "string",
  • "port": 0,
  • "login": "string",
  • "password": "string"
}

Edit database master credentials

Authorizations:
bearerAuth
path Parameters
databaseId
required
string <uuid>

Database ID

Request Body schema: application/json
login
required
string
password
required
string

Responses

Request samples

Content type
application/json
{
  • "login": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "host": "string",
  • "port": 0,
  • "login": "string",
  • "password": "string"
}

Database Actions

Deprecated - Restart database

Deprecated - Please use the "Redeploy database" endpoint now

+

Request samples

Content type
application/json
{
  • "login": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "host": "string",
  • "port": 0,
  • "login": "string",
  • "password": "string"
}

Database Actions

Deprecated - Restart database

Deprecated - Please use the "Redeploy database" endpoint now

Authorizations:
bearerAuth
path Parameters
databaseId
required
string <uuid>

Database ID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "BUILDING",
  • "service_deployment_status": "NEVER_DEPLOYED",
  • "last_deployment_date": "2019-08-24T14:15:22Z",
  • "is_part_last_deployment": true
}

Redeploy database

Authorizations:
bearerAuth
path Parameters
databaseId
required
string <uuid>

Database ID

+

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "BUILDING",
  • "service_deployment_status": "NEVER_DEPLOYED",
  • "last_deployment_date": "2019-08-24T14:15:22Z",
  • "is_part_last_deployment": true
}

Redeploy database

Authorizations:
bearerAuth
path Parameters
databaseId
required
string <uuid>

Database ID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "BUILDING",
  • "service_deployment_status": "NEVER_DEPLOYED",
  • "last_deployment_date": "2019-08-24T14:15:22Z",
  • "is_part_last_deployment": true
}

Retart database

Authorizations:
bearerAuth
path Parameters
databaseId
required
string <uuid>

Database ID

+

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "BUILDING",
  • "service_deployment_status": "NEVER_DEPLOYED",
  • "last_deployment_date": "2019-08-24T14:15:22Z",
  • "is_part_last_deployment": true
}

Retart database

Authorizations:
bearerAuth
path Parameters
databaseId
required
string <uuid>

Database ID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "BUILDING",
  • "service_deployment_status": "NEVER_DEPLOYED",
  • "last_deployment_date": "2019-08-24T14:15:22Z",
  • "is_part_last_deployment": true
}

Stop database

Authorizations:
bearerAuth
path Parameters
databaseId
required
string <uuid>

Database ID

+

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "BUILDING",
  • "service_deployment_status": "NEVER_DEPLOYED",
  • "last_deployment_date": "2019-08-24T14:15:22Z",
  • "is_part_last_deployment": true
}

Stop database

Authorizations:
bearerAuth
path Parameters
databaseId
required
string <uuid>

Database ID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "BUILDING",
  • "service_deployment_status": "NEVER_DEPLOYED",
  • "last_deployment_date": "2019-08-24T14:15:22Z",
  • "is_part_last_deployment": true
}

Deploy database

Authorizations:
bearerAuth
path Parameters
databaseId
required
string <uuid>

Database ID

+

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "BUILDING",
  • "service_deployment_status": "NEVER_DEPLOYED",
  • "last_deployment_date": "2019-08-24T14:15:22Z",
  • "is_part_last_deployment": true
}

Deploy database

Authorizations:
bearerAuth
path Parameters
databaseId
required
string <uuid>

Database ID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "BUILDING",
  • "service_deployment_status": "NEVER_DEPLOYED",
  • "last_deployment_date": "2019-08-24T14:15:22Z",
  • "is_part_last_deployment": true
}

Database Metrics

Get current metric consumption of the database

Authorizations:
bearerAuth
path Parameters
databaseId
required
string <uuid>

Database ID

+

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "BUILDING",
  • "service_deployment_status": "NEVER_DEPLOYED",
  • "last_deployment_date": "2019-08-24T14:15:22Z",
  • "is_part_last_deployment": true
}

Database Metrics

Get current metric consumption of the database

Authorizations:
bearerAuth
path Parameters
databaseId
required
string <uuid>

Database ID

Responses

Response samples

Content type
application/json
{
  • "cpu": {
    },
  • "memory": {
    },
  • "storage": {
    }
}

Get CPU consumption metric over time for the database

Authorizations:
bearerAuth
path Parameters
databaseId
required
string <uuid>

Database ID

+

Response samples

Content type
application/json
{
  • "cpu": {
    },
  • "memory": {
    },
  • "storage": {
    }
}

Get CPU consumption metric over time for the database

Authorizations:
bearerAuth
path Parameters
databaseId
required
string <uuid>

Database ID

query Parameters
lastSeconds
required
number

Up to how many seconds in the past to ask analytics results

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Get Memory consumption metric over time for the database

Authorizations:
bearerAuth
path Parameters
databaseId
required
string <uuid>

Database ID

+

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Get Memory consumption metric over time for the database

Authorizations:
bearerAuth
path Parameters
databaseId
required
string <uuid>

Database ID

query Parameters
lastSeconds
required
number

Up to how many seconds in the past to ask analytics results

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Get Storage consumption metric over time for the database

Authorizations:
bearerAuth
path Parameters
databaseId
required
string <uuid>

Database ID

+

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Get Storage consumption metric over time for the database

Authorizations:
bearerAuth
path Parameters
databaseId
required
string <uuid>

Database ID

query Parameters
lastSeconds
required
number

Up to how many seconds in the past to ask analytics results

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Get Health Check latency metric over time for the database

The value returned corresponds to the 95th centile

+

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Get Health Check latency metric over time for the database

The value returned corresponds to the 95th centile

Authorizations:
bearerAuth
path Parameters
databaseId
required
string <uuid>

Database ID

query Parameters
lastSeconds
required
number

Up to how many seconds in the past to ask analytics results

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Database Deployment History

List database deploys

By default it returns the 20 last results. The response is paginated.

+

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Database Deployment History

List database deploys

By default it returns the 20 last results. The response is paginated.

Authorizations:
bearerAuth
path Parameters
databaseId
required
string <uuid>

Database ID

query Parameters
startId
string <uuid>

Starting point after which to return results

Responses

Response samples

Content type
application/json
{
  • "page": 1,
  • "page_size": 20,
  • "results": [
    ]
}

Database Application

List applications using the database

Authorizations:
bearerAuth
path Parameters
databaseId
required
string <uuid>

Database ID

+

Response samples

Content type
application/json
{
  • "page": 1,
  • "page_size": 20,
  • "results": [
    ]
}

Database Application

List applications using the database

Authorizations:
bearerAuth
path Parameters
databaseId
required
string <uuid>

Database ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Remove an application from this database

Authorizations:
bearerAuth
path Parameters
databaseId
required
string <uuid>

Database ID

+

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Remove an application from this database

Authorizations:
bearerAuth
path Parameters
databaseId
required
string <uuid>

Database ID

targetApplicationId
required
string <uuid>

Target application ID

Responses

Response samples

Content type
application/json
{
  • "page": 1,
  • "page_size": 20,
  • "results": [
    ]
}

Add a backup to the Database

Authorizations:
bearerAuth
path Parameters
databaseId
required
string <uuid>

Database ID

+

Response samples

Content type
application/json
{
  • "page": 1,
  • "page_size": 20,
  • "results": [
    ]
}

Add a backup to the Database

Authorizations:
bearerAuth
path Parameters
databaseId
required
string <uuid>

Database ID

Request Body schema: application/json
name
required
string
message
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "message": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "message": "string",
  • "status": {
    }
}

Remove database backup

Authorizations:
bearerAuth
path Parameters
databaseId
required
string <uuid>

Database ID

+

Request samples

Content type
application/json
{
  • "name": "string",
  • "message": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "message": "string",
  • "status": {
    }
}

Remove database backup

Authorizations:
bearerAuth
path Parameters
databaseId
required
string <uuid>

Database ID

backupId
required
string <uuid>

Database Backup ID

Responses

Response samples

Content type
application/json
{
  • "page": 1,
  • "page_size": 20,
  • "results": [
    ]
}

Job Main Calls

Get job by ID

Authorizations:
bearerAuth
path Parameters
jobId
required
string <uuid>

Job ID

+

Response samples

Content type
application/json
{
  • "page": 1,
  • "page_size": 20,
  • "results": [
    ]
}

Job Main Calls

Get job by ID

Authorizations:
bearerAuth
path Parameters
jobId
required
string <uuid>

Job ID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "environment": {
    },
  • "registry": {
    },
  • "maximum_cpu": 16000,
  • "maximum_memory": 16384,
  • "name": "string",
  • "description": "string",
  • "cpu": 1250,
  • "memory": 1024,
  • "max_nb_restart": 0,
  • "max_duration_seconds": 0,
  • "auto_preview": true,
  • "port": null,
  • "source": {
    },
  • "healthchecks": {
    },
  • "schedule": {
    }
}

Edit job

    +

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "environment": {
    },
  • "registry": {
    },
  • "maximum_cpu": 16000,
  • "maximum_memory": 16384,
  • "name": "string",
  • "description": "string",
  • "cpu": 1250,
  • "memory": 1024,
  • "max_nb_restart": 0,
  • "max_duration_seconds": 0,
  • "auto_preview": true,
  • "port": null,
  • "source": {
    },
  • "healthchecks": {
    },
  • "schedule": {
    }
}

Edit job

  • To edit the job you must have the admin permission.
Authorizations:
bearerAuth
path Parameters
jobId
required
string <uuid>

Job ID

@@ -4834,7 +4817,7 @@

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "cpu": 1250,
  • "memory": 1024,
  • "max_nb_restart": 0,
  • "max_duration_seconds": 0,
  • "auto_preview": true,
  • "port": null,
  • "source": {
    },
  • "healthchecks": {
    },
  • "schedule": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "environment": {
    },
  • "registry": {
    },
  • "maximum_cpu": 16000,
  • "maximum_memory": 16384,
  • "name": "string",
  • "description": "string",
  • "cpu": 1250,
  • "memory": 1024,
  • "max_nb_restart": 0,
  • "max_duration_seconds": 0,
  • "auto_preview": true,
  • "port": null,
  • "source": {
    },
  • "healthchecks": {
    },
  • "schedule": {
    }
}

Delete job

To delete the job you must have the admin permission

+

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "cpu": 1250,
  • "memory": 1024,
  • "max_nb_restart": 0,
  • "max_duration_seconds": 0,
  • "auto_preview": true,
  • "port": null,
  • "source": {
    },
  • "healthchecks": {
    },
  • "schedule": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "environment": {
    },
  • "registry": {
    },
  • "maximum_cpu": 16000,
  • "maximum_memory": 16384,
  • "name": "string",
  • "description": "string",
  • "cpu": 1250,
  • "memory": 1024,
  • "max_nb_restart": 0,
  • "max_duration_seconds": 0,
  • "auto_preview": true,
  • "port": null,
  • "source": {
    },
  • "healthchecks": {
    },
  • "schedule": {
    }
}

Delete job

To delete the job you must have the admin permission

Authorizations:
bearerAuth
path Parameters
jobId
required
string <uuid>

Job ID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "BUILDING",
  • "service_deployment_status": "NEVER_DEPLOYED",
  • "last_deployment_date": "2019-08-24T14:15:22Z",
  • "is_part_last_deployment": true
}

List last job commits

Returns list of the last 100 commits made on the repository linked to the job

+

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "BUILDING",
  • "service_deployment_status": "NEVER_DEPLOYED",
  • "last_deployment_date": "2019-08-24T14:15:22Z",
  • "is_part_last_deployment": true
}

List last job commits

Returns list of the last 100 commits made on the repository linked to the job

Authorizations:
bearerAuth
path Parameters
jobId
required
string <uuid>

Job ID

query Parameters
startId
string <uuid>

Starting point after which to return results

gitCommitId
string <uuid>

Git Commit ID

@@ -4853,7 +4836,7 @@

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Job Actions

Deploy job

You must provide a git commit id or an image tag depending on the source location of your code (git vs image repository).

+

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Job Actions

Deploy job

You must provide a git commit id or an image tag depending on the source location of your code (git vs image repository).

Authorizations:
bearerAuth
path Parameters
jobId
required
string <uuid>

Job ID

query Parameters
forceEvent
string (JobForceEvent)
Enum: "START" "STOP" "DELETE" "CRON"

When filled, it indicates the target event to be deployed.
If the concerned job hasn't the target event provided, the job won't be deployed.

Request Body schema: application/json
image_tag
string

Image tag to deploy.
Cannot be set if git_commit_id is defined

@@ -4865,7 +4848,7 @@

Request samples

Content type
application/json
{
  • "image_tag": "string",
  • "git_commit_id": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "BUILDING",
  • "service_deployment_status": "NEVER_DEPLOYED",
  • "last_deployment_date": "2019-08-24T14:15:22Z",
  • "is_part_last_deployment": true
}

Deprecated - Restart job

Deprecated - Please use the "Redeploy job" endpoint now

+

Request samples

Content type
application/json
{
  • "image_tag": "string",
  • "git_commit_id": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "BUILDING",
  • "service_deployment_status": "NEVER_DEPLOYED",
  • "last_deployment_date": "2019-08-24T14:15:22Z",
  • "is_part_last_deployment": true
}

Deprecated - Restart job

Deprecated - Please use the "Redeploy job" endpoint now

Authorizations:
bearerAuth
path Parameters
jobId
required
string <uuid>

Job ID

query Parameters
forceEvent
string (JobForceEvent)
Enum: "START" "STOP" "DELETE" "CRON"

When filled, it indicates the target event to be deployed.
If the concerned job hasn't the target event provided, the job won't be deployed.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "BUILDING",
  • "service_deployment_status": "NEVER_DEPLOYED",
  • "last_deployment_date": "2019-08-24T14:15:22Z",
  • "is_part_last_deployment": true
}

Redeploy job

Authorizations:
bearerAuth
path Parameters
jobId
required
string <uuid>

Job ID

+

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "BUILDING",
  • "service_deployment_status": "NEVER_DEPLOYED",
  • "last_deployment_date": "2019-08-24T14:15:22Z",
  • "is_part_last_deployment": true
}

Redeploy job

Authorizations:
bearerAuth
path Parameters
jobId
required
string <uuid>

Job ID

query Parameters
forceEvent
string (JobForceEvent)
Enum: "START" "STOP" "DELETE" "CRON"

When filled, it indicates the target event to be deployed.
If the concerned job hasn't the target event provided, the job won't be deployed.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "BUILDING",
  • "service_deployment_status": "NEVER_DEPLOYED",
  • "last_deployment_date": "2019-08-24T14:15:22Z",
  • "is_part_last_deployment": true
}

Stop job

Authorizations:
bearerAuth
path Parameters
jobId
required
string <uuid>

Job ID

+

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "BUILDING",
  • "service_deployment_status": "NEVER_DEPLOYED",
  • "last_deployment_date": "2019-08-24T14:15:22Z",
  • "is_part_last_deployment": true
}

Stop job

Authorizations:
bearerAuth
path Parameters
jobId
required
string <uuid>

Job ID

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "BUILDING",
  • "service_deployment_status": "NEVER_DEPLOYED",
  • "last_deployment_date": "2019-08-24T14:15:22Z",
  • "is_part_last_deployment": true
}

Job Configuration

Get advanced settings

Get list and values of the advanced settings of the job.

+

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "BUILDING",
  • "service_deployment_status": "NEVER_DEPLOYED",
  • "last_deployment_date": "2019-08-24T14:15:22Z",
  • "is_part_last_deployment": true
}

Job Configuration

Get advanced settings

Get list and values of the advanced settings of the job.

Authorizations:
bearerAuth
path Parameters
jobId
required
string <uuid>

Job ID

Responses

Response samples

Content type
application/json
{
  • "build.timeout_max_sec": 1800,
  • "build.cpu_max_in_milli": 4000,
  • "build.ram_max_in_gib": 8,
  • "deployment.termination_grace_period_seconds": 60,
  • "deployment.affinity.node.required": {
    },
  • "job.delete_ttl_seconds_after_finished": null,
  • "cronjob.concurrency_policy": "Forbid",
  • "cronjob.failed_jobs_history_limit": 1,
  • "cronjob.success_jobs_history_limit": 1,
  • "security.service_account_name": ""
}

Edit advanced settings

Edit advanced settings by returning table of advanced settings.

+

Response samples

Content type
application/json
{
  • "build.timeout_max_sec": 1800,
  • "build.cpu_max_in_milli": 4000,
  • "build.ram_max_in_gib": 8,
  • "deployment.termination_grace_period_seconds": 60,
  • "deployment.affinity.node.required": {
    },
  • "job.delete_ttl_seconds_after_finished": null,
  • "cronjob.concurrency_policy": "Forbid",
  • "cronjob.failed_jobs_history_limit": 1,
  • "cronjob.success_jobs_history_limit": 1,
  • "security.service_account_name": ""
}

Edit advanced settings

Edit advanced settings by returning table of advanced settings.

Authorizations:
bearerAuth
path Parameters
jobId
required
string <uuid>

Job ID

Request Body schema: application/json
build.timeout_max_sec
integer
Default: 1800

define the max timeout for the build

build.cpu_max_in_milli
integer
Default: 4000

define the max cpu resources (in milli)

@@ -4905,23 +4888,23 @@

Request samples

Content type
application/json
{
  • "build.timeout_max_sec": 1800,
  • "build.cpu_max_in_milli": 4000,
  • "build.ram_max_in_gib": 8,
  • "deployment.termination_grace_period_seconds": 60,
  • "deployment.affinity.node.required": {
    },
  • "job.delete_ttl_seconds_after_finished": null,
  • "cronjob.concurrency_policy": "Forbid",
  • "cronjob.failed_jobs_history_limit": 1,
  • "cronjob.success_jobs_history_limit": 1,
  • "security.service_account_name": ""
}

Response samples

Content type
application/json
{
  • "build.timeout_max_sec": 1800,
  • "build.cpu_max_in_milli": 4000,
  • "build.ram_max_in_gib": 8,
  • "deployment.termination_grace_period_seconds": 60,
  • "deployment.affinity.node.required": {
    },
  • "job.delete_ttl_seconds_after_finished": null,
  • "cronjob.concurrency_policy": "Forbid",
  • "cronjob.failed_jobs_history_limit": 1,
  • "cronjob.success_jobs_history_limit": 1,
  • "security.service_account_name": ""
}

Job Metrics

List currently running instances of the job with their CPU and RAM metrics

Authorizations:
bearerAuth
path Parameters
jobId
required
string <uuid>

Job ID

+

Request samples

Content type
application/json
{
  • "build.timeout_max_sec": 1800,
  • "build.cpu_max_in_milli": 4000,
  • "build.ram_max_in_gib": 8,
  • "deployment.termination_grace_period_seconds": 60,
  • "deployment.affinity.node.required": {
    },
  • "job.delete_ttl_seconds_after_finished": null,
  • "cronjob.concurrency_policy": "Forbid",
  • "cronjob.failed_jobs_history_limit": 1,
  • "cronjob.success_jobs_history_limit": 1,
  • "security.service_account_name": ""
}

Response samples

Content type
application/json
{
  • "build.timeout_max_sec": 1800,
  • "build.cpu_max_in_milli": 4000,
  • "build.ram_max_in_gib": 8,
  • "deployment.termination_grace_period_seconds": 60,
  • "deployment.affinity.node.required": {
    },
  • "job.delete_ttl_seconds_after_finished": null,
  • "cronjob.concurrency_policy": "Forbid",
  • "cronjob.failed_jobs_history_limit": 1,
  • "cronjob.success_jobs_history_limit": 1,
  • "security.service_account_name": ""
}

Job Metrics

List currently running instances of the job with their CPU and RAM metrics

Authorizations:
bearerAuth
path Parameters
jobId
required
string <uuid>

Job ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Job Deployment History

List job deployments

Returns the 20 last job deployments

+

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Job Deployment History

List job deployments

Returns the 20 last job deployments

Authorizations:
bearerAuth
path Parameters
jobId
required
string <uuid>

Job ID

Responses

Response samples

Content type
application/json
{
  • "page": 1,
  • "page_size": 20,
  • "results": [
    ]
}

Job Environment Variable

List environment variables

Authorizations:
bearerAuth
path Parameters
jobId
required
string <uuid>

Job ID

+

Response samples

Content type
application/json
{
  • "page": 1,
  • "page_size": 20,
  • "results": [
    ]
}

Job Environment Variable

List environment variables

Authorizations:
bearerAuth
path Parameters
jobId
required
string <uuid>

Job ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Add an environment variable to the job

    +

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Add an environment variable to the job

  • Add an environment variable to the job.
Authorizations:
bearerAuth
path Parameters
jobId
required
string <uuid>

Job ID

@@ -4933,14 +4916,14 @@

Request samples

Content type
application/json
{
  • "key": "string",
  • "value": "string",
  • "mount_path": null
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "value": "string",
  • "mount_path": null,
  • "overridden_variable": {
    },
  • "aliased_variable": {
    },
  • "scope": "APPLICATION",
  • "variable_type": "VALUE",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION",
  • "owned_by": "string"
}

Import variables

Import environment variables in a defined scope, with a defined visibility.

+

Request samples

Content type
application/json
{
  • "key": "string",
  • "value": "string",
  • "mount_path": null
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "value": "string",
  • "mount_path": null,
  • "overridden_variable": {
    },
  • "aliased_variable": {
    },
  • "scope": "APPLICATION",
  • "variable_type": "VALUE",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION",
  • "owned_by": "string"
}

Import variables

Import environment variables in a defined scope, with a defined visibility.

Authorizations:
bearerAuth
path Parameters
jobId
required
string <uuid>

Job ID

Request Body schema: application/json
overwrite
required
boolean
Default: false
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "overwrite": false,
  • "vars": [
    ]
}

Response samples

Content type
application/json
{
  • "total_variables_to_import": 0,
  • "successful_imported_variables": [
    ]
}

Delete an environment variable from a job

    +

Request samples

Content type
application/json
{
  • "overwrite": false,
  • "vars": [
    ]
}

Response samples

Content type
application/json
{
  • "total_variables_to_import": 0,
  • "successful_imported_variables": [
    ]
}

Delete an environment variable from a job

  • To delete an environment variable from an job you must have the project user permission
  • You can't delete a BUILT_IN variable
  • If you delete a variable having override or alias, the associated override/alias will be deleted as well
    • @@ -4966,7 +4949,7 @@

Request samples

Content type
application/json
{
  • "key": "string",
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "value": "string",
  • "mount_path": null,
  • "overridden_variable": {
    },
  • "aliased_variable": {
    },
  • "scope": "APPLICATION",
  • "variable_type": "VALUE",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION",
  • "owned_by": "string"
}

Create an environment variable override at the job level

    +

Request samples

Content type
application/json
{
  • "key": "string",
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "value": "string",
  • "mount_path": null,
  • "overridden_variable": {
    },
  • "aliased_variable": {
    },
  • "scope": "APPLICATION",
  • "variable_type": "VALUE",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION",
  • "owned_by": "string"
}

Create an environment variable override at the job level

  • Allows you to override at job level an environment variable that has a higher scope.
  • You only have to specify a value in the request body
  • The system will create a new environment variable at job level with the same key as the one corresponding to the variable id in the path
    • @@ -4980,7 +4963,7 @@

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "value": "string",
  • "mount_path": null,
  • "overridden_variable": {
    },
  • "aliased_variable": {
    },
  • "scope": "APPLICATION",
  • "variable_type": "VALUE",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION",
  • "owned_by": "string"
}

Create an environment variable alias at the job level

    +

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "value": "string",
  • "mount_path": null,
  • "overridden_variable": {
    },
  • "aliased_variable": {
    },
  • "scope": "APPLICATION",
  • "variable_type": "VALUE",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION",
  • "owned_by": "string"
}

Create an environment variable alias at the job level

  • Allows you to add an alias at job level on an existing environment variable having higher scope, in order to customize its key.
  • You only have to specify a key in the request body
  • The system will create a new environment variable at job level with the same value as the one corresponding to the variable id in the path
    • @@ -4995,13 +4978,13 @@

Request samples

Content type
application/json
{
  • "key": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "value": "string",
  • "mount_path": null,
  • "overridden_variable": {
    },
  • "aliased_variable": {
    },
  • "scope": "APPLICATION",
  • "variable_type": "VALUE",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION",
  • "owned_by": "string"
}

Job Secret

List job secrets

Secrets are like environment variables, but they are secured and can't be revealed.

+

Request samples

Content type
application/json
{
  • "key": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "value": "string",
  • "mount_path": null,
  • "overridden_variable": {
    },
  • "aliased_variable": {
    },
  • "scope": "APPLICATION",
  • "variable_type": "VALUE",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION",
  • "owned_by": "string"
}

Job Secret

List job secrets

Secrets are like environment variables, but they are secured and can't be revealed.

Authorizations:
bearerAuth
path Parameters
jobId
required
string <uuid>

Job ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Add a secret to the job

    +

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Add a secret to the job

  • Add a secret to the job.
Authorizations:
bearerAuth
path Parameters
jobId
required
string <uuid>

Job ID

@@ -5013,7 +4996,7 @@

Request samples

Content type
application/json
{
  • "key": "string",
  • "value": "string",
  • "mount_path": null
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "overridden_secret": {
    },
  • "aliased_secret": {
    },
  • "scope": "APPLICATION",
  • "variable_type": "VALUE",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION",
  • "owned_by": "string"
}

Delete a secret from an job

    +

Request samples

Content type
application/json
{
  • "key": "string",
  • "value": "string",
  • "mount_path": null
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "overridden_secret": {
    },
  • "aliased_secret": {
    },
  • "scope": "APPLICATION",
  • "variable_type": "VALUE",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION",
  • "owned_by": "string"
}

Delete a secret from an job

  • To delete a secret you must have the project user permission
  • You can't delete a BUILT_IN secret
  • If you delete a secret having override or alias, the associated override/alias will be deleted as well
    • @@ -5037,7 +5020,7 @@

Request samples

Content type
application/json
{
  • "value": "string",
  • "key": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "overridden_secret": {
    },
  • "aliased_secret": {
    },
  • "scope": "APPLICATION",
  • "variable_type": "VALUE",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION",
  • "owned_by": "string"
}

Create a secret override at the job level

    +

Request samples

Content type
application/json
{
  • "value": "string",
  • "key": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "overridden_secret": {
    },
  • "aliased_secret": {
    },
  • "scope": "APPLICATION",
  • "variable_type": "VALUE",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION",
  • "owned_by": "string"
}

Create a secret override at the job level

  • Allows you to override at job level a secret that has a higher scope.
  • You only have to specify a value in the request body
  • The system will create a new secret at job level with the same key as the one corresponding to the secret id in the path
    • @@ -5051,7 +5034,7 @@

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "overridden_secret": {
    },
  • "aliased_secret": {
    },
  • "scope": "APPLICATION",
  • "variable_type": "VALUE",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION",
  • "owned_by": "string"
}

Create a secret alias at the job level

    +

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "overridden_secret": {
    },
  • "aliased_secret": {
    },
  • "scope": "APPLICATION",
  • "variable_type": "VALUE",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION",
  • "owned_by": "string"
}

Create a secret alias at the job level

  • Allows you to add an alias at job level on an existing secret having higher scope, in order to customize its key.
  • You only have to specify a key in the request body
  • The system will create a new secret at job level with the same value as the one corresponding to the secret id in the path
    • @@ -5066,51 +5049,51 @@

Request samples

Content type
application/json
{
  • "key": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "overridden_secret": {
    },
  • "aliased_secret": {
    },
  • "scope": "APPLICATION",
  • "variable_type": "VALUE",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION",
  • "owned_by": "string"
}

Job Event

Account Info

Get Account information

Authorizations:
bearerAuth

Responses

Request samples

Content type
application/json
{
  • "key": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "key": "string",
  • "overridden_secret": {
    },
  • "aliased_secret": {
    },
  • "scope": "APPLICATION",
  • "variable_type": "VALUE",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION",
  • "owned_by": "string"
}

Job Event

Account Info

Get Account information

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "nickname": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "profile_picture_url": "string",
  • "communication_email": "string"
}

Edit account information

Authorizations:
bearerAuth
Request Body schema: application/json
communication_email
string or null

The email to be used for official Qovery communications

+

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "nickname": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "profile_picture_url": "string",
  • "communication_email": "string"
}

Edit account information

Authorizations:
bearerAuth
Request Body schema: application/json
communication_email
string or null

The email to be used for official Qovery communications

Responses

Request samples

Content type
application/json
{
  • "communication_email": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "nickname": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "profile_picture_url": "string",
  • "communication_email": "string"
}

Git repositories

Get git provider accounts Deprecated

Authorizations:
bearerAuth

Responses

Request samples

Content type
application/json
{
  • "communication_email": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "nickname": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "profile_picture_url": "string",
  • "communication_email": "string"
}

Git repositories

Get git provider accounts Deprecated

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Get github repositories of the connected user Deprecated

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Get github repositories of the connected user Deprecated

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{}

Get github branches of the specified repository Deprecated

Authorizations:
bearerAuth
query Parameters
name
string

The name of the repository where to retrieve the branches

+

Response samples

Content type
application/json
{}

Get github branches of the specified repository Deprecated

Authorizations:
bearerAuth
query Parameters
name
string

The name of the repository where to retrieve the branches

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Get gitlab repositories of the connected user Deprecated

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Get gitlab repositories of the connected user Deprecated

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{}

Get gitlab branches of the specified repository Deprecated

Authorizations:
bearerAuth
query Parameters
name
string

The name of the repository to retrieve the branches

+

Response samples

Content type
application/json
{}

Get gitlab branches of the specified repository Deprecated

Authorizations:
bearerAuth
query Parameters
name
string

The name of the repository to retrieve the branches

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Get bitbucket repositories of the connected user Deprecated

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Get bitbucket repositories of the connected user Deprecated

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{}

Get bitbucket branches of the specified repository Deprecated

Authorizations:
bearerAuth
query Parameters
name
string

The name of the repository where to retrieve the branches

+

Response samples

Content type
application/json
{}

Get bitbucket branches of the specified repository Deprecated

Authorizations:
bearerAuth
query Parameters
name
string

The name of the repository where to retrieve the branches

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Referral & Rewards

Get your referral information

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Referral & Rewards

Get your referral information

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{}

Claim a reward

A same code can be claimed only 3 times at max

+

Response samples

Content type
application/json
{}

Claim a reward

A same code can be claimed only 3 times at max

Authorizations:
bearerAuth
Request Body schema: application/json
type
string
Value: "INVITATION"
code
string

Responses

Request samples

Content type
application/json
{
  • "type": "INVITATION",
  • "code": "xDowkWEl"
}

Git repositories

Get git provider accounts Deprecated

Authorizations:
bearerAuth

Responses

Request samples

Content type
application/json
{
  • "type": "INVITATION",
  • "code": "xDowkWEl"
}

Git repositories

Get git provider accounts Deprecated

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Get github repositories of the connected user Deprecated

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Get github repositories of the connected user Deprecated

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{}

Get github branches of the specified repository Deprecated

Authorizations:
bearerAuth
query Parameters
name
string

The name of the repository where to retrieve the branches

+

Response samples

Content type
application/json
{}

Get github branches of the specified repository Deprecated

Authorizations:
bearerAuth
query Parameters
name
string

The name of the repository where to retrieve the branches

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Get gitlab repositories of the connected user Deprecated

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Get gitlab repositories of the connected user Deprecated

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{}

Get gitlab branches of the specified repository Deprecated

Authorizations:
bearerAuth
query Parameters
name
string

The name of the repository to retrieve the branches

+

Response samples

Content type
application/json
{}

Get gitlab branches of the specified repository Deprecated

Authorizations:
bearerAuth
query Parameters
name
string

The name of the repository to retrieve the branches

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Get bitbucket repositories of the connected user Deprecated

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Get bitbucket repositories of the connected user Deprecated

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{}

Get bitbucket branches of the specified repository Deprecated

Authorizations:
bearerAuth
query Parameters
name
string

The name of the repository where to retrieve the branches

+

Response samples

Content type
application/json
{}

Get bitbucket branches of the specified repository Deprecated

Authorizations:
bearerAuth
query Parameters
name
string

The name of the repository where to retrieve the branches

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Variable Main Calls

List variables

Returns a list of variables. The result can be filtered by using the query parameters.

+

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Variable Main Calls

List variables

Returns a list of variables. The result can be filtered by using the query parameters.

Authorizations:
bearerAuth
query Parameters
parent_id
string <uuid>

it filters the list by returning only the variables accessible by the selected parent_id. This field shall contain the id of a project, environment or service depending on the selected scope. Example, if scope = APPLICATION and parent_id=, the result will contain any variable accessible by the application. The result will contain also any variable declared at an higher scope.

scope
string (APIVariableScopeEnum)
Enum: "APPLICATION" "BUILT_IN" "ENVIRONMENT" "PROJECT" "CONTAINER" "JOB"

the type of the parent_id (application, project, environment etc..).

is_secret
boolean or null

it filters the list by returning only the variables of type secret or not

@@ -5118,7 +5101,7 @@

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Create a variable

    +

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Create a variable

  • Create a variable with the scope defined in the request body.
Authorizations:
bearerAuth
Request Body schema: application/json
key
required
string

the key of the environment variable

@@ -5131,7 +5114,7 @@

Request samples

Content type
application/json
{
  • "key": "string",
  • "value": "string",
  • "mount_path": "string",
  • "is_secret": true,
  • "variable_scope": "APPLICATION",
  • "variable_parent_id": "670816cf-0e4b-4049-967a-2b704abf633f"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "overridden_variable": {
    },
  • "aliased_variable": {
    },
  • "scope": "APPLICATION",
  • "variable_type": "VALUE",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION",
  • "owned_by": "string"
}

Create a variable alias

    +

Request samples

Content type
application/json
{
  • "key": "string",
  • "value": "string",
  • "mount_path": "string",
  • "is_secret": true,
  • "variable_scope": "APPLICATION",
  • "variable_parent_id": "670816cf-0e4b-4049-967a-2b704abf633f"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "overridden_variable": {
    },
  • "aliased_variable": {
    },
  • "scope": "APPLICATION",
  • "variable_type": "VALUE",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION",
  • "owned_by": "string"
}

Create a variable alias

  • Allows you to create an alias of one of the existing variables.
  • You have to specify an alias (key) in the request body, the scope and the parent id of the alias (project id, environment id or service id)
  • The system will create a new variable at the requested level with the same value as the one corresponding to the variable id passed as path parameter.
    • @@ -5147,7 +5130,7 @@

Request samples

Content type
application/json
{
  • "key": "string",
  • "alias_scope": "APPLICATION",
  • "alias_parent_id": "334fccf2-1e41-467f-9287-9ccbc7f67e1d"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "overridden_variable": {
    },
  • "aliased_variable": {
    },
  • "scope": "APPLICATION",
  • "variable_type": "VALUE",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION",
  • "owned_by": "string"
}

Create a variable override

    +

Request samples

Content type
application/json
{
  • "key": "string",
  • "alias_scope": "APPLICATION",
  • "alias_parent_id": "334fccf2-1e41-467f-9287-9ccbc7f67e1d"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "overridden_variable": {
    },
  • "aliased_variable": {
    },
  • "scope": "APPLICATION",
  • "variable_type": "VALUE",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION",
  • "owned_by": "string"
}

Create a variable override

  • Allows you to override a variable that has a higher scope.
  • You have to specify a value (override) in the request body and the scope and the parent id of the variable to override (project id, environment id or service id)
  • The system will create a new environment variable at the requested level with the same key as the one corresponding to the variable id passed as path parameter.
    • @@ -5162,7 +5145,7 @@

Request samples

Content type
application/json
{
  • "value": "string",
  • "override_scope": "APPLICATION",
  • "override_parent_id": "07059dc0-da07-4335-9fd4-fd771d761257"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "overridden_variable": {
    },
  • "aliased_variable": {
    },
  • "scope": "APPLICATION",
  • "variable_type": "VALUE",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION",
  • "owned_by": "string"
}

Delete a variable

    +

Request samples

Content type
application/json
{
  • "value": "string",
  • "override_scope": "APPLICATION",
  • "override_parent_id": "07059dc0-da07-4335-9fd4-fd771d761257"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "overridden_variable": {
    },
  • "aliased_variable": {
    },
  • "scope": "APPLICATION",
  • "variable_type": "VALUE",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION",
  • "owned_by": "string"
}

Delete a variable

  • To delete a variable
  • You can't delete a BUILT_IN variable
  • If you delete a variable having override or alias, the associated override/alias will be deleted as well
    • @@ -5185,20 +5168,20 @@

Request samples

Content type
application/json
{
  • "key": "string",
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "overridden_variable": {
    },
  • "aliased_variable": {
    },
  • "scope": "APPLICATION",
  • "variable_type": "VALUE",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION",
  • "owned_by": "string"
}

User Sign Up

Get Sign up information

Retrieve the Sign Up information of the user

+

Request samples

Content type
application/json
{
  • "key": "string",
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "overridden_variable": {
    },
  • "aliased_variable": {
    },
  • "scope": "APPLICATION",
  • "variable_type": "VALUE",
  • "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  • "service_name": "string",
  • "service_type": "APPLICATION",
  • "owned_by": "string"
}

User Sign Up

Get Sign up information

Retrieve the Sign Up information of the user

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "first_name": "string",
  • "last_name": "string",
  • "user_email": "string",
  • "type_of_use": "PERSONAL",
  • "qovery_usage": "string",
  • "company_name": "string",
  • "company_size": "1-10",
  • "user_role": "string",
  • "qovery_usage_other": "string",
  • "user_questions": "string",
  • "current_step": "string",
  • "dx_auth": true
}

Send Sign Up request

Send a Sign Up request containing the user information

+

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "first_name": "string",
  • "last_name": "string",
  • "user_email": "string",
  • "type_of_use": "PERSONAL",
  • "qovery_usage": "string",
  • "company_name": "string",
  • "company_size": "1-10",
  • "user_role": "string",
  • "qovery_usage_other": "string",
  • "user_questions": "string",
  • "current_step": "string",
  • "dx_auth": true
}

Send Sign Up request

Send a Sign Up request containing the user information

Authorizations:
bearerAuth
Request Body schema: application/json
first_name
required
string
last_name
required
string
user_email
required
string
type_of_use
required
string (TypeOfUseEnum)
Enum: "PERSONAL" "SCHOOL" "WORK"
qovery_usage
required
string
company_name
string or null
company_size
string (CompanySizeEnum)
Enum: "1-10" "11-50" "51-200" "201-500" "500+"
user_role
string or null
qovery_usage_other
string or null
user_questions
string or null
current_step
string or null
dx_auth
boolean or null

Responses

Request samples

Content type
application/json
{
  • "first_name": "string",
  • "last_name": "string",
  • "user_email": "string",
  • "type_of_use": "PERSONAL",
  • "qovery_usage": "string",
  • "company_name": "string",
  • "company_size": "1-10",
  • "user_role": "string",
  • "qovery_usage_other": "string",
  • "user_questions": "string",
  • "current_step": "string",
  • "dx_auth": true
}
+

Request samples

Content type
application/json
{
  • "first_name": "string",
  • "last_name": "string",
  • "user_email": "string",
  • "type_of_use": "PERSONAL",
  • "qovery_usage": "string",
  • "company_name": "string",
  • "company_size": "1-10",
  • "user_role": "string",
  • "qovery_usage_other": "string",
  • "user_questions": "string",
  • "current_step": "string",
  • "dx_auth": true
}