Skip to main content
API docs by Redocly

Divio Cloud API - Applications management (v3)

Download OpenAPI specification:Download

E-mail: info@divio.com URL: https://www.divio.com/ License: BSD License Terms of Service

app-templates

ListAppTemplates

List app templates

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

Content type
application/json
{}

GetAppTemplate

Get the details of a single app template

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

A UUID string identifying this app template.

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "identifier": "string",
  • "name": "string",
  • "short_description": "string",
  • "url": "http://example.com",
  • "icon": "http://example.com",
  • "icon_dark_mode": "http://example.com",
  • "is_default": true,
  • "order": -2147483648,
  • "release_commands": [
    ],
  • "services": [
    ],
  • "tags": [
    ]
}

application-activities

ListApplicationActivities

List application activities

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

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

GetApplicationActivity

Get the details of a single application activity

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "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_avatar_images": {},
  • "user_is_removed": true
}

application-collaborators

ListApplicationCollaborators

List application collaborators

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

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

CreateApplicationCollaborator

Create a new application collaborator object

Authorizations:
Token
Request Body schema: application/json
required
application
required
string <uuid> (Application)
membership
required
string <uuid> (Membership)

Responses

Request samples

Content type
application/json
{
  • "application": "2b22d485-f04e-492b-b364-e14f8506726a",
  • "membership": "b8ce8f5d-49a7-404e-a63d-be641c3bd8d7"
}

Response samples

Content type
application/json
{
  • "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:
Token
path Parameters
uuid
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "application": "2b22d485-f04e-492b-b364-e14f8506726a",
  • "membership": "b8ce8f5d-49a7-404e-a63d-be641c3bd8d7"
}

DestroyApplicationCollaborator

Delete the specified application collaborator

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

Responses

applications

ListApplications

List applications

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

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

CreateApplication

Create a new application object

Authorizations:
Token
Request Body schema: application/json
required
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

Content type
application/json
{
  • "name": "string",
  • "region": "ac2f330e-0351-4cac-b9d3-953e54b3d1f8",
  • "app_template": "http://example.com",
  • "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": [
    ],
  • "slug": "string",
  • "tags": [
    ],
  • "disk": 0,
  • "transfer": 0,
  • "container_structure": [
    ]
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "region": "ac2f330e-0351-4cac-b9d3-953e54b3d1f8",
  • "app_template": "http://example.com",
  • "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": [
    ],
  • "slug": "string",
  • "tags": [
    ],
  • "disk": 0,
  • "transfer": 0,
  • "container_structure": [
    ]
}

GetApplication

Get the details of a single application

Authorizations:
Token
path Parameters
uuid
required
string <uuid>
query Parameters
screenshot_sizes
string
avatar_sizes
string

Responses

Response samples

Content type
application/json
{
  • "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",
  • "screenshots": {},
  • "custom_screenshots": {},
  • "avatars": {},
  • "is_suspended": true,
  • "suspended_reason": "string",
  • "is_undergoing_maintenance": true,
  • "maintenance_reason": "string",
  • "copy_type": "COPY",
  • "is_repository_read_only": true,
  • "release_commands": [
    ],
  • "has_annotations": true,
  • "updates_available": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "active_subscription": "string",
  • "tags": [
    ],
  • "on_free_trial": true,
  • "free_trial_days_left": 0,
  • "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": [
    ],
  • "permissions": [
    ]
}

UpdateApplication

Replace the specified application

Authorizations:
Token
path Parameters
uuid
required
string <uuid>
Request Body schema: application/json
required
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

Content type
application/json
{
  • "name": "string",
  • "maintenance_window_start": 2147483647,
  • "maintenance_window_duration": 2147483647,
  • "release_commands": [
    ],
  • "port": 2147483647,
  • "startup_probe_max_retries": 1,
  • "startup_probe_request_timeout": 1,
  • "startup_probe_retry_timeout": 1,
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "maintenance_window_start": 2147483647,
  • "maintenance_window_duration": 2147483647,
  • "release_commands": [
    ],
  • "port": 2147483647,
  • "startup_probe_max_retries": 1,
  • "startup_probe_request_timeout": 1,
  • "startup_probe_retry_timeout": 1,
  • "tags": [
    ]
}

PartialUpdateApplication

Partially update the specified application

Authorizations:
Token
path Parameters
uuid
required
string <uuid>
Request Body schema: application/json
required
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

Content type
application/json
{
  • "name": "string",
  • "maintenance_window_start": 2147483647,
  • "maintenance_window_duration": 2147483647,
  • "release_commands": [
    ],
  • "port": 2147483647,
  • "startup_probe_max_retries": 1,
  • "startup_probe_request_timeout": 1,
  • "startup_probe_retry_timeout": 1,
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "maintenance_window_start": 2147483647,
  • "maintenance_window_duration": 2147483647,
  • "release_commands": [
    ],
  • "port": 2147483647,
  • "startup_probe_max_retries": 1,
  • "startup_probe_request_timeout": 1,
  • "startup_probe_retry_timeout": 1,
  • "tags": [
    ]
}

DestroyApplication

Delete the specified application

Authorizations:
Token
path Parameters
uuid
required
string <uuid>
Request Body schema: application/json
required
verify_name
required
string (Verify name) non-empty

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "status": true,
  • "message": "string",
  • "code": "string"
}

UploadApplicationAvatar

Authorizations:
Token
path Parameters
uuid
required
string <uuid>
Request Body schema: multipart/form-data
required
file
required
string <binary>

Responses

Response samples

Content type
application/json
{}

DeleteApplicationAvatar

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

Responses

CopyApplication

Authorizations:
Token
path Parameters
uuid
required
string <uuid>
Request Body schema: application/json
required
target_name
required
string (Target name) non-empty
target_organisation
required
string <uuid> (Target organisation)
type
required
string (Type)
Enum Description
FORK

Fork

MIRROR

Mirror

Responses

Request samples

Content type
application/json
{
  • "target_name": "string",
  • "target_organisation": "1ba5f218-3c9c-4588-ba61-f31e797a3b6f",
  • "type": "FORK"
}

Response samples

