From b4a3620506032ca2df0d7ae0830e11b4924c0de5 Mon Sep 17 00:00:00 2001 From: GitHub Action Date: Thu, 26 Dec 2024 15:21:07 +0000 Subject: [PATCH] Publish docs --- index.html | 56 +++++++++++++++++++++++++++--------------------------- 1 file changed, 28 insertions(+), 28 deletions(-) diff --git a/index.html b/index.html index 632be9d9..4c15c0f2 100644 --- a/index.html +++ b/index.html @@ -3628,13 +3628,13 @@

Response samples

Content type
application/json
{
  • "environment": {
    },
  • "stages": [
    ],
  • "pre_check_stage": {
    }
}

List Services By EnvironmentId

Authorizations:
bearerAuthApiKeyAuth
path Parameters
environmentId
required
string

Responses

Response samples

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

Applications

List applications

Authorizations:
bearerAuthApiKeyAuth
path Parameters
environmentId
required
string <uuid>

Environment ID

+

Response samples

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

Applications

List applications

Authorizations:
bearerAuthApiKeyAuth
path Parameters
environmentId
required
string <uuid>

Environment ID

query Parameters
toUpdate
boolean
Default: false

return (or not) results that must be updated

Responses

Response samples

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

Create an application

Authorizations:
bearerAuthApiKeyAuth
path Parameters
environmentId
required
string <uuid>

Environment ID

+

Response samples

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

Create an application

Authorizations:
bearerAuthApiKeyAuth
path Parameters
environmentId
required
string <uuid>

Environment ID

Request Body schema: application/json
Array of objects
Array of objects
name
required
string

name is case insensitive

description
string or null

give a description to this application

required
object (ApplicationGitRepositoryRequest)
build_mode
string (BuildModeEnum)
Default: "DOCKER"
Value: "DOCKER"

DOCKER requires dockerfile_path

@@ -3655,7 +3655,7 @@

Request samples

Content type
application/json
{
  • "storage": [
    ],
  • "ports": [
    ],
  • "name": "string",
  • "description": "string",
  • "git_repository": {},
  • "build_mode": "DOCKER",
  • "dockerfile_path": "string",
  • "cpu": 1250,
  • "memory": 1024,
  • "min_running_instances": 1,
  • "max_running_instances": 1,
  • "healthchecks": {
    },
  • "auto_preview": true,
  • "arguments": [
    ],
  • "entrypoint": "string",
  • "auto_deploy": true,
  • "annotations_groups": [
    ],
  • "labels_groups": [
    ],
  • "icon_uri": "http://example.com"
}

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": {
    },
  • "git_repository": {
    },
  • "maximum_cpu": 16000,
  • "maximum_memory": 16384,
  • "name": "string",
  • "description": "string",
  • "build_mode": "DOCKER",
  • "dockerfile_path": "string",
  • "cpu": 1250,
  • "memory": 1024,
  • "min_running_instances": 1,
  • "max_running_instances": 1,
  • "healthchecks": {
    },
  • "auto_preview": true,
  • "ports": [
    ],
  • "arguments": [
    ],
  • "entrypoint": "string",
  • "auto_deploy": true,
  • "annotations_groups": [
    ],
  • "labels_groups": [
    ],
  • "icon_uri": "http://example.com",
  • "serviceType": "APPLICATION"
}

List all environment applications statuses

Returns a list of applications with only their id and status.

+

Request samples

Content type
application/json
{
  • "storage": [
    ],
  • "ports": [
    ],
  • "name": "string",
  • "description": "string",
  • "git_repository": {},
  • "build_mode": "DOCKER",
  • "dockerfile_path": "string",
  • "cpu": 1250,
  • "memory": 1024,
  • "min_running_instances": 1,
  • "max_running_instances": 1,
  • "healthchecks": {
    },
  • "auto_preview": true,
  • "arguments": [
    ],
  • "entrypoint": "string",
  • "auto_deploy": true,
  • "annotations_groups": [
    ],
  • "labels_groups": [
    ],
  • "icon_uri": "http://example.com"
}

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": {
    },
  • "git_repository": {
    },
  • "maximum_cpu": 16000,
  • "maximum_memory": 16384,
  • "name": "string",
  • "description": "string",
  • "build_mode": "DOCKER",
  • "dockerfile_path": "string",
  • "cpu": 1250,
  • "memory": 1024,
  • "min_running_instances": 1,
  • "max_running_instances": 1,
  • "healthchecks": {
    },
  • "auto_preview": true,
  • "ports": [
    ],
  • "arguments": [
    ],
  • "entrypoint": "string",
  • "auto_deploy": true,
  • "annotations_groups": [
    ],
  • "labels_groups": [
    ],
  • "icon_uri": "http://example.com",
  • "service_type": "APPLICATION"
}

List all environment applications statuses

Returns a list of applications with only their id and status.

Authorizations:
bearerAuthApiKeyAuth
path Parameters
environmentId
required
string <uuid>

