ListAppTemplates
List app templates
Authorizations:
query Parameters
page | integer A page number within the paginated result set. |
page_size | integer Number of results to return per page. |
Responses
Response samples
- 200
{- "count": 0,
- "results": [
- {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "identifier": "string",
- "name": "string",
- "short_description": "string",
- "is_default": true,
- "order": -2147483648
}
]
}
GetAppTemplate
Get the details of a single app template
Authorizations:
path Parameters
uuid required | string <uuid> A UUID string identifying this app template. |
Responses
Response samples
- 200
{- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "identifier": "string",
- "name": "string",
- "short_description": "string",
- "is_default": true,
- "order": -2147483648,
- "release_commands": [
- {
- "label": "string",
- "command": "string"
}
], - "services": [
- {
- "identifier": "string",
- "prefix": "string"
}
], - "tags": [
- {
- "name": "string",
- "value": "string"
}
]
}
ListApplicationActivities
List application activities
Authorizations:
query Parameters
application | string |
organisation | string |
type | string |
user_name | string |
page | integer A page number within the paginated result set. |
page_size | integer Number of results to return per page. |
avatar_size | string |
Responses
Response samples
- 200
{- "count": 0,
- "results": [
- {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "application": "2b22d485-f04e-492b-b364-e14f8506726a",
- "organisation": "a4b97354-4e56-4723-bc0e-1f22b5fcbed6",
- "created_at": "2019-08-24T14:15:22Z",
- "user": "76f62a58-5404-486d-9afc-07bded328704",
- "impersonated": true,
- "description": "string",
- "type": "string",
- "context": { },
- "user_name": "string",
- "user_email": "string",
- "user_is_removed": true
}
]
}
GetApplicationActivity
Get the details of a single application activity
Authorizations:
path Parameters
uuid required | string <uuid> |
Responses
Response samples
- 200
{- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "application": "2b22d485-f04e-492b-b364-e14f8506726a",
- "organisation": "a4b97354-4e56-4723-bc0e-1f22b5fcbed6",
- "created_at": "2019-08-24T14:15:22Z",
- "user": "76f62a58-5404-486d-9afc-07bded328704",
- "impersonated": true,
- "description": "string",
- "type": "string",
- "context": { },
- "user_name": "string",
- "user_email": "string",
- "user_is_removed": true
}
ListApplicationCollaborators
List application collaborators
Authorizations:
query Parameters
application | string |
organisation | string |
membership | string |
page | integer A page number within the paginated result set. |
page_size | integer Number of results to return per page. |
Responses
Response samples
- 200
{- "count": 0,
- "results": [
- {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "application": "2b22d485-f04e-492b-b364-e14f8506726a",
- "membership": "b8ce8f5d-49a7-404e-a63d-be641c3bd8d7"
}
]
}
CreateApplicationCollaborator
Create a new application collaborator object
Authorizations:
Request Body schema: application/jsonrequired
application required | string <uuid> (Application) |
membership required | string <uuid> (Membership) |
Responses
Request samples
- Payload
{- "application": "2b22d485-f04e-492b-b364-e14f8506726a",
- "membership": "b8ce8f5d-49a7-404e-a63d-be641c3bd8d7"
}
Response samples
- 201
{- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "application": "2b22d485-f04e-492b-b364-e14f8506726a",
- "membership": "b8ce8f5d-49a7-404e-a63d-be641c3bd8d7"
}
GetApplicationCollaborator
Get the details of a single application collaborator
Authorizations:
path Parameters
uuid required | string <uuid> |
Responses
Response samples
- 200
{- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "application": "2b22d485-f04e-492b-b364-e14f8506726a",
- "membership": "b8ce8f5d-49a7-404e-a63d-be641c3bd8d7"
}
ListApplications
List applications
Authorizations:
query Parameters
organisation | string |
is_undergoing_maintenance | boolean |
uuid | Array of strings |
name_search | string |
copied_from | string |
copy_type | string Enum: "COPY" "FORK" "MIRROR" |
slug | string |
is_mirror | boolean |
has_bugs | boolean |
requires_migration | boolean |
is_suspended | boolean |
tags | string |
o | string Enum: "name" "-name" "created_at" "-created_at" |
page | integer A page number within the paginated result set. |
page_size | integer Number of results to return per page. |
screenshot_sizes | string |
avatar_sizes | string |
Responses
Response samples
- 200
{- "count": 0,
- "results": [
- {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "slug": "string",
- "name": "string",
- "organisation": "a4b97354-4e56-4723-bc0e-1f22b5fcbed6",
- "region": "ac2f330e-0351-4cac-b9d3-953e54b3d1f8",
- "repository": "e3d1beef-8819-44ce-aeb0-6d1f16e4ee3b",
- "is_suspended": true,
- "suspended_reason": "string",
- "is_undergoing_maintenance": true,
- "maintenance_reason": "string",
- "copy_type": "COPY",
- "is_repository_read_only": true,
- "release_commands": [
- {
- "label": "string",
- "command": "string"
}
], - "has_annotations": true,
- "updates_available": true,
- "created_at": "2019-08-24T14:15:22Z",
- "active_subscription": "string",
- "tags": [
- {
- "name": "string",
- "value": "string"
}
]
}
]
}
CreateApplication
Create a new application object
Authorizations:
Request Body schema: application/jsonrequired
name required | string (Name) non-empty |
region required | string <uuid> (Region) |
app_template | string or null <uri> (App template) non-empty |
organisation required | string <uuid> (Organisation) |
plan_group required | string <uuid> (Plan group) |
repository | string or null <uuid> (Repository) |
branch | string (Branch) non-empty Default: "main" |
repository_prepopulated | boolean (Repository prepopulated) Default: false |
Array of objects or null (ReleaseCommand) | |
slug required | string (Slug) non-empty |
Array of objects (TagField) <= 50 items | |
disk | integer (Disk) |
transfer | integer (Transfer) |
Array of objects or null (ContainerStructure) |
Responses
Request samples
- Payload
{- "name": "string",
- "region": "ac2f330e-0351-4cac-b9d3-953e54b3d1f8",
- "organisation": "a4b97354-4e56-4723-bc0e-1f22b5fcbed6",
- "plan_group": "5c37c648-ad61-4e47-8032-3d80ebb8db75",
- "repository": "e3d1beef-8819-44ce-aeb0-6d1f16e4ee3b",
- "branch": "main",
- "repository_prepopulated": false,
- "release_commands": [
- {
- "label": "string",
- "command": "string"
}
], - "slug": "string",
- "tags": [
- {
- "name": "string",
- "value": "string"
}
], - "disk": 0,
- "transfer": 0,
- "container_structure": [
- {
- "spec": "string",
- "type": "string",
- "command": "string",
- "replicas": 1
}
]
}
Response samples
- 201
- 403
{- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "region": "ac2f330e-0351-4cac-b9d3-953e54b3d1f8",
- "organisation": "a4b97354-4e56-4723-bc0e-1f22b5fcbed6",
- "plan_group": "5c37c648-ad61-4e47-8032-3d80ebb8db75",
- "repository": "e3d1beef-8819-44ce-aeb0-6d1f16e4ee3b",
- "branch": "main",
- "repository_prepopulated": false,
- "release_commands": [
- {
- "label": "string",
- "command": "string"
}
], - "slug": "string",
- "tags": [
- {
- "name": "string",
- "value": "string"
}
], - "disk": 0,
- "transfer": 0,
- "container_structure": [
- {
- "spec": "string",
- "type": "string",
- "command": "string",
- "replicas": 1
}
]
}
GetApplication
Get the details of a single application
Authorizations:
path Parameters
uuid required | string <uuid> |
query Parameters
screenshot_sizes | string |
avatar_sizes | string |
Responses
Response samples
- 200
{- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "slug": "string",
- "name": "string",
- "organisation": "a4b97354-4e56-4723-bc0e-1f22b5fcbed6",
- "region": "ac2f330e-0351-4cac-b9d3-953e54b3d1f8",
- "repository": "e3d1beef-8819-44ce-aeb0-6d1f16e4ee3b",
- "is_suspended": true,
- "suspended_reason": "string",
- "is_undergoing_maintenance": true,
- "maintenance_reason": "string",
- "copy_type": "COPY",
- "is_repository_read_only": true,
- "release_commands": [
- {
- "label": "string",
- "command": "string"
}
], - "has_annotations": true,
- "updates_available": true,
- "created_at": "2019-08-24T14:15:22Z",
- "active_subscription": "string",
- "tags": [
- {
- "name": "string",
- "value": "string"
}
], - "copied_from": "b357c0e3-12ee-40ba-98e2-dcf185d29328",
- "screenshot_taken_at": "2019-08-24T14:15:22Z",
- "maintenance_window_start": 2147483647,
- "maintenance_window_duration": 2147483647,
- "unconfirmed_subscription": "string",
- "support_level": "string",
- "mirrors_count": 0,
- "upcoming_maintenances_count": 0,
- "port": 0,
- "startup_probe_max_retries": 0,
- "startup_probe_request_timeout": 0,
- "startup_probe_retry_timeout": 0,
- "requires_migration": "string",
- "requires_migration_to": "74d37c0e-ec63-4b3c-9571-b6efd1773b80",
- "is_locked": true,
- "features": [
- "string"
], - "permissions": [
- "string"
]
}
UpdateApplication
Replace the specified application
Authorizations:
path Parameters
uuid required | string <uuid> |
Request Body schema: application/jsonrequired
name required | string (Name) [ 1 .. 255 ] characters |
maintenance_window_start | integer (Maintenance window start) [ 0 .. 2147483647 ] |
maintenance_window_duration | integer (Maintenance window duration) [ 0 .. 2147483647 ] |
Array of objects (ReleaseCommand) | |
port | integer or null (Port) [ 0 .. 2147483647 ] |
startup_probe_max_retries | integer (Startup probe max retries) [ 1 .. 1000 ] |
startup_probe_request_timeout | integer (Startup probe request timeout) [ 1 .. 60 ] |
startup_probe_retry_timeout | integer (Startup probe retry timeout) [ 1 .. 600 ] |
Array of objects (TagField) <= 50 items |
Responses
Request samples
- Payload
{- "name": "string",
- "maintenance_window_start": 2147483647,
- "maintenance_window_duration": 2147483647,
- "release_commands": [
- {
- "label": "string",
- "command": "string"
}
], - "port": 2147483647,
- "startup_probe_max_retries": 1,
- "startup_probe_request_timeout": 1,
- "startup_probe_retry_timeout": 1,
- "tags": [
- {
- "name": "string",
- "value": "string"
}
]
}
Response samples
- 200
{- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "maintenance_window_start": 2147483647,
- "maintenance_window_duration": 2147483647,
- "release_commands": [
- {
- "label": "string",
- "command": "string"
}
], - "port": 2147483647,
- "startup_probe_max_retries": 1,
- "startup_probe_request_timeout": 1,
- "startup_probe_retry_timeout": 1,
- "tags": [
- {
- "name": "string",
- "value": "string"
}
]
}
PartialUpdateApplication
Partially update the specified application
Authorizations:
path Parameters
uuid required | string <uuid> |
Request Body schema: application/jsonrequired
name required | string (Name) [ 1 .. 255 ] characters |
maintenance_window_start | integer (Maintenance window start) [ 0 .. 2147483647 ] |
maintenance_window_duration | integer (Maintenance window duration) [ 0 .. 2147483647 ] |
Array of objects (ReleaseCommand) | |
port | integer or null (Port) [ 0 .. 2147483647 ] |
startup_probe_max_retries | integer (Startup probe max retries) [ 1 .. 1000 ] |
startup_probe_request_timeout | integer (Startup probe request timeout) [ 1 .. 60 ] |
startup_probe_retry_timeout | integer (Startup probe retry timeout) [ 1 .. 600 ] |
Array of objects (TagField) <= 50 items |
Responses
Request samples
- Payload
{- "name": "string",
- "maintenance_window_start": 2147483647,
- "maintenance_window_duration": 2147483647,
- "release_commands": [
- {
- "label": "string",
- "command": "string"
}
], - "port": 2147483647,
- "startup_probe_max_retries": 1,
- "startup_probe_request_timeout": 1,
- "startup_probe_retry_timeout": 1,
- "tags": [
- {
- "name": "string",
- "value": "string"
}
]
}
Response samples
- 200
{- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "maintenance_window_start": 2147483647,
- "maintenance_window_duration": 2147483647,
- "release_commands": [
- {
- "label": "string",
- "command": "string"
}
], - "port": 2147483647,
- "startup_probe_max_retries": 1,
- "startup_probe_request_timeout": 1,
- "startup_probe_retry_timeout": 1,
- "tags": [
- {
- "name": "string",
- "value": "string"
}
]
}
DestroyApplication
Delete the specified application
Authorizations:
path Parameters
uuid required | string <uuid> |
Request Body schema: application/jsonrequired
verify_name required | string (Verify name) non-empty |
Responses
Request samples
- Payload
{- "verify_name": "string"
}
Response samples
- 200
- 403
{- "status": true,
- "message": "string",
- "code": "string"
}
CopyApplication
Authorizations:
path Parameters
uuid required | string <uuid> |
Request Body schema: application/jsonrequired
target_name required | string (Target name) non-empty |
target_organisation required | string <uuid> (Target organisation) |
type required | string (Type) Enum: "FORK" "MIRROR" |
Responses
Request samples
- Payload
{- "target_name": "string",
- "target_organisation": "1ba5f218-3c9c-4588-ba61-f31e797a3b6f",
- "type": "FORK"
}
Response samples
- 200
{- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "slug": "string",
- "name": "string",
- "organisation": "a4b97354-4e56-4723-bc0e-1f22b5fcbed6",
- "region": "ac2f330e-0351-4cac-b9d3-953e54b3d1f8",
- "repository": "e3d1beef-8819-44ce-aeb0-6d1f16e4ee3b",
- "is_suspended": true,
- "suspended_reason": "string",
- "is_undergoing_maintenance": true,
- "maintenance_reason": "string",
- "copy_type": "COPY",
- "is_repository_read_only": true,
- "release_commands": [
- {
- "label": "string",
- "command": "string"
}
], - "has_annotations": true,
- "updates_available": true,
- "created_at": "2019-08-24T14:15:22Z",
- "active_subscription": "string",
- "tags": [
- {
- "name": "string",
- "value": "string"
}
], - "copied_from": "b357c0e3-12ee-40ba-98e2-dcf185d29328",
- "screenshot_taken_at": "2019-08-24T14:15:22Z",
- "maintenance_window_start": 2147483647,
- "maintenance_window_duration": 2147483647,
- "unconfirmed_subscription": "string",
- "support_level": "string",
- "mirrors_count": 0,
- "upcoming_maintenances_count": 0,
- "port": 0,
- "startup_probe_max_retries": 0,
- "startup_probe_request_timeout": 0,
- "startup_probe_retry_timeout": 0,
- "requires_migration": "string",
- "requires_migration_to": "74d37c0e-ec63-4b3c-9571-b6efd1773b80",
- "is_locked": true,
- "features": [
- "string"
], - "permissions": [
- "string"
]
}
MigrateApplicationToExternalRepository
Migrates an application to an external repository.
Authorizations:
path Parameters
uuid required | string <uuid> |
Request Body schema: application/jsonrequired
repository required | string <uuid> (Repository) |
Responses
Request samples
- Payload
{- "repository": "e3d1beef-8819-44ce-aeb0-6d1f16e4ee3b"
}
Response samples
- 200
- 202
{- "status": true,
- "message": "string",
- "code": "string"
}
TransferApplication
Authorizations:
path Parameters
uuid required | string <uuid> |
Request Body schema: application/jsonrequired
organisation required | string <uuid> (Organisation) |
Responses
Request samples
- Payload
{- "organisation": "a4b97354-4e56-4723-bc0e-1f22b5fcbed6"
}
Response samples
- 200
{- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "organisation": "a4b97354-4e56-4723-bc0e-1f22b5fcbed6"
}
ListBackupDownloadServiceInstances
List backup download service instances
Authorizations:
query Parameters
backup_download | string |
service_instance_backup | string |
page | integer A page number within the paginated result set. |
page_size | integer Number of results to return per page. |
Responses
Response samples
- 200
{- "count": 0,
- "results": [
- {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "backup_download": "9588f5ec-96c6-4b5e-a1a5-0ca7c8bee2ac",
- "service_instance_backup": "4161e5a6-3fef-4502-a0fe-dd044768b370"
}
]
}
GetBackupDownloadServiceInstance
Get the details of a single backup download service instance
Authorizations:
path Parameters
uuid required | string |
Responses
Response samples
- 200
{- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "backup_download": "9588f5ec-96c6-4b5e-a1a5-0ca7c8bee2ac",
- "service_instance_backup": "4161e5a6-3fef-4502-a0fe-dd044768b370",
- "queued_at": "2019-08-24T14:15:22Z",
- "started_at": "2019-08-24T14:15:22Z",
- "ended_at": "2019-08-24T14:15:22Z",
- "errors": [
- "string"
]
}
ListBackupDownloads
List backup downloads
Authorizations:
query Parameters
page | integer A page number within the paginated result set. |
page_size | integer Number of results to return per page. |
Responses
Response samples
- 200
{- "count": 0,
- "results": [
- {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "backup": "dbd9d221-8e93-4901-bb73-e2d59863aa61",
- "author": "string"
}
]
}
CreateBackupDownload
Create a new backup download object
Authorizations:
Request Body schema: application/jsonrequired
backup required | string <uuid> (Backup) |
trigger required | string (Trigger) Enum: "MANUAL" "PULL" |
service_instance_backups required | Array of strings <uuid> unique [ items <uuid > ] |
Responses
Request samples
- Payload
{- "backup": "dbd9d221-8e93-4901-bb73-e2d59863aa61",
- "trigger": "MANUAL",
- "service_instance_backups": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
Response samples
- 202
{- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "backup": "dbd9d221-8e93-4901-bb73-e2d59863aa61",
- "trigger": "MANUAL",
- "service_instance_backups": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
GetBackupDownload
Get the details of a single backup download
Authorizations:
path Parameters
uuid required | string |
Responses
Response samples
- 200
{- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "backup": "dbd9d221-8e93-4901-bb73-e2d59863aa61",
- "author": "string",
- "started_at": "2019-08-24T14:15:22Z",
- "trigger": "MANUAL"
}
ListBackupRestores
List backup restores
Authorizations:
query Parameters
environment | string |
page | integer A page number within the paginated result set. |
page_size | integer Number of results to return per page. |
Responses
Response samples
- 200
{- "count": 0,
- "results": [
- {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "environment": "fafd1151-c401-4fdd-ac01-03d8e7a57166",
- "backup": "string",
- "org_membership": "052d699a-f769-42f1-9cac-4bfd43f3660b",
- "started_at": "2019-08-24T14:15:22Z",
- "trigger": 0,
- "finished": "string",
- "success": "SUCCESS",
- "notes": "string",
- "service_instance_backup_restores": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
]
}
CreateBackupRestore
Create a new backup restore object
Authorizations:
Request Body schema: application/jsonrequired
backup required | string <uuid> (Backup) |
required | Array of objects (BackupRestoreServiceInstanceParams) |
notes | string (Notes) [ 1 .. 255 ] characters |
Responses
Request samples
- Payload
{- "backup": "dbd9d221-8e93-4901-bb73-e2d59863aa61",
- "service_instance_restores": [
- {
- "service_instance_backup": "4161e5a6-3fef-4502-a0fe-dd044768b370",
- "service_instance": "78fcb6d3-acaa-4596-a622-cccc1d676482"
}
], - "notes": "string"
}
Response samples
- 201
{- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "backup": "dbd9d221-8e93-4901-bb73-e2d59863aa61",
- "service_instance_restores": [
- {
- "service_instance_backup": "4161e5a6-3fef-4502-a0fe-dd044768b370",
- "service_instance": "78fcb6d3-acaa-4596-a622-cccc1d676482"
}
], - "notes": "string"
}
GetBackupRestore
Get the details of a single backup restore
Authorizations:
path Parameters
uuid required | string |
Responses
Response samples
- 200
{- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "environment": "fafd1151-c401-4fdd-ac01-03d8e7a57166",
- "backup": "string",
- "org_membership": "052d699a-f769-42f1-9cac-4bfd43f3660b",
- "started_at": "2019-08-24T14:15:22Z",
- "trigger": 0,
- "finished": "string",
- "success": "SUCCESS",
- "notes": "string",
- "service_instance_backup_restores": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
ListBackupRetentionConfigurations
List backup retention configurations
Authorizations:
query Parameters
page | integer A page number within the paginated result set. |
page_size | integer Number of results to return per page. |
Responses
Response samples
- 200
{- "count": 0,
- "results": [
- {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "identifier": "string",
- "short_description": "string"
}
]
}
GetBackupRetentionConfiguration
Get the details of a single backup retention configuration
Authorizations:
path Parameters
uuid required | string <uuid> |
Responses
Response samples
- 200
{- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "identifier": "string",
- "short_description": "string"
}
ListBackups
List backups
Authorizations:
query Parameters
environment | string |
page | integer A page number within the paginated result set. |
page_size | integer Number of results to return per page. |
Responses
Response samples
- 200
{- "count": 0,
- "results": [
- {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "environment": "fafd1151-c401-4fdd-ac01-03d8e7a57166",
- "org_membership": "052d699a-f769-42f1-9cac-4bfd43f3660b",
- "tags": [
- "string"
], - "created": "2019-08-24T14:15:22Z",
- "notes": "string",
- "state": "WAITING",
- "size": "string",
- "meta_information": { },
- "service_instance_backups": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "scheduled_for_deletion_at": "2019-08-24T14:15:22Z",
- "success": "SUCCESS"
}
]
}
CreateBackup
Create a new backup object
Authorizations:
Request Body schema: application/jsonrequired
environment required | string <uuid> (Environment) |
notes | string (Notes) <= 255 characters |
services required | Array of strings <uuid> unique [ items <uuid > ] |
scheduled_for_deletion_at | string or null <date-time> (Scheduled for deletion at) Timestamp of when this backup shall be effectively deleted from the system. |
Responses
Request samples
- Payload
{- "environment": "fafd1151-c401-4fdd-ac01-03d8e7a57166",
- "notes": "string",
- "services": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "scheduled_for_deletion_at": "2019-08-24T14:15:22Z"
}
Response samples
- 202
{- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "environment": "fafd1151-c401-4fdd-ac01-03d8e7a57166",
- "trigger": "MANUAL",
- "notes": "string",
- "services": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "scheduled_for_deletion_at": "2019-08-24T14:15:22Z"
}
UploadBackups
Request the necessary information to upload a local backup to divio.
The response contains one result entry per service instance UUID.
Each result entry defines a handler
type that determines the content of
the upload_parameters
, and a finish_url
that needs to be called once the
upload has been performed.
For example, the s3-sts-v1
handler returns AWS credentials and bucket
information that can be used with the S3 boto3 client upload_file
operation.
Authorizations:
Request Body schema: application/jsonrequired
services required | Array of strings <uuid> unique [ items <uuid > ] |
environment required | string <uuid> (Environment) |
notes | string (Notes) non-empty |
scheduled_for_deletion_at | string <date-time> (Scheduled for deletion at) |
Responses
Request samples
- Payload
{- "services": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "environment": "fafd1151-c401-4fdd-ac01-03d8e7a57166",
- "notes": "string",
- "scheduled_for_deletion_at": "2019-08-24T14:15:22Z"
}
Response samples
- 201
{- "uuid": "string",
- "results": {
}
}
GetBackup
Get the details of a single backup
Authorizations:
path Parameters
uuid required | string |
Responses
Response samples
- 200
{- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "environment": "fafd1151-c401-4fdd-ac01-03d8e7a57166",
- "org_membership": "052d699a-f769-42f1-9cac-4bfd43f3660b",
- "tags": [
- "string"
], - "created": "2019-08-24T14:15:22Z",
- "notes": "string",
- "state": "WAITING",
- "size": "string",
- "meta_information": { },
- "service_instance_backups": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "scheduled_for_deletion_at": "2019-08-24T14:15:22Z",
- "success": "SUCCESS"
}
ListBoilerplateCollaborators
List boilerplate collaborators
Authorizations:
query Parameters
boilerplate | string |
page | integer A page number within the paginated result set. |
page_size | integer Number of results to return per page. |
Responses
Response samples
- 200
{- "count": 0,
- "results": [
- {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "boilerplate": "dc8d6aaf-699c-4bac-8d91-fd36adfad8a1",
- "user": "76f62a58-5404-486d-9afc-07bded328704",
- "organisation_membership": "89a9a62d-4ccd-419c-bc47-31a3102140bb",
- "can_write": true
}
]
}
CreateBoilerplateCollaborator
Create a new boilerplate collaborator object
Authorizations:
Request Body schema: application/jsonrequired
boilerplate required | string <uuid> (Boilerplate) |
organisation_membership required | string <uuid> (Organisation membership) |
can_write | boolean (Can write) |
Responses
Request samples
- Payload
{- "boilerplate": "dc8d6aaf-699c-4bac-8d91-fd36adfad8a1",
- "organisation_membership": "89a9a62d-4ccd-419c-bc47-31a3102140bb",
- "can_write": true
}
Response samples
- 201
{- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "boilerplate": "dc8d6aaf-699c-4bac-8d91-fd36adfad8a1",
- "organisation_membership": "89a9a62d-4ccd-419c-bc47-31a3102140bb",
- "can_write": true
}
GetBoilerplateCollaborator
Get the details of a single boilerplate collaborator
Authorizations:
path Parameters
uuid required | string <uuid> |
Responses
Response samples
- 200
{- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "boilerplate": "dc8d6aaf-699c-4bac-8d91-fd36adfad8a1",
- "user": "76f62a58-5404-486d-9afc-07bded328704",
- "organisation_membership": "89a9a62d-4ccd-419c-bc47-31a3102140bb",
- "can_write": true
}
UpdateBoilerplateCollaborator
Replace the specified boilerplate collaborator
Authorizations:
path Parameters
uuid required | string <uuid> |
Request Body schema: application/jsonrequired
Responses
Request samples
- Payload
{ }
Response samples
- 200
{ }
PartialUpdateBoilerplateCollaborator
Partially update the specified boilerplate collaborator
Authorizations:
path Parameters
uuid required | string <uuid> |
Request Body schema: application/jsonrequired
can_write | boolean (Can write) |
Responses
Request samples
- Payload
{- "can_write": true
}
Response samples
- 200
{- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "can_write": true
}
ListBoilerplateVersions
List boilerplate versions
Authorizations:
query Parameters
uuid | Array of strings |
boilerplate | string |
version | string |
page | integer A page number within the paginated result set. |
page_size | integer Number of results to return per page. |
Responses
Response samples
- 200
{- "count": 0,
- "results": [
- {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "boilerplate": "dc8d6aaf-699c-4bac-8d91-fd36adfad8a1",
- "uploaded_by": "string",
- "timestamp": "2019-08-24T14:15:22Z",
- "message": "string",
- "installation_count": "string",
- "version": "string",
- "version_sortable": "string"
}
]
}
GetBoilerplateVersion
Get the details of a single boilerplate version
Authorizations:
path Parameters
uuid required | string <uuid> |
Responses
Response samples
- 200
{- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "boilerplate": "dc8d6aaf-699c-4bac-8d91-fd36adfad8a1",
- "uploaded_by": "string",
- "timestamp": "2019-08-24T14:15:22Z",
- "message": "string",
- "installation_count": "string",
- "version": "string",
- "version_sortable": "string"
}
ListBoilerplates
List boilerplates
Authorizations:
query Parameters
organisation | string |
name | string |
is_public | boolean |
page | integer A page number within the paginated result set. |
page_size | integer Number of results to return per page. |
Responses
Response samples
- 200
{- "count": 0,
- "results": [
- {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "organisation": "a4b97354-4e56-4723-bc0e-1f22b5fcbed6",
- "name": "string",
- "short_name": "string",
- "short_description_html": "string",
- "is_public": "string",
- "modified": "2019-08-24T14:15:22Z",
- "author_name": "string",
- "latest_version": "3868a55d-b0e6-431b-aea6-a253a41913b9"
}
]
}
CreateBoilerplate
Create a new boilerplate object
Authorizations:
Request Body schema: application/jsonrequired
name required | string (Name) [ 1 .. 100 ] characters |
package_name required | string <slug> (Package name) [ 1 .. 100 ] characters ^[-a-zA-Z0-9_]+$ System wide unique package name used to reference from the commandline. |
organisation required | string <uuid> (Organisation) |
Responses
Request samples
- Payload
{- "name": "string",
- "package_name": "string",
- "organisation": "a4b97354-4e56-4723-bc0e-1f22b5fcbed6"
}
Response samples
- 201
{- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "package_name": "string",
- "organisation": "a4b97354-4e56-4723-bc0e-1f22b5fcbed6"
}
ListEditableBoilerplates
Authorizations:
query Parameters
organisation | string |
name | string |
is_public | boolean |
page | integer A page number within the paginated result set. |
page_size | integer Number of results to return per page. |
Responses
Response samples
- 200
{- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "organisation": "a4b97354-4e56-4723-bc0e-1f22b5fcbed6",
- "name": "string",
- "short_name": "string",
- "short_description_html": "string",
- "is_public": "string",
- "modified": "2019-08-24T14:15:22Z",
- "author_name": "string",
- "latest_version": "3868a55d-b0e6-431b-aea6-a253a41913b9"
}
GetBoilerplate
Get the details of a single boilerplate
Authorizations:
path Parameters
uuid required | string <uuid> |
Responses
Response samples
- 200
{- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "organisation": "a4b97354-4e56-4723-bc0e-1f22b5fcbed6",
- "name": "string",
- "short_name": "string",
- "short_description_html": "string",
- "is_public": "string",
- "modified": "2019-08-24T14:15:22Z",
- "author_name": "string",
- "latest_version": "3868a55d-b0e6-431b-aea6-a253a41913b9",
- "description": "string",
- "package_name": "string",
- "identifier": "string",
- "license": "0062b866-9a29-4aaa-bcb3-34c1f3d5760d"
}
UpdateBoilerplate
Replace the specified boilerplate
Authorizations:
path Parameters
uuid required | string <uuid> |
Request Body schema: application/jsonrequired
name required | string (Name) [ 1 .. 100 ] characters |
package_name required | string <slug> (Package name) [ 1 .. 100 ] characters ^[-a-zA-Z0-9_]+$ System wide unique package name used to reference from the commandline. |
identifier | string (Identifier) <= 100 characters Boilerplate namespace ("ALDRYN_BOILERPLATE_NAME") used for boilerplate specific templates and staticfiles. |
description | string (Description) non-empty |
license | string or null <uuid> (License) |
author_name | string (Author name) non-empty |
author_url | string <uri> (Author url) <= 200 characters |
Responses
Request samples
- Payload
{- "name": "string",
- "package_name": "string",
- "identifier": "string",
- "description": "string",
- "license": "0062b866-9a29-4aaa-bcb3-34c1f3d5760d",
- "author_name": "string",
}
Response samples
- 200
{- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "package_name": "string",
- "identifier": "string",
- "description": "string",
- "license": "0062b866-9a29-4aaa-bcb3-34c1f3d5760d",
- "author_name": "string",
}
PartialUpdateBoilerplate
Partially update the specified boilerplate
Authorizations:
path Parameters
uuid required | string <uuid> |
Request Body schema: application/jsonrequired
name required | string (Name) [ 1 .. 100 ] characters |
package_name required | string <slug> (Package name) [ 1 .. 100 ] characters ^[-a-zA-Z0-9_]+$ System wide unique package name used to reference from the commandline. |
identifier | string (Identifier) <= 100 characters Boilerplate namespace ("ALDRYN_BOILERPLATE_NAME") used for boilerplate specific templates and staticfiles. |
description | string (Description) non-empty |
license | string or null <uuid> (License) |
author_name | string (Author name) non-empty |
author_url | string <uri> (Author url) <= 200 characters |
Responses
Request samples
- Payload
{- "name": "string",
- "package_name": "string",
- "identifier": "string",
- "description": "string",
- "license": "0062b866-9a29-4aaa-bcb3-34c1f3d5760d",
- "author_name": "string",
}
Response samples
- 200
{- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "package_name": "string",
- "identifier": "string",
- "description": "string",
- "license": "0062b866-9a29-4aaa-bcb3-34c1f3d5760d",
- "author_name": "string",
}
TransferBoilerplate
Authorizations:
path Parameters
uuid required | string <uuid> |
Request Body schema: application/jsonrequired
organisation required | string <uuid> (Organisation) |
Responses
Request samples
- Payload
{- "organisation": "a4b97354-4e56-4723-bc0e-1f22b5fcbed6"
}
Response samples
- 200
{- "organisation": "a4b97354-4e56-4723-bc0e-1f22b5fcbed6"
}
ListBuilds
List builds
Authorizations:
query Parameters
page | integer A page number within the paginated result set. |
page_size | integer Number of results to return per page. |
Responses
Response samples
- 200
{- "count": 0,
- "results": [
- {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "repository": "e3d1beef-8819-44ce-aeb0-6d1f16e4ee3b",
- "website": "string",
- "build_type": "string",
- "start": "2019-08-24T14:15:22Z",
- "end": "2019-08-24T14:15:22Z",
- "git_commit": "string",
- "docker_image": "string"
}
]
}
GetBuild
Get the details of a single build
Authorizations:
path Parameters
uuid required | string |
Responses
Response samples
- 200
{- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "repository": "e3d1beef-8819-44ce-aeb0-6d1f16e4ee3b",
- "website": "string",
- "build_type": "string",
- "start": "2019-08-24T14:15:22Z",
- "end": "2019-08-24T14:15:22Z",
- "git_commit": "string",
- "docker_image": "string"
}
PostBuildCloudevent
This function receives the final cloud event of a build task.
Authorizations:
path Parameters
uuid required | string |
Request Body schema: application/jsonrequired
Accepts a cloudevent in the style of cloudevent.io
Responses
Request samples
- Payload
{ }
Response samples
- 201
{ }
ListCharges
List charges
Authorizations:
query Parameters
invoice | string |
page | integer A page number within the paginated result set. |
page_size | integer Number of results to return per page. |
Responses
Response samples
- 200
{- "count": 0,
- "results": [
- {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "invoice": "f5072b7b-65cb-48aa-bf69-c999195da70c",
- "currency": "string",
- "amount": -2147483648,
- "charged_at": "2019-08-24T14:15:22Z",
- "status": "SUCCEEDED",
- "charge_target": "string",
- "fail_message": "string"
}
]
}
GetCharge
Get the details of a single charge
Authorizations:
path Parameters
uuid required | string <uuid> |
Responses
Response samples
- 200
{- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "invoice": "f5072b7b-65cb-48aa-bf69-c999195da70c",
- "currency": "string",
- "amount": -2147483648,
- "charged_at": "2019-08-24T14:15:22Z",
- "status": "SUCCEEDED",
- "charge_target": "string",
- "fail_message": "string"
}
ListCountries
List countries
Authorizations:
query Parameters
page | integer A page number within the paginated result set. |
page_size | integer Number of results to return per page. |
Responses
Response samples
- 200
{- "count": 0,
- "results": [
- {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "short_name": "string",
- "long_name": "string"
}
]
}
ListCronjobs
List cronjobs
Authorizations:
query Parameters
environment | string |
limit | integer Number of results to return per page. |
offset | integer The initial index from which to return the results. |
Responses
Response samples
- 200
{- "count": 0,
- "results": [
- {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "command": "string",
- "frequency": "DAILY",
- "time": "string",
- "environment": "fafd1151-c401-4fdd-ac01-03d8e7a57166",
- "custom_timeout": 2147483647
}
]
}
CreateCronjob
Create a new cronjob object
Authorizations:
Request Body schema: application/jsonrequired
command required | string (Command) non-empty |
frequency required | string (Frequency) Enum: "DAILY" "HOURLY" "EVERY10MIN" |
time | string (Time) <= 16 characters Time of day (e.g "02:30") for "Daily". Minute of hour (e.g ":42" for "Hourly" Empty for "Every 10 minutes" |
environment required | string <uuid> (Environment) |
custom_timeout | integer or null (Custom timeout) [ 0 .. 2147483647 ] Number of seconds before running cron jobs get terminated |
Responses
Request samples
- Payload
{- "command": "string",
- "frequency": "DAILY",
- "time": "string",
- "environment": "fafd1151-c401-4fdd-ac01-03d8e7a57166",
- "custom_timeout": 2147483647
}
Response samples
- 201
{- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "command": "string",
- "frequency": "DAILY",
- "time": "string",
- "environment": "fafd1151-c401-4fdd-ac01-03d8e7a57166",
- "custom_timeout": 2147483647
}
GetCronjob
Get the details of a single cronjob
Authorizations:
path Parameters
uuid required | string |
Responses
Response samples
- 200
{- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "command": "string",
- "frequency": "DAILY",
- "time": "string",
- "environment": "fafd1151-c401-4fdd-ac01-03d8e7a57166",
- "custom_timeout": 2147483647
}
UpdateCronjob
Replace the specified cronjob
Authorizations:
path Parameters
uuid required | string |
Request Body schema: application/jsonrequired
command required | string (Command) non-empty |
frequency required | string (Frequency) Enum: "DAILY" "HOURLY" "EVERY10MIN" |
time | string (Time) <= 16 characters Time of day (e.g "02:30") for "Daily". Minute of hour (e.g ":42" for "Hourly" Empty for "Every 10 minutes" |
custom_timeout | integer or null (Custom timeout) [ 0 .. 2147483647 ] Number of seconds before running cron jobs get terminated |
Responses
Request samples
- Payload
{- "command": "string",
- "frequency": "DAILY",
- "time": "string",
- "custom_timeout": 2147483647
}
Response samples
- 200
{- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "command": "string",
- "frequency": "DAILY",
- "time": "string",
- "environment": "fafd1151-c401-4fdd-ac01-03d8e7a57166",
- "custom_timeout": 2147483647
}
PartialUpdateCronjob
Partially update the specified cronjob
Authorizations:
path Parameters
uuid required | string |
Request Body schema: application/jsonrequired
command required | string (Command) non-empty |
frequency required | string (Frequency) Enum: "DAILY" "HOURLY" "EVERY10MIN" |
time | string (Time) <= 16 characters Time of day (e.g "02:30") for "Daily". Minute of hour (e.g ":42" for "Hourly" Empty for "Every 10 minutes" |
custom_timeout | integer or null (Custom timeout) [ 0 .. 2147483647 ] Number of seconds before running cron jobs get terminated |
Responses
Request samples
- Payload
{- "command": "string",
- "frequency": "DAILY",
- "time": "string",
- "custom_timeout": 2147483647
}
Response samples
- 200
{- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "command": "string",
- "frequency": "DAILY",
- "time": "string",
- "environment": "fafd1151-c401-4fdd-ac01-03d8e7a57166",
- "custom_timeout": 2147483647
}
ListDeployments
List deployments
Authorizations:
query Parameters
environment | string |
application | string |
organisation | string |
task | string |
is_success | boolean |
page | integer A page number within the paginated result set. |
page_size | integer Number of results to return per page. |
Responses
Response samples
- 200
{- "count": 0,
- "results": [
- {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "environment": "fafd1151-c401-4fdd-ac01-03d8e7a57166",
- "region": "string",
- "author": "string",
- "started_at": "2019-08-24T14:15:22Z",
- "ended_at": "2019-08-24T14:15:22Z",
- "duration": "string",
- "status": "string",
- "is_usable": true,
- "success": true
}
]
}
CreateDeployment
Create a new deployment object
Authorizations:
Request Body schema: application/jsonrequired
environment required | string <uuid> (Environment) |
build_mode | string (Build mode) Default: "AUTO" Enum: "AUTO" "ADOPT" "FORCE" |
copy_from | string <uuid> (Copy from) |
provision_services | boolean (Provision services) Default: true |
Responses
Request samples
- Payload
{- "environment": "fafd1151-c401-4fdd-ac01-03d8e7a57166",
- "build_mode": "AUTO",
- "copy_from": "144bc18e-5e55-4977-aab4-2906b01f1c12",
- "provision_services": true
}
Response samples
- 201
{- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "environment": "fafd1151-c401-4fdd-ac01-03d8e7a57166",
- "build_mode": "AUTO",
- "copy_from": "144bc18e-5e55-4977-aab4-2906b01f1c12",
- "provision_services": true
}
CreateDeploymentsInBulk
Authorizations:
query Parameters
limit | integer |
application | string |
organisation | string |
related_to_application | string |
with_pending_commits | boolean |
is_mirror | boolean |
copy_type | string |
slug | string |
o | string |
deploying | boolean |
last_deployment_failed | boolean |
deployed | boolean |
Responses
Response samples
- 201
{ }
GetDeployment
Get the details of a single deployment
Authorizations:
path Parameters
uuid required | string <uuid> |
Responses
Response samples
- 200
{- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "environment": "fafd1151-c401-4fdd-ac01-03d8e7a57166",
- "region": "string",
- "author": "string",
- "started_at": "2019-08-24T14:15:22Z",
- "ended_at": "2019-08-24T14:15:22Z",
- "duration": "string",
- "status": "string",
- "is_usable": true,
- "success": true,
- "environment_variables": [
- "string"
], - "percent": "string"
}
PartialUpdateDeployment
Partially update the specified deployment
Authorizations:
path Parameters
uuid required | string <uuid> |
Request Body schema: application/jsonrequired
status | string (Status) |
is_usable | boolean (Is usable) |
success | boolean or null (Success) |
Responses
Request samples
- Payload
{- "status": "string",
- "is_usable": true,
- "success": true
}
Response samples
- 200
{- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "environment": "fafd1151-c401-4fdd-ac01-03d8e7a57166",
- "region": "string",
- "author": "string",
- "started_at": "2019-08-24T14:15:22Z",
- "ended_at": "2019-08-24T14:15:22Z",
- "duration": "string",
- "status": "string",
- "is_usable": true,
- "success": true,
- "environment_variables": [
- "string"
], - "percent": "string"
}
GetDeploymentEnvironmentVariables
Authorizations:
path Parameters
uuid required | string <uuid> |
Responses
Response samples
- 200
{- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "environment": "fafd1151-c401-4fdd-ac01-03d8e7a57166",
- "region": "string",
- "author": "string",
- "started_at": "2019-08-24T14:15:22Z",
- "ended_at": "2019-08-24T14:15:22Z",
- "duration": "string",
- "status": "string",
- "is_usable": true,
- "success": true,
- "environment_variables": {
- "property1": "string",
- "property2": "string"
}
}
ListDomains
List domains
Authorizations:
query Parameters
environment | string |
application | string |
organisation | string |
name | string |
page | integer A page number within the paginated result set. |
page_size | integer Number of results to return per page. |
Responses
Response samples
- 200
{- "count": 0,
- "results": [
- {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "environment": "fafd1151-c401-4fdd-ac01-03d8e7a57166",
- "last_check_status": true,
- "last_check_timestamp": "2019-08-24T14:15:22Z",
- "last_check_details": { },
- "is_tls_enabled": "string",
- "is_redirect_to_primary": true,
- "is_primary": true,
- "is_editable": true,
- "is_managed_by_divio": true,
- "is_wildcard": true,
- "is_monitored": true,
- "setup_instructions_html": "string",
- "domain_config": {
- "backend_type": "string",
- "proxy_endpoint": [
- "string"
], - "certificate": "string",
- "certificate_chain": "string",
- "certificate_expiration_date": "2019-08-24T14:15:22Z"
}, - "state": "UNKNOWN",
- "state_message": "string"
}
]
}
CreateDomain
Create a new domain object
Authorizations:
Request Body schema: application/jsonrequired
name required | string (Name) [ 1 .. 255 ] characters |
environment required | string <uuid> (Environment) |
Responses
Request samples
- Payload
{- "name": "string",
- "environment": "fafd1151-c401-4fdd-ac01-03d8e7a57166"
}
Response samples
- 201
{- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "environment": "fafd1151-c401-4fdd-ac01-03d8e7a57166"
}
GetDomain
Get the details of a single domain
Authorizations:
path Parameters
uuid required | string <uuid> |
Responses
Response samples
- 200
{- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "environment": "fafd1151-c401-4fdd-ac01-03d8e7a57166",
- "last_check_status": true,
- "last_check_timestamp": "2019-08-24T14:15:22Z",
- "last_check_details": { },
- "is_tls_enabled": "string",
- "is_redirect_to_primary": true,
- "is_primary": true,
- "is_editable": true,
- "is_managed_by_divio": true,
- "is_wildcard": true,
- "is_monitored": true,
- "setup_instructions_html": "string",
- "domain_config": {
- "backend_type": "string",
- "proxy_endpoint": [
- "string"
], - "certificate": "string",
- "certificate_chain": "string",
- "certificate_expiration_date": "2019-08-24T14:15:22Z"
}, - "state": "UNKNOWN",
- "state_message": "string"
}
UpdateDomain
Replace the specified domain
Authorizations:
path Parameters
uuid required | string <uuid> |
Request Body schema: application/jsonrequired
is_redirect_to_primary | boolean (Is redirect to primary) |
object (Domain config) |
Responses
Request samples
- Payload
{- "is_redirect_to_primary": true,
- "domain_config": {
- "proxy_endpoint": [
- "string"
], - "key": "string",
- "certificate": "string",
- "certificate_chain": "string"
}
}
Response samples
- 200
{- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "is_redirect_to_primary": true,
- "domain_config": {
- "backend_type": "string",
- "proxy_endpoint": [
- "string"
], - "certificate": "string",
- "certificate_chain": "string",
- "certificate_expiration_date": "2019-08-24T14:15:22Z"
}
}
PartialUpdateDomain
Partially update the specified domain
Authorizations:
path Parameters
uuid required | string <uuid> |
Request Body schema: application/jsonrequired
Responses
Request samples
- Payload
{ }
Response samples
- 200
{- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "is_redirect_to_primary": true,
- "domain_config": {
- "backend_type": "string",
- "proxy_endpoint": [
- "string"
], - "certificate": "string",
- "certificate_chain": "string",
- "certificate_expiration_date": "2019-08-24T14:15:22Z"
}
}
TransferDomain
Authorizations:
path Parameters
uuid required | string <uuid> |
Request Body schema: application/jsonrequired
target_environment required | string <uuid> (Target environment) |
Responses
Request samples
- Payload
{- "target_environment": "3f17d230-ecb9-46b7-b3d9-8f7ccc5b2664"
}
Response samples
- 201
{- "target_environment": "3f17d230-ecb9-46b7-b3d9-8f7ccc5b2664"
}
ListEnvironmentMetricMetadata
List environment metric metadata
Authorizations:
query Parameters
environment | string |
page | integer A page number within the paginated result set. |
page_size | integer Number of results to return per page. |
Responses
Response samples
- 200
{- "count": 0,
- "results": [
- {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "identifier": "string",
- "title": "string",
- "description": "string",
- "chart_display": "line",
- "unit": "string",
- "unit_numerator": "string",
- "unit_denominator": "string"
}
]
}
GetEnvironmentMetricMetadata
Get the details of a single environment metric metadata
Authorizations:
path Parameters
uuid required | string <uuid> A UUID string identifying this environment metric. |
Responses
Response samples
- 200
{- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "identifier": "string",
- "title": "string",
- "description": "string",
- "chart_display": "line",
- "unit": "string",
- "unit_numerator": "string",
- "unit_denominator": "string"
}
ListEnvironmentVariables
List environment variables
Authorizations:
query Parameters
uuid | string |
application | string |
environment | string |
name | string |
environment_slug | string |
is_sensitive | boolean |
is_read_only | boolean |
page | integer A page number within the paginated result set. |
page_size | integer Number of results to return per page. |
Responses
Response samples
- 200
{- "count": 0,
- "results": [
- {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "environment": "fafd1151-c401-4fdd-ac01-03d8e7a57166",
- "value": "string",
- "order": 32767,
- "is_sensitive": true,
- "is_read_only": true,
- "is_pattern_replacement_active": true
}
]
}
CreateEnvironmentVariable
Create a new environment variable object
Authorizations:
Request Body schema: application/jsonrequired
name required | string (Name) [ 1 .. 255 ] characters |
environment required | string <uuid> (Environment) |
value | string (Value) <= 10000 characters |
is_sensitive | boolean (Is sensitive) When active, the value of the environment variable should only be exposed upon authorization. |
is_pattern_replacement_active | boolean (Is pattern replacement active) When active, the value of the environment variable will be processed for pattern replacement. |
Responses
Request samples
- Payload
{- "name": "string",
- "environment": "fafd1151-c401-4fdd-ac01-03d8e7a57166",
- "value": "string",
- "is_sensitive": true,
- "is_pattern_replacement_active": true
}
Response samples
- 201
{- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "environment": "fafd1151-c401-4fdd-ac01-03d8e7a57166",
- "value": "string",
- "is_sensitive": true,
- "is_read_only": true,
- "is_pattern_replacement_active": true,
- "order": 0
}
GetEnvironmentVariable
Get the details of a single environment variable
Authorizations:
path Parameters
uuid required | string <uuid> A UUID string identifying this Environment variable. |
Responses
Response samples
- 200
{- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "environment": "fafd1151-c401-4fdd-ac01-03d8e7a57166",
- "value": "string",
- "order": 32767,
- "is_sensitive": true,
- "is_read_only": true,
- "is_pattern_replacement_active": true,
- "date_created": "2019-08-24T14:15:22Z",
- "date_modified": "2019-08-24T14:15:22Z"
}
UpdateEnvironmentVariable
Replace the specified environment variable
Authorizations:
path Parameters
uuid required | string <uuid> A UUID string identifying this Environment variable. |
Request Body schema: application/jsonrequired
name required | string (Name) [ 1 .. 255 ] characters |
value | string (Value) <= 10000 characters |
is_pattern_replacement_active | boolean (Is pattern replacement active) When active, the value of the environment variable will be processed for pattern replacement. |
Responses
Request samples
- Payload
{- "name": "string",
- "value": "string",
- "is_pattern_replacement_active": true
}
Response samples
- 200
{- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "environment": "fafd1151-c401-4fdd-ac01-03d8e7a57166",
- "value": "string",
- "is_sensitive": true,
- "is_read_only": true,
- "is_pattern_replacement_active": true,
- "order": 0
}
PartialUpdateEnvironmentVariable
Partially update the specified environment variable
Authorizations:
path Parameters
uuid required | string <uuid> A UUID string identifying this Environment variable. |
Request Body schema: application/jsonrequired
name required | string (Name) [ 1 .. 255 ] characters |
value | string (Value) <= 10000 characters |
is_pattern_replacement_active | boolean (Is pattern replacement active) When active, the value of the environment variable will be processed for pattern replacement. |
Responses
Request samples
- Payload
{- "name": "string",
- "value": "string",
- "is_pattern_replacement_active": true
}
Response samples
- 200
{- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "environment": "fafd1151-c401-4fdd-ac01-03d8e7a57166",
- "value": "string",
- "is_sensitive": true,
- "is_read_only": true,
- "is_pattern_replacement_active": true,
- "order": 0
}
MoveAfterEnvironmentVariable
Authorizations:
path Parameters
uuid required | string <uuid> A UUID string identifying this Environment variable. |
Request Body schema: application/jsonrequired
target required | string <uuid> (Target) |
Responses
Request samples
- Payload
{- "target": "65a17d54-9c67-4477-8b80-d3f97e165aa5"
}
Response samples
- 201
{- "target": "65a17d54-9c67-4477-8b80-d3f97e165aa5"
}
MoveBeforeEnvironmentVariable
Authorizations:
path Parameters
uuid required | string <uuid> A UUID string identifying this Environment variable. |
Request Body schema: application/jsonrequired
target required | string <uuid> (Target) |
Responses
Request samples
- Payload
{- "target": "65a17d54-9c67-4477-8b80-d3f97e165aa5"
}
Response samples
- 201
{- "target": "65a17d54-9c67-4477-8b80-d3f97e165aa5"
}
ListEnvironments
List environments
Authorizations:
query Parameters
application | string |
organisation | string |
related_to_application | string |
with_pending_commits | boolean |
is_mirror | boolean |
copy_type | string Enum: "COPY" "FORK" "MIRROR" |
slug | string |
deploying | boolean |
last_deployment_failed | boolean |
deployed | boolean |
name_search | string |
o | string Enum: "application" "-application" |
page | integer A page number within the paginated result set. |
page_size | integer Number of results to return per page. |
Responses
Response samples
- 200
{- "count": 0,
- "results": [
- {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "application": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "slug": "string",
- "organisation": "a4b97354-4e56-4723-bc0e-1f22b5fcbed6"
}, - "slug": "string",
- "branch": "string",
- "is_production_grade": true,
- "pending_commits_lookup": "string",
- "has_pending_commits": true,
- "deployed_url": "string",
- "last_finished_deployment": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "success": true,
- "status": "string",
- "started_at": "2019-08-24T14:15:22Z",
- "ended_at": "2019-08-24T14:15:22Z"
}, - "currently_running_deployment": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "success": true,
- "status": "string",
- "started_at": "2019-08-24T14:15:22Z",
- "ended_at": "2019-08-24T14:15:22Z"
}, - "currently_released_deployment": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "success": true,
- "status": "string",
- "started_at": "2019-08-24T14:15:22Z",
- "ended_at": "2019-08-24T14:15:22Z"
}
}
]
}
CreateEnvironment
Create a new environment object
Authorizations:
Request Body schema: application/jsonrequired
application required | string <uuid> (Application) |
slug required | string <slug> (Slug) [ 1 .. 255 ] characters ^[-a-zA-Z0-9_]+$ |
branch required | string (Branch) non-empty |
Responses
Request samples
- Payload
{- "application": "2b22d485-f04e-492b-b364-e14f8506726a",
- "slug": "string",
- "branch": "string"
}
Response samples
- 201
{- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "application": "2b22d485-f04e-492b-b364-e14f8506726a",
- "slug": "string",
- "branch": "string"
}
GetEnvironment
Get the details of a single environment
Authorizations:
path Parameters
uuid required | string |
Responses
Response samples
- 200
{- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "application": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "slug": "string",
- "organisation": "a4b97354-4e56-4723-bc0e-1f22b5fcbed6"
}, - "slug": "string",
- "branch": "string",
- "is_production_grade": true,
- "pending_commits_lookup": "string",
- "has_pending_commits": true,
- "deployed_url": "string",
- "last_finished_deployment": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "success": true,
- "status": "string",
- "started_at": "2019-08-24T14:15:22Z",
- "ended_at": "2019-08-24T14:15:22Z"
}, - "currently_running_deployment": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "success": true,
- "status": "string",
- "started_at": "2019-08-24T14:15:22Z",
- "ended_at": "2019-08-24T14:15:22Z"
}, - "currently_released_deployment": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "success": true,
- "status": "string",
- "started_at": "2019-08-24T14:15:22Z",
- "ended_at": "2019-08-24T14:15:22Z"
}, - "app_name": "string",
- "primary_domain": "ba84b5a5-4ba6-45bc-ae67-5060535280fc",
- "divio_domain": "string",
- "application_config": { },
- "ssh_endpoint": { },
- "ondemand_backup_retention_config": "0b7f8b9e-2b00-428d-bffd-2e479c4f3bbb",
- "scheduled_backup_config": "f4a22afa-cbac-47ae-8740-a20a06e344c9",
- "next_scheduled_backup_occurence": "string",
- "pending_commit_count": 0,
- "has_pending_changes": true,
- "running_tasks": [
- {
- "name": "string",
- "identifier": "string"
}
], - "built_in_environment_variables": [
- "string"
]
}
UpdateEnvironment
Replace the specified environment
Authorizations:
path Parameters
uuid required | string |
Request Body schema: application/jsonrequired
branch required | string (Branch) non-empty |
Responses
Request samples
- Payload
{- "branch": "string"
}
Response samples
- 200
{- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "branch": "string"
}
PartialUpdateEnvironment
Partially update the specified environment
Authorizations:
path Parameters
uuid required | string |
Request Body schema: application/jsonrequired
branch required | string (Branch) non-empty |
Responses
Request samples
- Payload
{- "branch": "string"
}
Response samples
- 200
{- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "branch": "string"
}
CopyEnvironment
Authorizations:
path Parameters
uuid required | string |
Request Body schema: application/jsonrequired
new_slug required | string (New slug) [ 1 .. 255 ] characters ^[0-9a-z](-*[0-9a-z])*$ |
Responses
Request samples
- Payload
{- "new_slug": "string"
}
Response samples
- 202
{- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "application": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "slug": "string",
- "organisation": "a4b97354-4e56-4723-bc0e-1f22b5fcbed6"
}, - "slug": "string",
- "branch": "string",
- "is_production_grade": true,
- "pending_commits_lookup": "string",
- "has_pending_commits": true,
- "deployed_url": "string",
- "last_finished_deployment": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "success": true,
- "status": "string",
- "started_at": "2019-08-24T14:15:22Z",
- "ended_at": "2019-08-24T14:15:22Z"
}, - "currently_running_deployment": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "success": true,
- "status": "string",
- "started_at": "2019-08-24T14:15:22Z",
- "ended_at": "2019-08-24T14:15:22Z"
}, - "currently_released_deployment": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "success": true,
- "status": "string",
- "started_at": "2019-08-24T14:15:22Z",
- "ended_at": "2019-08-24T14:15:22Z"
}, - "app_name": "string",
- "primary_domain": "ba84b5a5-4ba6-45bc-ae67-5060535280fc",
- "divio_domain": "string",
- "application_config": { },
- "ssh_endpoint": { },
- "ondemand_backup_retention_config": "0b7f8b9e-2b00-428d-bffd-2e479c4f3bbb",
- "scheduled_backup_config": "f4a22afa-cbac-47ae-8740-a20a06e344c9",
- "next_scheduled_backup_occurence": "string",
- "pending_commit_count": 0,
- "has_pending_changes": true,
- "running_tasks": [
- {
- "name": "string",
- "identifier": "string"
}
], - "built_in_environment_variables": [
- "string"
]
}