Content type
application/json
{
  • "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",
  • "screenshots": {},
  • "custom_screenshots": {},
  • "avatars": {},
  • "is_suspended": true,
  • "suspended_reason": "string",
  • "is_undergoing_maintenance": true,
  • "maintenance_reason": "string",
  • "copy_type": "COPY",
  • "is_repository_read_only": true,
  • "release_commands": [
    ],
  • "has_annotations": true,
  • "updates_available": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "active_subscription": "string",
  • "tags": [
    ],
  • "on_free_trial": true,
  • "free_trial_days_left": 0,
  • "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": [
    ],
  • "permissions": [
    ]
}

MigrateApplicationToExternalRepository

Migrates an application to an external repository.

Authorizations:
Token
path Parameters
uuid
required
string <uuid>
Request Body schema: application/json
required
repository
required
string <uuid> (Repository)

Responses

Request samples

Content type
application/json
{
  • "repository": "e3d1beef-8819-44ce-aeb0-6d1f16e4ee3b"
}

Response samples

Content type
application/json
{
  • "status": true,
  • "message": "string",
  • "code": "string"
}

UploadApplicationScreenshot

Authorizations:
Token
path Parameters
uuid
required
string <uuid>
Request Body schema: multipart/form-data
required
file
required
string <binary>

Responses

Response samples

Content type
application/json
{}

DeleteApplicationScreenshot

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

Responses

TransferApplication

Authorizations:
Token
path Parameters
uuid
required
string <uuid>
Request Body schema: application/json
required
organisation
required
string <uuid> (Organisation)

Responses

Request samples

Content type
application/json
{
  • "organisation": "a4b97354-4e56-4723-bc0e-1f22b5fcbed6"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "organisation": "a4b97354-4e56-4723-bc0e-1f22b5fcbed6"
}

backup-download-service-instances

ListBackupDownloadServiceInstances

List backup download service instances

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

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

GetBackupDownloadServiceInstance

Get the details of a single backup download service instance

Authorizations:
Token
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "backup_download": "9588f5ec-96c6-4b5e-a1a5-0ca7c8bee2ac",
  • "service_instance_backup": "4161e5a6-3fef-4502-a0fe-dd044768b370",
  • "download_url": "http://example.com",
  • "queued_at": "2019-08-24T14:15:22Z",
  • "started_at": "2019-08-24T14:15:22Z",
  • "ended_at": "2019-08-24T14:15:22Z",
  • "errors": [
    ]
}

backup-downloads

ListBackupDownloads

List backup downloads

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

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

CreateBackupDownload

Create a new backup download object

Authorizations:
Token
Request Body schema: application/json
required
backup
required
string <uuid> (Backup)
trigger
required
string (Trigger)
Enum Description
MANUAL

Manual

PULL

Pull

service_instance_backups
required
Array of strings <uuid> unique [ items <uuid > ]

Responses

Request samples

Content type
application/json
{
  • "backup": "dbd9d221-8e93-4901-bb73-e2d59863aa61",
  • "trigger": "MANUAL",
  • "service_instance_backups": [
    ]
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "backup": "dbd9d221-8e93-4901-bb73-e2d59863aa61",
  • "trigger": "MANUAL",
  • "service_instance_backups": [
    ]
}

GetBackupDownload

Get the details of a single backup download

Authorizations:
Token
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "backup": "dbd9d221-8e93-4901-bb73-e2d59863aa61",
  • "author": "string",
  • "started_at": "2019-08-24T14:15:22Z",
  • "trigger": "MANUAL"
}

backup-restores

ListBackupRestores

List backup restores

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

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

CreateBackupRestore

Create a new backup restore object

Authorizations:
Token
Request Body schema: application/json
required
backup
required
string <uuid> (Backup)
required
Array of objects (BackupRestoreServiceInstanceParams)
notes
string (Notes) [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "backup": "dbd9d221-8e93-4901-bb73-e2d59863aa61",
  • "service_instance_restores": [
    ],
  • "notes": "string"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "backup": "dbd9d221-8e93-4901-bb73-e2d59863aa61",
  • "service_instance_restores": [
    ],
  • "notes": "string"
}

GetBackupRestore

Get the details of a single backup restore

Authorizations:
Token
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "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": [
    ]
}

backup-retention-configurations

ListBackupRetentionConfigurations

List backup retention configurations

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

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

GetBackupRetentionConfiguration

Get the details of a single backup retention configuration

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "identifier": "string",
  • "short_description": "string"
}

backups

ListBackups

List backups

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

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

CreateBackup

Create a new backup object

Authorizations:
Token
Request Body schema: application/json
required
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

Content type
application/json
{
  • "environment": "fafd1151-c401-4fdd-ac01-03d8e7a57166",
  • "notes": "string",
  • "services": [
    ],
  • "scheduled_for_deletion_at": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "environment": "fafd1151-c401-4fdd-ac01-03d8e7a57166",
  • "trigger": "MANUAL",
  • "notes": "string",
  • "services": [
    ],
  • "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:
Token
Request Body schema: application/json
required
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

Content type
application/json
{
  • "services": [
    ],
  • "environment": "fafd1151-c401-4fdd-ac01-03d8e7a57166",
  • "notes": "string",
  • "scheduled_for_deletion_at": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "results": {
    }
}

GetBackup

Get the details of a single backup

Authorizations:
Token
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "environment": "fafd1151-c401-4fdd-ac01-03d8e7a57166",
  • "org_membership": "052d699a-f769-42f1-9cac-4bfd43f3660b",
  • "tags": [
    ],
  • "created": "2019-08-24T14:15:22Z",
  • "notes": "string",
  • "state": "WAITING",
  • "size": "string",
  • "meta_information": { },
  • "service_instance_backups": [
    ],
  • "scheduled_for_deletion_at": "2019-08-24T14:15:22Z",
  • "success": "SUCCESS"
}

boilerplate-collaborators

ListBoilerplateCollaborators

List boilerplate collaborators

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

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

CreateBoilerplateCollaborator

Create a new boilerplate collaborator object

Authorizations:
Token
Request Body schema: application/json
required
boilerplate
required
string <uuid> (Boilerplate)
organisation_membership
required
string <uuid> (Organisation membership)
can_write
boolean (Can write)

Responses

Request samples

Content type
application/json
{
  • "boilerplate": "dc8d6aaf-699c-4bac-8d91-fd36adfad8a1",
  • "organisation_membership": "89a9a62d-4ccd-419c-bc47-31a3102140bb",
  • "can_write": true
}

Response samples