Environment ID

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "environment_id": "40ef0e48-a11f-4963-a229-e396c9f7e7c4"
}

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": {
    },
  • "git_repository": {
    },
  • "maximum_cpu": 16000,
  • "maximum_memory": 16384,
  • "name": "string",
  • "description": "string",
  • "build_mode": "DOCKER",
  • "dockerfile_path": "string",
  • "cpu": 1250,
  • "memory": 1024,
  • "min_running_instances": 1,
  • "max_running_instances": 1,
  • "healthchecks": {
    },
  • "auto_preview": true,
  • "ports": [
    ],
  • "arguments": [
    ],
  • "entrypoint": "string",
  • "auto_deploy": true,
  • "annotations_groups": [
    ],
  • "labels_groups": [
    ],
  • "icon_uri": "http://example.com",
  • "serviceType": "APPLICATION"
}

Containers

List all container registry container statuses

Returns a list of containers with only their id and status.

+

Request samples

Content type
application/json
{
  • "name": "string",
  • "environment_id": "40ef0e48-a11f-4963-a229-e396c9f7e7c4"
}

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": {
    },
  • "git_repository": {
    },
  • "maximum_cpu": 16000,
  • "maximum_memory": 16384,
  • "name": "string",
  • "description": "string",
  • "build_mode": "DOCKER",
  • "dockerfile_path": "string",
  • "cpu": 1250,
  • "memory": 1024,
  • "min_running_instances": 1,
  • "max_running_instances": 1,
  • "healthchecks": {
    },
  • "auto_preview": true,
  • "ports": [
    ],
  • "arguments": [
    ],
  • "entrypoint": "string",
  • "auto_deploy": true,
  • "annotations_groups": [
    ],
  • "labels_groups": [
    ],
  • "icon_uri": "http://example.com",
  • "service_type": "APPLICATION"
}

Containers

List all container registry container statuses

Returns a list of containers with only their id and status.

Authorizations:
bearerAuthApiKeyAuth
path Parameters
organizationId
required
string <uuid>

Organization ID

containerRegistryId
required
string <uuid>

Container Registry ID

Responses

Response samples

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

Create a container

Authorizations:
bearerAuthApiKeyAuth
path Parameters
environmentId
required
string <uuid>

Environment ID

+

Response samples

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

Create a container

Authorizations:
bearerAuthApiKeyAuth
path Parameters
environmentId
required
string <uuid>

Environment ID

Request Body schema: application/json
Array of objects
Array of objects
name
required
string

name is case insensitive

description
string

give a description to this container

registry_id
required
string

id of the linked registry

@@ -3714,7 +3714,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,
  • "auto_deploy": true,
  • "annotations_groups": [
    ],
  • "labels_groups": [
    ],
  • "icon_uri": "http://example.com"
}

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": [
    ],
  • "image_name": "string",
  • "tag": "string",
  • "registry_id": "string",
  • "registry": {
    },
  • "environment": {
    },
  • "maximum_cpu": 16000,
  • "maximum_memory": 16384,
  • "name": "string",
  • "description": "string",
  • "arguments": [
    ],
  • "entrypoint": "string",
  • "cpu": 1250,
  • "memory": 1024,
  • "min_running_instances": 1,
  • "max_running_instances": 1,
  • "healthchecks": {
    },
  • "auto_preview": true,
  • "ports": [
    ],
  • "auto_deploy": true,
  • "annotations_groups": [
    ],
  • "labels_groups": [
    ],
  • "icon_uri": "http://example.com",
  • "serviceType": "APPLICATION"
}

List all environment container statuses

Returns a list of containers with only their id and status.

+

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,
  • "auto_deploy": true,
  • "annotations_groups": [
    ],
  • "labels_groups": [
    ],
  • "icon_uri": "http://example.com"
}

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": [
    ],
  • "image_name": "string",
  • "tag": "string",
  • "registry_id": "string",
  • "registry": {
    },
  • "environment": {
    },
  • "maximum_cpu": 16000,
  • "maximum_memory": 16384,
  • "name": "string",
  • "description": "string",
  • "arguments": [
    ],
  • "entrypoint": "string",
  • "cpu": 1250,
  • "memory": 1024,
  • "min_running_instances": 1,
  • "max_running_instances": 1,
  • "healthchecks": {
    },
  • "auto_preview": true,
  • "ports": [
    ],
  • "auto_deploy": true,
  • "annotations_groups": [
    ],
  • "labels_groups": [
    ],
  • "icon_uri": "http://example.com",
  • "service_type": "APPLICATION"
}

List all environment container statuses

Returns a list of containers with only their id and status.

Authorizations:
bearerAuthApiKeyAuth
path Parameters
environmentId
required
string <uuid>

Environment ID

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "environment_id": "40ef0e48-a11f-4963-a229-e396c9f7e7c4"
}

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": [
    ],
  • "image_name": "string",
  • "tag": "string",
  • "registry_id": "string",
  • "registry": {
    },
  • "environment": {
    },
  • "maximum_cpu": 16000,
  • "maximum_memory": 16384,
  • "name": "string",
  • "description": "string",
  • "arguments": [
    ],
  • "entrypoint": "string",
  • "cpu": 1250,
  • "memory": 1024,
  • "min_running_instances": 1,
  • "max_running_instances": 1,
  • "healthchecks": {
    },
  • "auto_preview": true,
  • "ports": [
    ],
  • "auto_deploy": true,
  • "annotations_groups": [
    ],
  • "labels_groups": [
    ],
  • "icon_uri": "http://example.com",
  • "serviceType": "APPLICATION"
}