Content type
application/json
{
  • "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:
Token
path Parameters
uuid
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "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:
Token
path Parameters
uuid
required
string <uuid>
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

PartialUpdateBoilerplateCollaborator

Partially update the specified boilerplate collaborator

Authorizations:
Token
path Parameters
uuid
required
string <uuid>
Request Body schema: application/json
required
can_write
boolean (Can write)

Responses

Request samples

Content type
application/json
{
  • "can_write": true
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "can_write": true
}

DestroyBoilerplateCollaborator

Delete the specified boilerplate collaborator

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

Responses

boilerplate-versions

ListBoilerplateVersions

List boilerplate versions

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

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

GetBoilerplateVersion

Get the details of a single boilerplate version

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "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"
}

boilerplates

ListBoilerplates

List boilerplates

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

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

CreateBoilerplate

Create a new boilerplate object

Authorizations:
Token
Request Body schema: application/json
required
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

Content type
application/json
{
  • "name": "string",
  • "package_name": "string",
  • "organisation": "a4b97354-4e56-4723-bc0e-1f22b5fcbed6"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "package_name": "string",
  • "organisation": "a4b97354-4e56-4723-bc0e-1f22b5fcbed6"
}

ListEditableBoilerplates

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

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "organisation": "a4b97354-4e56-4723-bc0e-1f22b5fcbed6",
  • "name": "string",
  • "short_name": "string",
  • "short_description_html": "string",
  • "is_public": "string",
  • "icon": "http://example.com",
  • "modified": "2019-08-24T14:15:22Z",
  • "author_name": "string",
  • "author_url": "http://example.com",
  • "latest_version": "3868a55d-b0e6-431b-aea6-a253a41913b9"
}

GetBoilerplate

Get the details of a single boilerplate

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "organisation": "a4b97354-4e56-4723-bc0e-1f22b5fcbed6",
  • "name": "string",
  • "short_name": "string",
  • "short_description_html": "string",
  • "is_public": "string",
  • "icon": "http://example.com",
  • "modified": "2019-08-24T14:15:22Z",
  • "author_name": "string",
  • "author_url": "http://example.com",
  • "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:
Token
path Parameters
uuid
required
string <uuid>
Request Body schema: application/json
required
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

Content type
application/json
{
  • "name": "string",
  • "package_name": "string",
  • "identifier": "string",
  • "description": "string",
  • "license": "0062b866-9a29-4aaa-bcb3-34c1f3d5760d",
  • "author_name": "string",
  • "author_url": "http://example.com"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "package_name": "string",
  • "identifier": "string",
  • "description": "string",
  • "license": "0062b866-9a29-4aaa-bcb3-34c1f3d5760d",
  • "author_name": "string",
  • "author_url": "http://example.com"
}

PartialUpdateBoilerplate

Partially update the specified boilerplate

Authorizations:
Token
path Parameters
uuid
required
string <uuid>
Request Body schema: application/json
required
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

Content type
application/json
{
  • "name": "string",
  • "package_name": "string",
  • "identifier": "string",
  • "description": "string",
  • "license": "0062b866-9a29-4aaa-bcb3-34c1f3d5760d",
  • "author_name": "string",
  • "author_url": "http://example.com"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "package_name": "string",
  • "identifier": "string",
  • "description": "string",
  • "license": "0062b866-9a29-4aaa-bcb3-34c1f3d5760d",
  • "author_name": "string",
  • "author_url": "http://example.com"
}

DestroyBoilerplate

Delete the specified boilerplate

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

Responses

TransferBoilerplate

Authorizations:
Token
path Parameters
uuid
required
string <uuid>
Request Body schema: application/json
required
organisation
required
string <uuid> (Organisation)

Responses

Request samples

Content type
application/json
{
  • "organisation": "a4b97354-4e56-4723-bc0e-1f22b5fcbed6"
}

Response samples

Content type
application/json
{
  • "organisation": "a4b97354-4e56-4723-bc0e-1f22b5fcbed6"
}

builds

ListBuilds

List builds

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

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

GetBuild

Get the details of a single build

Authorizations:
Token
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "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:
Token
path Parameters
uuid
required
string
Request Body schema: application/json
required
object (BuildCloudevent)

Accepts a cloudevent in the style of cloudevent.io

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

charges

ListCharges

List charges

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

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

GetCharge

Get the details of a single charge

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "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"
}

container-registries

ListContainerRegistries

List container registries

Authorizations:
Token
query Parameters
organisation
string
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

CreateContainerRegistry

Create a new container registry object

Authorizations:
Token
Request Body schema: application/json
required
server
required
string (Server) [ 1 .. 255 ] characters
organisation
required
string <uuid> (Organisation)
username
required
string (Username) non-empty
password
required
string (Password) non-empty

Responses

Request samples

Content type
application/json
{
  • "server": "string",
  • "organisation": "a4b97354-4e56-4723-bc0e-1f22b5fcbed6",
  • "username": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "server": "string",
  • "organisation": "a4b97354-4e56-4723-bc0e-1f22b5fcbed6"
}

GetContainerRegistry

Get the details of a single container registry

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

A UUID string identifying this Container Registry.

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "server": "string",
  • "organisation": "a4b97354-4e56-4723-bc0e-1f22b5fcbed6"
}

UpdateContainerRegistry

Replace the specified container registry

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

A UUID string identifying this Container Registry.

Request Body schema: application/json
required
server
required
string (Server) [ 1 .. 255 ] characters
organisation
required
string <uuid> (Organisation)
username
required
string (Username) non-empty
password
required
string (Password) non-empty

Responses

Request samples

Content type
application/json
{
  • "server": "string",
  • "organisation": "a4b97354-4e56-4723-bc0e-1f22b5fcbed6",
  • "username": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "server": "string",
  • "organisation": "a4b97354-4e56-4723-bc0e-1f22b5fcbed6"
}

PartialUpdateContainerRegistry

Partially update the specified container registry

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

A UUID string identifying this Container Registry.

Request Body schema: application/json
required
server
required
string (Server) [ 1 .. 255 ] characters
organisation
required
string <uuid> (Organisation)
username
required
string (Username) non-empty
password
required
string (Password) non-empty

Responses

Request samples

Content type
application/json
{
  • "server": "string",
  • "organisation": "a4b97354-4e56-4723-bc0e-1f22b5fcbed6",
  • "username": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "server": "string",
  • "organisation": "a4b97354-4e56-4723-bc0e-1f22b5fcbed6"
}