Databases

List eligible database types, versions and modes for the environment

Authorizations:
bearerAuthApiKeyAuth
path Parameters
environmentId
required
string <uuid>

Environment ID

+

Request samples

Content type
application/json
{
  • "name": "string",
  • "environment_id": "40ef0e48-a11f-4963-a229-e396c9f7e7c4"
}

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": [
    ],
  • "image_name": "string",
  • "tag": "string",
  • "registry_id": "string",
  • "registry": {
    },
  • "environment": {
    },
  • "maximum_cpu": 16000,
  • "maximum_memory": 16384,
  • "name": "string",
  • "description": "string",
  • "arguments": [
    ],
  • "entrypoint": "string",
  • "cpu": 1250,
  • "memory": 1024,
  • "min_running_instances": 1,
  • "max_running_instances": 1,
  • "healthchecks": {
    },
  • "auto_preview": true,
  • "ports": [
    ],
  • "auto_deploy": true,
  • "annotations_groups": [
    ],
  • "labels_groups": [
    ],
  • "icon_uri": "http://example.com",
  • "service_type": "APPLICATION"
}

Databases

List eligible database types, versions and modes for the environment

Authorizations:
bearerAuthApiKeyAuth
path Parameters
environmentId
required
string <uuid>

Environment ID

Responses

Response samples

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

Create a database

Authorizations:
bearerAuthApiKeyAuth
path Parameters
environmentId
required
string <uuid>

Environment ID

+

Response samples

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

Create a database

Authorizations:
bearerAuthApiKeyAuth
path Parameters
environmentId
required
string <uuid>

Environment ID

Request Body schema: application/json
name
required
string

name is case insensitive

description
string

give a description to this database

type
required
string (DatabaseTypeEnum)
Enum: "MONGODB" "MYSQL" "POSTGRESQL" "REDIS"
version
required
string
mode
required
string (DatabaseModeEnum)
Enum: "CONTAINER" "MANAGED"
accessibility
string (DatabaseAccessibilityEnum)
Default: "PRIVATE"
Enum: "PRIVATE" "PUBLIC"
cpu
integer
Default: 250

unit is millicores (m). 1000m = 1 cpu @@ -3796,7 +3796,7 @@

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "type": "MONGODB",
  • "version": "10.1",
  • "mode": "CONTAINER",
  • "accessibility": "PRIVATE",
  • "cpu": 1250,
  • "instance_type": "db.t3.medium",
  • "memory": 1024,
  • "storage": 10,
  • "annotations_groups": [
    ],
  • "labels_groups": [
    ],
  • "icon_uri": "http://example.com"
}

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,
  • "annotations_groups": [
    ],
  • "labels_groups": [
    ],
  • "icon_uri": "http://example.com",
  • "environment": {
    },
  • "host": "string",
  • "port": 5432,
  • "maximum_cpu": 1250,
  • "maximum_memory": 1024,
  • "disk_encrypted": true,
  • "serviceType": "APPLICATION"
}

List all environment databases statuses

Returns a list of databases with only their id and status.

+

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "type": "MONGODB",
  • "version": "10.1",
  • "mode": "CONTAINER",
  • "accessibility": "PRIVATE",
  • "cpu": 1250,
  • "instance_type": "db.t3.medium",
  • "memory": 1024,
  • "storage": 10,
  • "annotations_groups": [
    ],
  • "labels_groups": [
    ],
  • "icon_uri": "http://example.com"
}

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,
  • "annotations_groups": [
    ],
  • "labels_groups": [
    ],
  • "icon_uri": "http://example.com",
  • "environment": {
    },
  • "host": "string",
  • "port": 5432,
  • "maximum_cpu": 1250,
  • "maximum_memory": 1024,
  • "disk_encrypted": true,
  • "service_type": "APPLICATION"
}

List all environment databases statuses

Returns a list of databases with only their id and status.

Authorizations:
bearerAuthApiKeyAuth
path Parameters
environmentId
required
string <uuid>

Environment ID

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "environment_id": "40ef0e48-a11f-4963-a229-e396c9f7e7c4"
}

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,
  • "annotations_groups": [
    ],
  • "labels_groups": [
    ],
  • "icon_uri": "http://example.com",
  • "environment": {
    },
  • "host": "string",
  • "port": 5432,
  • "maximum_cpu": 1250,
  • "maximum_memory": 1024,
  • "disk_encrypted": true,
  • "serviceType": "APPLICATION"
}

Jobs

Auto deploy jobs

Triggers a new job deploy in each environment matching the following conditions

+

Request samples