DestroyContainerRegistry

Delete the specified container registry

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

A UUID string identifying this Container Registry.

Responses

container-specifications

container-specifications_list

Authorizations:
Token

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "memory": 0,
  • "cpu": 0
}

countries

ListCountries

List countries

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

Content type
application/json
{}

GetCountry

Get the details of a single country

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "short_name": "string",
  • "long_name": "string"
}

cronjobs

ListCronjobs

List cronjobs

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

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

CreateCronjob

Create a new cronjob object

Authorizations:
Token
Request Body schema: application/json
required
command
required
string (Command) non-empty
frequency
required
string (Frequency)
Enum Description
DAILY

Daily

HOURLY

Hourly

EVERY10MIN

Every 10 minutes

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

Content type
application/json
{
  • "command": "string",
  • "frequency": "DAILY",
  • "time": "string",
  • "environment": "fafd1151-c401-4fdd-ac01-03d8e7a57166",
  • "custom_timeout": 2147483647
}

Response samples

Content type
application/json
{
  • "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:
Token
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "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:
Token
path Parameters
uuid
required
string
Request Body schema: application/json
required
command
required
string (Command) non-empty
frequency
required
string (Frequency)
Enum Description
DAILY

Daily

HOURLY

Hourly

EVERY10MIN

Every 10 minutes

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

Content type
application/json
{
  • "command": "string",
  • "frequency": "DAILY",
  • "time": "string",
  • "custom_timeout": 2147483647
}

Response samples

Content type
application/json
{
  • "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:
Token
path Parameters
uuid
required
string
Request Body schema: application/json
required
command
required
string (Command) non-empty
frequency
required
string (Frequency)
Enum Description
DAILY

Daily

HOURLY

Hourly

EVERY10MIN

Every 10 minutes

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

Content type
application/json
{
  • "command": "string",
  • "frequency": "DAILY",
  • "time": "string",
  • "custom_timeout": 2147483647
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "command": "string",
  • "frequency": "DAILY",
  • "time": "string",
  • "environment": "fafd1151-c401-4fdd-ac01-03d8e7a57166",
  • "custom_timeout": 2147483647
}

DestroyCronjob

Delete the specified cronjob

Authorizations:
Token
path Parameters
uuid
required
string

Responses

GetCronjobLogs

Authorizations:
Token
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "started_at": "2019-08-24T14:15:22Z",
  • "finished_at": "2019-08-24T14:15:22Z",
  • "exit_code": 0
}

deployments

ListDeployments

List deployments

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

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

CreateDeployment

Create a new deployment object

Authorizations:
Token
Request Body schema: application/json
required
environment
required
string <uuid> (Environment)
build_mode
string (Build mode)
Default: "AUTO"
Enum Description
AUTO

Build a new container image if there are new commits, otherwise reuse the latest one.

ADOPT

Use the latest container image.

FORCE

Build a new container image.

copy_from
string <uuid> (Copy from)
adopt_deployment
string <uuid> (Adopt deployment)
provision_services
boolean (Provision services)
Default: true

Responses

Request samples

Content type
application/json
{
  • "environment": "fafd1151-c401-4fdd-ac01-03d8e7a57166",
  • "build_mode": "AUTO",
  • "copy_from": "144bc18e-5e55-4977-aab4-2906b01f1c12",
  • "adopt_deployment": "1b98127a-735f-4e51-849a-625e5717e523",
  • "provision_services": true
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "environment": "fafd1151-c401-4fdd-ac01-03d8e7a57166",
  • "build_mode": "AUTO",
  • "copy_from": "144bc18e-5e55-4977-aab4-2906b01f1c12",
  • "adopt_deployment": "1b98127a-735f-4e51-849a-625e5717e523",
  • "provision_services": true
}

CreateDeploymentsInBulk

Authorizations:
Token
query Parameters
limit
integer
build_mode
string
Default: "AUTO"
Enum: "AUTO" "ADOPT" "FORCE"
adopt_deployment
string <uuid>
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

Content type
application/json
{ }

GetDeployment

Get the details of a single deployment

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "environment": "fafd1151-c401-4fdd-ac01-03d8e7a57166",
  • "region": "string",
  • "org_membership": "052d699a-f769-42f1-9cac-4bfd43f3660b",
  • "started_at": "2019-08-24T14:15:22Z",
  • "ended_at": "2019-08-24T14:15:22Z",
  • "duration": "string",
  • "status": "string",
  • "is_usable": true,
  • "success": true,
  • "git_commit": "string",
  • "environment_variables": [
    ],
  • "percent": "string"
}

PartialUpdateDeployment

Partially update the specified deployment

Authorizations:
Token
path Parameters
uuid
required
string <uuid>
Request Body schema: application/json
required
status
string (Status)
is_usable
boolean (Is usable)
success
boolean or null (Success)

Responses

Request samples

Content type
application/json
{
  • "status": "string",
  • "is_usable": true,
  • "success": true
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "environment": "fafd1151-c401-4fdd-ac01-03d8e7a57166",
  • "region": "string",
  • "org_membership": "052d699a-f769-42f1-9cac-4bfd43f3660b",
  • "started_at": "2019-08-24T14:15:22Z",
  • "ended_at": "2019-08-24T14:15:22Z",
  • "duration": "string",
  • "status": "string",
  • "is_usable": true,
  • "success": true,
  • "git_commit": "string",
  • "environment_variables": [
    ],
  • "percent": "string"
}

GetDeploymentEnvironmentVariables

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "environment": "fafd1151-c401-4fdd-ac01-03d8e7a57166",
  • "region": "string",
  • "org_membership": "052d699a-f769-42f1-9cac-4bfd43f3660b",
  • "started_at": "2019-08-24T14:15:22Z",
  • "ended_at": "2019-08-24T14:15:22Z",
  • "duration": "string",
  • "status": "string",
  • "is_usable": true,
  • "success": true,
  • "git_commit": "string",
  • "environment_variables": {
    }
}

GetDeploymentLogs

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "logs": "string"
}

domains

ListDomains

List domains

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

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

CreateDomain

Create a new domain object

Authorizations:
Token
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters
environment
required
string <uuid> (Environment)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "environment": "fafd1151-c401-4fdd-ac01-03d8e7a57166"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "environment": "fafd1151-c401-4fdd-ac01-03d8e7a57166"
}

GetDomain