Content type
application/json
{
  • "name": "string",
  • "environment_id": "40ef0e48-a11f-4963-a229-e396c9f7e7c4"
}

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,
  • "annotations_groups": [
    ],
  • "labels_groups": [
    ],
  • "icon_uri": "http://example.com",
  • "environment": {
    },
  • "host": "string",
  • "port": 5432,
  • "maximum_cpu": 1250,
  • "maximum_memory": 1024,
  • "disk_encrypted": true,
  • "service_type": "APPLICATION"
}

Jobs

Auto deploy jobs

Triggers a new job deploy in each environment matching the following conditions

  • environment should have the auto-deploy enabled
  • the job should have the same image name and a different tag
    • @@ -3833,7 +3833,7 @@

Response samples

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

Create a job

Authorizations:
bearerAuthApiKeyAuth
path Parameters
environmentId
required
string <uuid>

Environment ID

+

Response samples

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

Create a job

Authorizations:
bearerAuthApiKeyAuth
path Parameters
environmentId
required
string <uuid>

Environment ID

Request Body schema: application/json
name
required
string

name is case insensitive

description
string
cpu
integer
Default: 500

unit is millicores (m). 1000m = 1 cpu

memory
integer
Default: 512

unit is MB. 1024 MB = 1GB

@@ -3852,7 +3852,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": {
    },
  • "auto_deploy": true,
  • "annotations_groups": [
    ],
  • "labels_groups": [
    ],
  • "icon_uri": "http://example.com"
}

Response samples

Content type
application/json
Example
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "environment": {
    },
  • "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": {
    },
  • "auto_deploy": true,
  • "icon_uri": "http://example.com",
  • "serviceType": "APPLICATION",
  • "job_type": "LIFECYCLE",
  • "schedule": {
    },
  • "annotations_groups": [
    ],
  • "labels_groups": [
    ]
}

List all environment job statuses

Returns a list of jobs with only their id and status.

+

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": {
    },
  • "auto_deploy": true,
  • "annotations_groups": [
    ],
  • "labels_groups": [
    ],
  • "icon_uri": "http://example.com"
}

Response samples

Content type
application/json
Example
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "environment": {
    },
  • "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": {
    },
  • "auto_deploy": true,
  • "icon_uri": "http://example.com",
  • "service_type": "APPLICATION",
  • "job_type": "LIFECYCLE",
  • "schedule": {
    },
  • "annotations_groups": [
    ],
  • "labels_groups": [
    ]
}

List all environment job statuses

Returns a list of jobs with only their id and status.

Authorizations:
bearerAuthApiKeyAuth
path Parameters
environmentId
required
string <uuid>

Environment ID

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "environment_id": "40ef0e48-a11f-4963-a229-e396c9f7e7c4"
}

Response samples

Content type
application/json
Example
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "environment": {
    },
  • "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": {
    },
  • "auto_deploy": true,
  • "icon_uri": "http://example.com",
  • "serviceType": "APPLICATION",
  • "job_type": "LIFECYCLE",
  • "schedule": {
    },
  • "annotations_groups": [
    ],
  • "labels_groups": [
    ]
}

Helms

List default helm advanced settings

Authorizations:
bearerAuthApiKeyAuth

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "environment_id": "40ef0e48-a11f-4963-a229-e396c9f7e7c4"
}

Response samples

Content type
application/json
Example
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "environment": {
    },
  • "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": {
    },
  • "auto_deploy": true,
  • "icon_uri": "http://example.com",
  • "service_type": "APPLICATION",
  • "job_type": "LIFECYCLE",
  • "schedule": {
    },
  • "annotations_groups": [
    ],
  • "labels_groups": [
    ]
}

Helms

List default helm advanced settings

Authorizations:
bearerAuthApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "deployment.custom_domain_check_enabled": true,
  • "network.ingress.proxy_body_size_mb": 0,
  • "network.ingress.enable_cors": true,
  • "network.ingress.cors_allow_origin": "string",
  • "network.ingress.cors_allow_methods": "string",
  • "network.ingress.cors_allow_headers": "string",
  • "network.ingress.proxy_buffer_size_kb": 0,
  • "network.ingress.keepalive_time_seconds": 0,
  • "network.ingress.keepalive_timeout_seconds": 0,
  • "network.ingress.send_timeout_seconds": 0,
  • "network.ingress.proxy_connect_timeout_seconds": 0,
  • "network.ingress.proxy_send_timeout_seconds": 0,
  • "network.ingress.proxy_read_timeout_seconds": 0,
  • "network.ingress.proxy_buffering": "string",
  • "network.ingress.proxy_request_buffering": "string",
  • "network.ingress.grpc_send_timeout_seconds": 0,
  • "network.ingress.grpc_read_timeout_seconds": 0,
  • "network.ingress.whitelist_source_range": "string",
  • "network.ingress.denylist_source_range": "string",
  • "network.ingress.extra_headers": "{\"X-Frame-Options\":\"DENY \",\"X-Content-Type-Options\":\"nosniff\"}",
  • "network.ingress.basic_auth_env_var": "string",
  • "network.ingress.enable_sticky_session": true
}

List helms

Authorizations:
bearerAuthApiKeyAuth
path Parameters
environmentId
required
string <uuid>

Environment ID

@@ -3874,7 +3874,7 @@

Response samples

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

Create a helm

Authorizations:
bearerAuthApiKeyAuth
path Parameters
environmentId
required
string <uuid>

Environment ID

+

Response samples

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

Create a helm

Authorizations:
bearerAuthApiKeyAuth
path Parameters
environmentId
required
string <uuid>

Environment ID

Request Body schema: application/json
Array of objects or objects
name
required
string

name is case insensitive

description
string
timeout_sec
integer >= 0
Default: 600

Maximum number of seconds allowed for helm to run before killing it and mark it as failed

auto_preview
boolean or null

Indicates if the 'environment preview option' is enabled.
If enabled, a preview environment will be automatically cloned when /preview endpoint is called or when a new commit is updated. @@ -3891,7 +3891,7 @@

Request samples

Content type
application/json
{
  • "ports": [
    ],
  • "name": "string",
  • "description": "string",
  • "timeout_sec": 600,
  • "auto_preview": true,
  • "auto_deploy": true,
  • "source": {},
  • "arguments": [
    ],
  • "allow_cluster_wide_resources": false,
  • "values_override": {
    },
  • "icon_uri": "http://example.com"
}

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": {
    },
  • "name": "string",
  • "description": "string",
  • "timeout_sec": 600,
  • "auto_preview": true,
  • "auto_deploy": true,
  • "ports": [
    ],
  • "source": {
    },
  • "arguments": [
    ],
  • "allow_cluster_wide_resources": false,
  • "values_override": {
    },
  • "icon_uri": "http://example.com",
  • "serviceType": "APPLICATION"
}

Get helm default values

Authorizations:
bearerAuthApiKeyAuth
path Parameters
environmentId
required
string <uuid>

Environment ID

+

Request samples

Content type
application/json
{
  • "ports": [
    ],
  • "name": "string",
  • "description": "string",
  • "timeout_sec": 600,
  • "auto_preview": true,
  • "auto_deploy": true,
  • "source": {},
  • "arguments": [
    ],
  • "allow_cluster_wide_resources": false,
  • "values_override": {
    },
  • "icon_uri": "http://example.com"
}

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": {
    },
  • "name": "string",
  • "description": "string",
  • "timeout_sec": 600,
  • "auto_preview": true,
  • "auto_deploy": true,
  • "ports": [
    ],
  • "source": {
    },
  • "arguments": [
    ],
  • "allow_cluster_wide_resources": false,
  • "values_override": {
    },
  • "icon_uri": "http://example.com",
  • "service_type": "APPLICATION"
}

Get helm default values

Authorizations:
bearerAuthApiKeyAuth
path Parameters
environmentId
required
string <uuid>

Environment ID

Request Body schema: application/json
required
object or object

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "environment_id": "40ef0e48-a11f-4963-a229-e396c9f7e7c4"
}

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": {
    },
  • "name": "string",
  • "description": "string",
  • "timeout_sec": 600,
  • "auto_preview": true,
  • "auto_deploy": true,
  • "ports": [
    ],
  • "source": {
    },
  • "arguments": [
    ],
  • "allow_cluster_wide_resources": false,
  • "values_override": {
    },
  • "icon_uri": "http://example.com",
  • "serviceType": "APPLICATION"
}

Environment Actions

Deploy environment

This will deploy all the services of this environment to their latest version.

+

Request samples

Content type
application/json
{
  • "name": "string",
  • "environment_id": "40ef0e48-a11f-4963-a229-e396c9f7e7c4"
}

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": {
    },
  • "name": "string",
  • "description": "string",
  • "timeout_sec": 600,
  • "auto_preview": true,
  • "auto_deploy": true,
  • "ports": [
    ],
  • "source": {
    },
  • "arguments": [
    ],
  • "allow_cluster_wide_resources": false,
  • "values_override": {
    },
  • "icon_uri": "http://example.com",
  • "service_type": "APPLICATION"
}

Environment Actions

Deploy environment

This will deploy all the services of this environment to their latest version.

Authorizations:
bearerAuthApiKeyAuth
path Parameters
environmentId
required
string <uuid>

Environment 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": {
    },
  • "git_repository": {
    },
  • "maximum_cpu": 16000,
  • "maximum_memory": 16384,
  • "name": "string",
  • "description": "string",
  • "build_mode": "DOCKER",
  • "dockerfile_path": "string",
  • "cpu": 1250,
  • "memory": 1024,
  • "min_running_instances": 1,
  • "max_running_instances": 1,
  • "healthchecks": {
    },
  • "auto_preview": true,
  • "ports": [
    ],
  • "arguments": [
    ],
  • "entrypoint": "string",
  • "auto_deploy": true,
  • "annotations_groups": [
    ],
  • "labels_groups": [
    ],
  • "icon_uri": "http://example.com",
  • "serviceType": "APPLICATION"
}