Get the details of a single domain

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "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",
  • "additional_actions": [
    ],
  • "domain_config": {
    },
  • "state": "UNKNOWN",
  • "state_message": "string"
}

UpdateDomain

Replace the specified domain

Authorizations:
Token
path Parameters
uuid
required
string <uuid>
Request Body schema: application/json
required
is_redirect_to_primary
boolean (Is redirect to primary)
object (Domain config)

Responses

Request samples

Content type
application/json
{
  • "is_redirect_to_primary": true,
  • "domain_config": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "is_redirect_to_primary": true,
  • "domain_config": {
    }
}

PartialUpdateDomain

Partially update the specified domain

Authorizations:
Token
path Parameters
uuid
required
string <uuid>
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "is_redirect_to_primary": true,
  • "domain_config": {
    }
}

DestroyDomain

Delete the specified domain

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

Responses

AdditionalDomainAction

Authorizations:
Token
path Parameters
uuid
required
string <uuid>
domain_action
required
string
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "data": { }
}

MakePrimaryDomain

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

Responses

ToggleRedirectDomain

Authorizations:
Token
path Parameters
uuid
required
string <uuid>
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

TransferDomain

Authorizations:
Token
path Parameters
uuid
required
string <uuid>
Request Body schema: application/json
required
target_environment
required
string <uuid> (Target environment)

Responses

Request samples

Content type
application/json
{
  • "target_environment": "3f17d230-ecb9-46b7-b3d9-8f7ccc5b2664"
}

Response samples

Content type
application/json
{
  • "target_environment": "3f17d230-ecb9-46b7-b3d9-8f7ccc5b2664"
}

environment-metric-metadata

ListEnvironmentMetricMetadata

List environment metric metadata

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

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

GetEnvironmentMetricMetadata

Get the details of a single environment metric metadata

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

A UUID string identifying this environment metric.

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "identifier": "string",
  • "title": "string",
  • "description": "string",
  • "chart_display": "line",
  • "unit": "string",
  • "unit_numerator": "string",
  • "unit_denominator": "string"
}

environment-variables

ListEnvironmentVariables

List environment variables

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

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

CreateEnvironmentVariable

Create a new environment variable object

Authorizations:
Token
Request Body schema: application/json
required
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

Content type
application/json
{
  • "name": "string",
  • "environment": "fafd1151-c401-4fdd-ac01-03d8e7a57166",
  • "value": "string",
  • "is_sensitive": true,
  • "is_pattern_replacement_active": true
}

Response samples

Content type
application/json
{
  • "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:
Token
path Parameters
uuid
required
string <uuid>

A UUID string identifying this Environment variable.

Responses

Response samples

Content type
application/json
{
  • "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:
Token
path Parameters
uuid
required
string <uuid>

A UUID string identifying this Environment variable.

Request Body schema: application/json
required
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

Content type
application/json
{
  • "name": "string",
  • "value": "string",
  • "is_pattern_replacement_active": true
}

Response samples

Content type
application/json
{
  • "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:
Token
path Parameters
uuid
required
string <uuid>

A UUID string identifying this Environment variable.

Request Body schema: application/json
required
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

Content type
application/json
{
  • "name": "string",
  • "value": "string",
  • "is_pattern_replacement_active": true
}

Response samples

Content type
application/json
{
  • "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
}

DestroyEnvironmentVariable

Delete the specified environment variable

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

A UUID string identifying this Environment variable.

Responses

MoveAfterEnvironmentVariable

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

A UUID string identifying this Environment variable.

Request Body schema: application/json
required
target
required
string <uuid> (Target)

Responses

Request samples

Content type
application/json
{
  • "target": "65a17d54-9c67-4477-8b80-d3f97e165aa5"
}

Response samples

Content type
application/json
{
  • "target": "65a17d54-9c67-4477-8b80-d3f97e165aa5"
}

MoveBeforeEnvironmentVariable

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

A UUID string identifying this Environment variable.

Request Body schema: application/json
required
target
required
string <uuid> (Target)

Responses

Request samples

Content type
application/json
{
  • "target": "65a17d54-9c67-4477-8b80-d3f97e165aa5"
}

Response samples

Content type
application/json
{
  • "target": "65a17d54-9c67-4477-8b80-d3f97e165aa5"
}

environments

ListEnvironments

List environments

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

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

CreateEnvironment

Create a new environment object

Authorizations:
Token
Request Body schema: application/json
required
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

Content type
application/json
{
  • "application": "2b22d485-f04e-492b-b364-e14f8506726a",
  • "slug": "string",
  • "branch": "string"
}

Response samples

Content type
application/json
{
  • "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:
Token
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "application": {
    },
  • "slug": "string",
  • "branch": "string",
  • "is_production_grade": true,
  • "pending_commits_lookup": "string",
  • "has_pending_commits": true,
  • "deployed_url": "string",
  • "last_finished_deployment": {
    },
  • "currently_running_deployment": {
    },
  • "currently_released_deployment": {
    },
  • "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": [
    ],
  • "built_in_environment_variables": [
    ]
}

UpdateEnvironment

Replace the specified environment

Authorizations:
Token
path Parameters
uuid
required
string
Request Body schema: application/json
required
branch
required
string (Branch) non-empty

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "branch": "string"
}

PartialUpdateEnvironment

Partially update the specified environment

Authorizations:
Token
path Parameters
uuid
required
string
Request Body schema: application/json
required
branch
required
string (Branch) non-empty

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "branch": "string"
}

DestroyEnvironment

Delete the specified environment

Authorizations:
Token
path Parameters
uuid
required
string

Responses

CopyEnvironment

Authorizations:
Token
path Parameters
uuid
required
string
Request Body schema: application/json
required
new_slug
required
string (New slug) [ 1 .. 255 ] characters ^[0-9a-z](-*[0-9a-z])*$

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "application": {
    },
  • "slug": "string",
  • "branch": "string",
  • "is_production_grade": true,
  • "pending_commits_lookup": "string",
  • "has_pending_commits": true,
  • "deployed_url": "string",
  • "last_finished_deployment": {
    },
  • "currently_running_deployment": {
    },
  • "currently_released_deployment": {
    },
  • "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": [
    ],
  • "built_in_environment_variables": [
    ]
}

GetEnvironmentLogs