Edit application

    +

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": {
    },
  • "git_repository": {
    },
  • "maximum_cpu": 16000,
  • "maximum_memory": 16384,
  • "name": "string",
  • "description": "string",
  • "build_mode": "DOCKER",
  • "dockerfile_path": "string",
  • "cpu": 1250,
  • "memory": 1024,
  • "min_running_instances": 1,
  • "max_running_instances": 1,
  • "healthchecks": {
    },
  • "auto_preview": true,
  • "ports": [
    ],
  • "arguments": [
    ],
  • "entrypoint": "string",
  • "auto_deploy": true,
  • "annotations_groups": [
    ],
  • "labels_groups": [
    ],
  • "icon_uri": "http://example.com",
  • "service_type": "APPLICATION"
}

Edit application

  • To edit the application you must have the admin permission.
  • For port edition, if you provide a port id, we will update the corresponding port. If you don't we will create a new one. If you remove a port from the payload, we will delete it.
  • For storage edition, if you provide a storage id, we 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.
    • @@ -4262,7 +4262,7 @@

Request samples

Content type
application/json
{
  • "storage": [
    ],
  • "name": "string",
  • "description": "string",
  • "git_repository": {},
  • "build_mode": "DOCKER",
  • "dockerfile_path": "string",
  • "cpu": 1250,
  • "memory": 1024,
  • "min_running_instances": 1,
  • "max_running_instances": 1,
  • "healthchecks": {
    },
  • "auto_preview": true,
  • "ports": [
    ],
  • "arguments": [
    ],
  • "entrypoint": "string",
  • "auto_deploy": true,
  • "annotations_groups": [
    ],
  • "labels_groups": [
    ],
  • "icon_uri": "http://example.com"
}

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": {
    },
  • "git_repository": {
    },
  • "maximum_cpu": 16000,
  • "maximum_memory": 16384,
  • "name": "string",
  • "description": "string",
  • "build_mode": "DOCKER",
  • "dockerfile_path": "string",
  • "cpu": 1250,
  • "memory": 1024,
  • "min_running_instances": 1,
  • "max_running_instances": 1,
  • "healthchecks": {
    },
  • "auto_preview": true,
  • "ports": [
    ],
  • "arguments": [
    ],
  • "entrypoint": "string",
  • "auto_deploy": true,
  • "annotations_groups": [
    ],
  • "labels_groups": [
    ],
  • "icon_uri": "http://example.com",
  • "serviceType": "APPLICATION"
}

Delete application

To delete the application you must have the admin permission

+

Request samples

Content type
application/json
{
  • "storage": [
    ],
  • "name": "string",
  • "description": "string",
  • "git_repository": {},
  • "build_mode": "DOCKER",
  • "dockerfile_path": "string",
  • "cpu": 1250,
  • "memory": 1024,
  • "min_running_instances": 1,
  • "max_running_instances": 1,
  • "healthchecks": {
    },
  • "auto_preview": true,
  • "ports": [
    ],
  • "arguments": [
    ],
  • "entrypoint": "string",
  • "auto_deploy": true,
  • "annotations_groups": [
    ],
  • "labels_groups": [
    ],
  • "icon_uri": "http://example.com"
}

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": {
    },
  • "git_repository": {
    },
  • "maximum_cpu": 16000,
  • "maximum_memory": 16384,
  • "name": "string",
  • "description": "string",
  • "build_mode": "DOCKER",
  • "dockerfile_path": "string",
  • "cpu": 1250,
  • "memory": 1024,
  • "min_running_instances": 1,
  • "max_running_instances": 1,
  • "healthchecks": {
    },
  • "auto_preview": true,
  • "ports": [
    ],
  • "arguments": [
    ],
  • "entrypoint": "string",
  • "auto_deploy": true,
  • "annotations_groups": [
    ],
  • "labels_groups": [
    ],
  • "icon_uri": "http://example.com",
  • "service_type": "APPLICATION"
}

Delete application

To delete the application you must have the admin permission

Authorizations:
bearerAuthApiKeyAuth
path Parameters
applicationId
required
string <uuid>

Application 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": [
    ],
  • "image_name": "string",
  • "tag": "string",
  • "registry_id": "string",
  • "registry": {
    },
  • "environment": {
    },
  • "maximum_cpu": 16000,
  • "maximum_memory": 16384,
  • "name": "string",
  • "description": "string",
  • "arguments": [
    ],
  • "entrypoint": "string",
  • "cpu": 1250,
  • "memory": 1024,
  • "min_running_instances": 1,
  • "max_running_instances": 1,
  • "healthchecks": {
    },
  • "auto_preview": true,
  • "ports": [
    ],
  • "auto_deploy": true,
  • "annotations_groups": [
    ],
  • "labels_groups": [
    ],
  • "icon_uri": "http://example.com",
  • "serviceType": "APPLICATION"
}

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": [
    ],
  • "image_name": "string",
  • "tag": "string",
  • "registry_id": "string",
  • "registry": {
    },
  • "environment": {
    },
  • "maximum_cpu": 16000,
  • "maximum_memory": 16384,
  • "name": "string",
  • "description": "string",
  • "arguments": [
    ],
  • "entrypoint": "string",
  • "cpu": 1250,
  • "memory": 1024,
  • "min_running_instances": 1,
  • "max_running_instances": 1,
  • "healthchecks": {
    },
  • "auto_preview": true,
  • "ports": [
    ],
  • "auto_deploy": true,
  • "annotations_groups": [
    ],
  • "labels_groups": [
    ],
  • "icon_uri": "http://example.com",
  • "service_type": "APPLICATION"
}

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.
    • @@ -4694,7 +4694,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,
  • "auto_deploy": true,
  • "annotations_groups": [
    ],
  • "labels_groups": [
    ],
  • "icon_uri": "http://example.com"
}

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": [
    ],
  • "image_name": "string",
  • "tag": "string",
  • "registry_id": "string",
  • "registry": {
    },
  • "environment": {
    },
  • "maximum_cpu": 16000,
  • "maximum_memory": 16384,
  • "name": "string",
  • "description": "string",
  • "arguments": [
    ],
  • "entrypoint": "string",
  • "cpu": 1250,
  • "memory": 1024,
  • "min_running_instances": 1,
  • "max_running_instances": 1,
  • "healthchecks": {
    },
  • "auto_preview": true,
  • "ports": [
    ],
  • "auto_deploy": true,
  • "annotations_groups": [
    ],
  • "labels_groups": [
    ],
  • "icon_uri": "http://example.com",
  • "serviceType": "APPLICATION"
}

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,
  • "auto_deploy": true,
  • "annotations_groups": [
    ],
  • "labels_groups": [
    ],
  • "icon_uri": "http://example.com"
}

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": [
    ],
  • "image_name": "string",
  • "tag": "string",
  • "registry_id": "string",
  • "registry": {
    },
  • "environment": {
    },
  • "maximum_cpu": 16000,
  • "maximum_memory": 16384,
  • "name": "string",
  • "description": "string",
  • "arguments": [
    ],
  • "entrypoint": "string",
  • "cpu": 1250,
  • "memory": 1024,
  • "min_running_instances": 1,
  • "max_running_instances": 1,
  • "healthchecks": {
    },
  • "auto_preview": true,
  • "ports": [
    ],
  • "auto_deploy": true,
  • "annotations_groups": [
    ],
  • "labels_groups": [
    ],
  • "icon_uri": "http://example.com",
  • "service_type": "APPLICATION"
}

Delete container

To delete the container you must have the admin permission

Authorizations:
bearerAuthApiKeyAuth
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",
  • "name": "string",
  • "description": "string",
  • "type": "MONGODB",
  • "version": "10.1",
  • "mode": "CONTAINER",
  • "accessibility": "PRIVATE",
  • "cpu": 1250,
  • "instance_type": "db.t3.medium",
  • "memory": 1024,
  • "storage": 10,
  • "annotations_groups": [
    ],
  • "labels_groups": [
    ],
  • "icon_uri": "http://example.com",
  • "environment": {
    },
  • "host": "string",
  • "port": 5432,
  • "maximum_cpu": 1250,
  • "maximum_memory": 1024,
  • "disk_encrypted": true,
  • "serviceType": "APPLICATION"
}

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,
  • "annotations_groups": [
    ],
  • "labels_groups": [
    ],
  • "icon_uri": "http://example.com",
  • "environment": {
    },
  • "host": "string",
  • "port": 5432,
  • "maximum_cpu": 1250,
  • "maximum_memory": 1024,
  • "disk_encrypted": true,
  • "service_type": "APPLICATION"
}

Edit a database

To edit a database you must have the admin permission

Authorizations:
bearerAuthApiKeyAuth
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

@@ -5070,7 +5070,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",
  • "annotations_groups": [
    ],
  • "labels_groups": [
    ],
  • "icon_uri": "http://example.com"
}

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,
  • "annotations_groups": [
    ],
  • "labels_groups": [
    ],
  • "icon_uri": "http://example.com",
  • "environment": {
    },
  • "host": "string",
  • "port": 5432,
  • "maximum_cpu": 1250,
  • "maximum_memory": 1024,
  • "disk_encrypted": true,
  • "serviceType": "APPLICATION"
}

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",
  • "annotations_groups": [
    ],
  • "labels_groups": [
    ],
  • "icon_uri": "http://example.com"
}

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,
  • "annotations_groups": [
    ],
  • "labels_groups": [
    ],
  • "icon_uri": "http://example.com",
  • "environment": {
    },
  • "host": "string",
  • "port": 5432,
  • "maximum_cpu": 1250,
  • "maximum_memory": 1024,
  • "disk_encrypted": true,
  • "service_type": "APPLICATION"
}

Delete a database

To delete a database you must have the admin permission

Authorizations:
bearerAuthApiKeyAuth
path Parameters
databaseId
required
string <uuid>

Database ID

Responses

Response samples

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

Remove an application from this database

Authorizations:
bearerAuthApiKeyAuth
path Parameters
databaseId
required
string <uuid>

Database ID

+

Response samples

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

Remove an application from this database

Authorizations:
bearerAuthApiKeyAuth
path Parameters
databaseId
required
string <uuid>