Authorizations:
Token
path Parameters
uuid
required
string
query Parameters
from_ts
string <date-time>
to_ts
string <date-time>
service
string non-empty
container
string non-empty
version
string non-empty
action
string non-empty
search_query
string [ 3 .. 32 ] characters
search_before
string non-empty
search_after
string non-empty

Responses

Response samples

Content type
application/json
{
  • "next": "string",
  • "previous": "string",
  • "results": [
    ]
}

GetEnvironmentLogsOccurrence

Authorizations:
Token
path Parameters
uuid
required
string
query Parameters
from_ts
string <date-time>
to_ts
string <date-time>
service
string non-empty
container
string non-empty
version
string non-empty
action
string non-empty
search_query
string [ 3 .. 32 ] characters
number_of_buckets
integer [ 1 .. 30 ]
Default: 30

Number of uniformly distributed time-range buckets to put the found logs to.

Responses

Response samples

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

GetEnvironmentMetrics

Authorizations:
Token
path Parameters
uuid
required
string
query Parameters
metric
required
Array of strings or null <slug> unique [ items <slug >^[-a-zA-Z0-9_]+$ ]
time_window_preset
string
Enum: "1h" "6h" "12h" "24h" "7d"
from_ts
string
to_ts
string

Responses

Response samples

Content type
application/json
{
  • "metrics": {
    },
  • "from_ts": "string",
  • "to_ts": "string",
  • "interval": 0
}

StopEnvironment

Stops the running environment instances.

Authorizations:
Token
path Parameters
uuid
required
string

Responses

invoice-items

ListInvoiceItems

List invoice items

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

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

GetInvoiceItem

Get the details of a single invoice item

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "item_id": 2147483647,
  • "item_name": "string",
  • "item_class_name": "string",
  • "item_url": "string",
  • "item_obj_archived": "string",
  • "duration": "string",
  • "options": "string",
  • "is_website_additional_service": "string",
  • "invoice": "f5072b7b-65cb-48aa-bf69-c999195da70c",
  • "title": "string",
  • "start": "2019-08-24T14:15:22Z",
  • "end": "2019-08-24T14:15:22Z",
  • "total": "string"
}

invoices

ListInvoices

List invoices

Authorizations:
Token
query Parameters
id
number
organisation
string
open
boolean
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

GetInvoice

Get the details of a single invoice

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "number": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "period": "string",
  • "billing_currency": "string",
  • "charge_total": "string",
  • "status": "DRAFT",
  • "charge_date": "2019-08-24",
  • "organisation": "a4b97354-4e56-4723-bc0e-1f22b5fcbed6",
  • "receipt": "http://example.com",
  • "payment_methods": "string",
  • "charge_info": "string",
  • "extra_info": "string"
}

licenses

ListLicenses

List licenses

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

Content type
application/json
{}

maintenance-runs

ListMaintenanceRuns

List maintenance runs

Authorizations:
Token
query Parameters
website
string
status
string
Enum: "UPCOMING" "QUEUED" "COMPLETED" "RUNNING"
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

GetMaintenanceRun

Get the details of a single maintenance run

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "pk": 0,
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "runbook": {
    },
  • "website": 0,
  • "application": "string",
  • "can_run": "string",
  • "can_skip": "string",
  • "can_cancel": "string",
  • "estimated_execution_time": "string",
  • "running": "string",
  • "completed": "string",
  • "window": {
    },
  • "scheduled_window": {
    },
  • "execution_window": {
    },
  • "logs": [
    ]
}

CancelMaintenanceRun

Authorizations:
Token
path Parameters
uuid
required
string <uuid>
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

RunMaintenanceRun

Authorizations:
Token
path Parameters
uuid
required
string <uuid>
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

SkipMaintenanceRun

Authorizations:
Token
path Parameters
uuid
required
string <uuid>
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

patches

ListPatches

List patches

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

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

CreatePatch

Create a new patch object

Authorizations:
Token
Request Body schema: application/json
required
message
required
string (Message) non-empty
environment
required
string <uuid> (Environment)

Responses

Request samples

Content type
application/json
{
  • "message": "string",
  • "environment": "fafd1151-c401-4fdd-ac01-03d8e7a57166"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "created_at": "2019-08-24T14:15:22Z",
  • "callback_received_at": "2019-08-24T14:15:22Z",
  • "applied_at": "2019-08-24T14:15:22Z",
  • "body": "string",
  • "author": 0,
  • "message": "string",
  • "environment": "fafd1151-c401-4fdd-ac01-03d8e7a57166",
  • "callback_url": "string"
}

GetPatch

Get the details of a single patch

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

A UUID string identifying this Patch.

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "created_at": "2019-08-24T14:15:22Z",
  • "callback_received_at": "2019-08-24T14:15:22Z",
  • "applied_at": "2019-08-24T14:15:22Z",
  • "author": 0,
  • "environment": "fafd1151-c401-4fdd-ac01-03d8e7a57166",
  • "message": "string",
  • "body": "string"
}

UpdatePatch

Replace the specified patch

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

A UUID string identifying this Patch.

Request Body schema: application/json
required
message
required
string (Message) non-empty
environment
required
string <uuid> (Environment)

Responses

Request samples

Content type
application/json
{
  • "message": "string",
  • "environment": "fafd1151-c401-4fdd-ac01-03d8e7a57166"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "created_at": "2019-08-24T14:15:22Z",
  • "callback_received_at": "2019-08-24T14:15:22Z",
  • "applied_at": "2019-08-24T14:15:22Z",
  • "body": "string",
  • "author": 0,
  • "message": "string",
  • "environment": "fafd1151-c401-4fdd-ac01-03d8e7a57166",
  • "callback_url": "string"
}

PartialUpdatePatch

Populate the patch body

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

A UUID string identifying this Patch.

Request Body schema: application/json
required
body
required
string (Body)

Responses

Request samples

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

Response samples

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

DestroyPatch

Delete the specified patch

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

A UUID string identifying this Patch.

Responses

ApplyPatch

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

A UUID string identifying this Patch.

Responses

Response samples

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

regions

ListRegions

List regions

Authorizations:
Token
query Parameters
uuid
string
name
string
short_name
string
organisation
string
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

GetRegion