Database ID

targetApplicationId
required
string <uuid>

Target application ID

Responses

Response samples

Content type
application/json
Example
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "environment": {
    },
  • "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": {
    },
  • "auto_deploy": true,
  • "icon_uri": "http://example.com",
  • "serviceType": "APPLICATION",
  • "job_type": "LIFECYCLE",
  • "schedule": {
    },
  • "annotations_groups": [
    ],
  • "labels_groups": [
    ]
}

Edit job

    +

Response samples

Content type
application/json
Example
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "environment": {
    },
  • "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": {
    },
  • "auto_deploy": true,
  • "icon_uri": "http://example.com",
  • "service_type": "APPLICATION",
  • "job_type": "LIFECYCLE",
  • "schedule": {
    },
  • "annotations_groups": [
    ],
  • "labels_groups": [
    ]
}

Edit job

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

Job ID

@@ -5192,7 +5192,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": {
    },
  • "auto_deploy": true,
  • "annotations_groups": [
    ],
  • "labels_groups": [
    ],
  • "icon_uri": "http://example.com"
}

Response samples

Content type
application/json
Example
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "environment": {
    },
  • "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": {
    },
  • "auto_deploy": true,
  • "icon_uri": "http://example.com",
  • "serviceType": "APPLICATION",
  • "job_type": "LIFECYCLE",
  • "schedule": {
    },
  • "annotations_groups": [
    ],
  • "labels_groups": [
    ]
}

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": {
    },
  • "auto_deploy": true,
  • "annotations_groups": [
    ],
  • "labels_groups": [
    ],
  • "icon_uri": "http://example.com"
}

Response samples

Content type
application/json
Example
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "environment": {
    },
  • "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": {
    },
  • "auto_deploy": true,
  • "icon_uri": "http://example.com",
  • "service_type": "APPLICATION",
  • "job_type": "LIFECYCLE",
  • "schedule": {
    },
  • "annotations_groups": [
    ],
  • "labels_groups": [
    ]
}

Delete job

To delete the job you must have the admin permission

Authorizations:
bearerAuthApiKeyAuth
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": {
    },
  • "name": "string",
  • "description": "string",
  • "timeout_sec": 600,
  • "auto_preview": true,
  • "auto_deploy": true,
  • "ports": [
    ],
  • "source": {
    },
  • "arguments": [
    ],
  • "allow_cluster_wide_resources": false,
  • "values_override": {
    },
  • "icon_uri": "http://example.com",
  • "serviceType": "APPLICATION"
}

Edit helm

    +

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": {
    },
  • "name": "string",
  • "description": "string",
  • "timeout_sec": 600,
  • "auto_preview": true,
  • "auto_deploy": true,
  • "ports": [
    ],
  • "source": {
    },
  • "arguments": [
    ],
  • "allow_cluster_wide_resources": false,
  • "values_override": {
    },
  • "icon_uri": "http://example.com",
  • "service_type": "APPLICATION"
}

Edit helm

  • To edit the helm you must have the admin permission.
Authorizations:
bearerAuthApiKeyAuth
path Parameters
helmId
required
string <uuid>

Helm ID

@@ -5486,7 +5486,7 @@

Request samples

Content type
application/json
{
  • "ports": [
    ],
  • "name": "string",
  • "description": "string",
  • "timeout_sec": 600,
  • "auto_preview": true,
  • "auto_deploy": true,
  • "source": {},
  • "arguments": [
    ],
  • "allow_cluster_wide_resources": false,
  • "values_override": {
    },
  • "icon_uri": "http://example.com"
}

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": {
    },
  • "name": "string",
  • "description": "string",
  • "timeout_sec": 600,
  • "auto_preview": true,
  • "auto_deploy": true,
  • "ports": [
    ],
  • "source": {
    },
  • "arguments": [
    ],
  • "allow_cluster_wide_resources": false,
  • "values_override": {
    },
  • "icon_uri": "http://example.com",
  • "serviceType": "APPLICATION"
}

Delete helm

To delete the helm you must have the admin permission

+

Request samples

Content type
application/json
{
  • "ports": [
    ],
  • "name": "string",
  • "description": "string",
  • "timeout_sec": 600,
  • "auto_preview": true,
  • "auto_deploy": true,
  • "source": {},
  • "arguments": [
    ],
  • "allow_cluster_wide_resources": false,
  • "values_override": {
    },
  • "icon_uri": "http://example.com"
}

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": {
    },
  • "name": "string",
  • "description": "string",
  • "timeout_sec": 600,
  • "auto_preview": true,
  • "auto_deploy": true,
  • "ports": [
    ],
  • "source": {
    },
  • "arguments": [
    ],
  • "allow_cluster_wide_resources": false,
  • "values_override": {
    },
  • "icon_uri": "http://example.com",
  • "service_type": "APPLICATION"
}

Delete helm

To delete the helm you must have the admin permission

Authorizations:
bearerAuthApiKeyAuth
path Parameters
helmId
required
string <uuid>

Helm ID

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,
  • "infrastructure_hosting": "string"
}