Get the details of a single region

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "short_name": "string",
  • "short_description_html": "string",
  • "icon": "http://example.com",
  • "icon_dark_mode": "http://example.com",
  • "cloudspace_hash": "string",
  • "is_public": true,
  • "is_default": true,
  • "ram_unit_size": 32767,
  • "ram_unit_price": "string",
  • "disk_unit_size": 2147483647,
  • "disk_unit_price": "string",
  • "transfer_unit_size": 2147483647,
  • "transfer_unit_price": "string"
}

repositories

ListRepositories

List repositories

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

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

CreateRepository

Create a new repository object

Authorizations:
Token
Request Body schema: application/json
required
organisation
required
string <uuid> (Organisation)
url
required
string (Url) non-empty
username
string (Username) non-empty
password
string (Password) non-empty
github_installation_id
integer (Github installation id)
key_type
string (Key type)
Default: "ED25519"
Enum: "ED25519" "ECDSA" "RSA"

Supported key types for SSH key generation.

Responses

Request samples

Content type
application/json
{
  • "organisation": "a4b97354-4e56-4723-bc0e-1f22b5fcbed6",
  • "url": "string",
  • "username": "string",
  • "password": "string",
  • "github_installation_id": 0,
  • "key_type": "ED25519"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "organisation": "a4b97354-4e56-4723-bc0e-1f22b5fcbed6",
  • "url": "string",
  • "username": "string",
  • "password": "string",
  • "github_installation_id": 0,
  • "auth_info": "string",
  • "key_type": "ED25519"
}

GetRepository

Get the details of a single repository

Authorizations:
Token
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "organisation": "a4b97354-4e56-4723-bc0e-1f22b5fcbed6",
  • "dsn": "http://example.com",
  • "authentication_type": "USERPASS",
  • "is_read_only": true,
  • "authentication_config": {
    },
  • "last_pull_success": true,
  • "last_pulled_at": "2019-08-24T14:15:22Z",
  • "last_push_success": true,
  • "last_pushed_at": "2019-08-24T14:15:22Z",
  • "state": "UNKNOWN",
  • "state_message": "string"
}

UpdateRepository

Replace the specified repository

Authorizations:
Token
path Parameters
uuid
required
string
Request Body schema: application/json
required
authentication_type
required
string (Authentication type)
Enum Description
USERPASS

Username and Password

KEYPAIR

Keypair

GITHUB_APP

Github App

authentication_config
object (Authentication config)

Responses

Request samples

Content type
application/json
{
  • "authentication_type": "USERPASS",
  • "authentication_config": { }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "authentication_type": "USERPASS",
  • "authentication_config": { }
}

PartialUpdateRepository

Partially update the specified repository

Authorizations:
Token
path Parameters
uuid
required
string
Request Body schema: application/json
required
authentication_type
required
string (Authentication type)
Enum Description
USERPASS

Username and Password

KEYPAIR

Keypair

GITHUB_APP

Github App

authentication_config
object (Authentication config)

Responses

Request samples

Content type
application/json
{
  • "authentication_type": "USERPASS",
  • "authentication_config": { }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "authentication_type": "USERPASS",
  • "authentication_config": { }
}

DestroyRepository

Delete the specified repository

Authorizations:
Token
path Parameters
uuid
required
string

Responses

CheckRepository

Authorizations:
Token
path Parameters
uuid
required
string
Request Body schema: application/json
required
migrate
boolean (Migrate)
Default: false
branch
string (Branch) non-empty
Default: "main"

Responses

Request samples

Content type
application/json
{
  • "migrate": false,
  • "branch": "main"
}

Response samples

Content type
application/json
{
  • "status": true,
  • "message": "string",
  • "code": "string"
}

GetRepositoryCommits

Authorizations:
Token
path Parameters
uuid
required
string
query Parameters
lookup
required
string non-empty

The lookup is a git revision range in the format of https://git-scm.com/docs/gitrevisions#_specifying_ranges.

Responses

Response samples

Content type
application/json
{}

GetRepositoryEndpoint

Authorizations:
Token
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "dsn": "http://example.com",
  • "connection_info": "string",
  • "authentication_type": "USERPASS",
  • "authentication_info": "string"
}

If applicable, generate a new public / private keypair.

Returns None for HTTPS authentication.

Authorizations:
Token
path Parameters
uuid
required
string
Request Body schema: application/json
required
key_type
string (Key type)
Default: "ED25519"
Enum: "ED25519" "ECDSA" "RSA"

Supported key types for SSH key generation.

Responses

Request samples

Content type
application/json
{
  • "key_type": "ED25519"
}

Response samples

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

Cleans the local repository (delete all unwatched files) and makes a pull from the repository.

On conflict, the remote information will be used and local conflicting commits will be discarded.

Authorizations:
Token
path Parameters
uuid
required
string
Request Body schema: application/json
required
object (RepositoryPull)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "status": true,
  • "message": "string",
  • "code": "string"
}

ResetRepositoryToOrigin

Hard resets the local repository copy to back to origin.

Authorizations:
Token
path Parameters
uuid
required
string
Request Body schema: application/json
required
object (ResetRepositoryToOrigin)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "status": true,
  • "message": "string",
  • "code": "string"
}

TransferRepository

Authorizations:
Token
path Parameters
uuid
required
string
Request Body schema: application/json
required
organisation
required
string <uuid> (Organisation)

Responses

Request samples

Content type
application/json
{
  • "organisation": "a4b97354-4e56-4723-bc0e-1f22b5fcbed6"
}

Response samples

Content type
application/json
{
  • "organisation": "a4b97354-4e56-4723-bc0e-1f22b5fcbed6"
}

VerifyRepository

Verify push pull permissions on a repository

Authorizations:
Token
path Parameters
uuid
required
string
Request Body schema: application/json
required
object (RepositoryVerify)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "status": true,
  • "message": "string",
  • "code": "string"
}

scheduled-backup-configurations

ListScheduledBackupConfigurations

List scheduled backup configurations

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

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

GetScheduledBackupConfiguration

Get the details of a single scheduled backup configuration

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "identifier": "string",
  • "short_description": "string",
  • "retention_config": "fc93398e-ac85-4aad-89e2-ccdd72073c9f"
}

service-instance-backup-restores

ListServiceInstanceBackupRestores

List service instance backup restores

Authorizations:
Token
query Parameters
uuid
string
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

GetServiceInstanceBackupRestore

Get the details of a single service instance backup restore

Authorizations:
Token
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "backup_restore": "1dc2d530-6494-4e20-aa2a-a6d87328a950",
  • "service_instance_backup": "4161e5a6-3fef-4502-a0fe-dd044768b370",
  • "service_instance": "78fcb6d3-acaa-4596-a622-cccc1d676482",
  • "queued_at": "2019-08-24T14:15:22Z",
  • "started_at": "2019-08-24T14:15:22Z",
  • "ended_at": "2019-08-24T14:15:22Z",
  • "errors": [
    ]
}

service-instance-backups

ListServiceInstanceBackups

List service instance backups

Authorizations:
Token
query Parameters
uuid
Array of strings
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

GetServiceInstanceBackup

Get the details of a single service instance backup

Authorizations:
Token
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "backup": "dbd9d221-8e93-4901-bb73-e2d59863aa61",
  • "service": "string",
  • "service_instance": "string",
  • "service_type": "string",
  • "service_prefix": "string",
  • "size": -9223372036854776000,
  • "errors": [
    ],
  • "queued_at": "2019-08-24T14:15:22Z",
  • "started_at": "2019-08-24T14:15:22Z",
  • "ended_at": "2019-08-24T14:15:22Z",
  • "taken_at": "2019-08-24T14:15:22Z"
}

service-instances

ListServiceInstances

List service instances

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

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

CreateServiceInstance

Create a new service instance object

Authorizations:
Token
Request Body schema: application/json
required
environment
required
string <uuid> (Environment)
prefix
required
string (Prefix) [ 1 .. 32 ] characters
service
required
string <uuid> (Service)

Responses

Request samples

Content type
application/json
{
  • "environment": "fafd1151-c401-4fdd-ac01-03d8e7a57166",
  • "prefix": "string",
  • "service": "cd8c5e52-093e-43db-9c42-184f00e681dd"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "environment": "fafd1151-c401-4fdd-ac01-03d8e7a57166",
  • "prefix": "string",
  • "service": "cd8c5e52-093e-43db-9c42-184f00e681dd"
}

GetServiceInstance

Get the details of a single service instance

Authorizations:
Token
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "environment": "fafd1151-c401-4fdd-ac01-03d8e7a57166",
  • "region": "ac2f330e-0351-4cac-b9d3-953e54b3d1f8",
  • "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
  • "service_status": "NEW",
  • "last_status_update": "2019-08-24T14:15:22Z",
  • "prefix": "DEFAULT",
  • "type": "string",
  • "last_config_update": "2019-08-24T14:15:22Z",
  • "environment_variables": [
    ]
}

UpdateServiceInstance

Replace the specified service instance

Authorizations:
Token
path Parameters
uuid
required
string
Request Body schema: application/json
required
prefix
required
string (Prefix) [ 1 .. 32 ] characters

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "prefix": "string"
}

PartialUpdateServiceInstance

Partially update the specified service instance

Authorizations:
Token
path Parameters
uuid
required
string
Request Body schema: application/json
required
prefix
required
string (Prefix) [ 1 .. 32 ] characters

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "prefix": "string"
}

DestroyServiceInstance

Delete the service instance. Only valid if the instance is not attached or pending attachment.

Authorizations:
Token
path Parameters
uuid
required
string

Responses

AttachServiceInstance

Authorizations:
Token
path Parameters
uuid
required
string

Responses

DetachServiceInstance

Authorizations:
Token
path Parameters
uuid
required
string

Responses

ProvisionServiceInstance

Trigger provisioning of this service instance. Only valid if the state is NEW or PROVISIONING_FAILED, and the environment is not currently being deployed.

Authorizations:
Token
path Parameters
uuid
required
string

Responses

services

ListServices

List services

Authorizations:
Token
query Parameters
name
string
type
string
identifier
string
is_backupable
boolean
is_self_manageable
boolean
region
string
website
string

Limit to services available to the given application.

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

GetService

Get the details of a single service

Authorizations:
Token
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "type": "string",
  • "description": "string",
  • "is_backupable": true,
  • "is_self_manageable": true,
  • "identifier": "string",
  • "icon": "http://example.com"
}

webhooks

ListWebhooks

List webhooks

Authorizations:
Token
query Parameters
repository
string
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

CreateWebhook

Create a new webhook object

Authorizations:
Token
Request Body schema: application/json
required
provider
required
string (Provider)
Enum Description
GITLAB

Gitlab

GITHUB

Github

BITBUCKET

Bitbucket

repository
required
string <uuid> (Repository)

Responses

Request samples

Content type
application/json
{
  • "provider": "GITLAB",
  • "repository": "e3d1beef-8819-44ce-aeb0-6d1f16e4ee3b"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "provider": "GITLAB",
  • "repository": "e3d1beef-8819-44ce-aeb0-6d1f16e4ee3b"
}

GetWebhook

Get the details of a single webhook

Authorizations:
Token
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "repository": "e3d1beef-8819-44ce-aeb0-6d1f16e4ee3b",
  • "provider_class": "GITLAB",
  • "provider_config": { },
  • "trigger_url": "http://example.com",
  • "last_dispatch_at": "2019-08-24T14:15:22Z",
  • "last_dispatch_success": true,
  • "last_dispatch_message": "string",
  • "date_created": "2019-08-24T14:15:22Z",
  • "date_modified": "2019-08-24T14:15:22Z"
}

UpdateWebhook

Replace the specified webhook

Authorizations:
Token
path Parameters
uuid
required
string
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

PartialUpdateWebhook

Partially update the specified webhook

Authorizations:
Token
path Parameters
uuid
required
string
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

DestroyWebhook

Delete the specified webhook

Authorizations:
Token
path Parameters
uuid
required
string

Responses

GenerateWebhookSecret

Generate a new secret for a webhook and returns it

Authorizations:
Token
path Parameters
uuid
required
string
Request Body schema: application/json
required
object (GenerateWebhookSecret)

Responses

Request samples

Content type
application/json
{ }

Response samples

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

WebhookRemoteInstall

Try to setup the webhook on the remote automatically. This currently only works for Github.

Authorizations:
Token
path Parameters
uuid
required
string
Request Body schema: application/json
required
object (WebhookRemoteInstall)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Trigger the webhook.

This function is publicly available and is the same endpoint for multiple different types of webhooks (e.g. Github, Gitlab, Bitbucket).

Authorizations:
Token
path Parameters
uuid
required
string
Request Body schema: application/json
required
object (WebhookTrigger)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

whoami

whoami_list

Authorizations:
Token

Responses