Skip to main content
API docs by Redocly

Divio Cloud API - Legacy Resources (v3)

Download OpenAPI specification:Download

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

addon-collaborators

ListAddonCollaborators

List addon collaborators

Authorizations:
Token
query Parameters
addon
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": [
    ]
}

CreateAddonCollaborator

Create a new addon collaborator object

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

Responses

Request samples

Content type
application/json
{
  • "addon": "ce86a799-8c08-4298-8e0b-8c548493890f",
  • "organisation_membership": "89a9a62d-4ccd-419c-bc47-31a3102140bb",
  • "can_write": true
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "addon": "ce86a799-8c08-4298-8e0b-8c548493890f",
  • "organisation_membership": "89a9a62d-4ccd-419c-bc47-31a3102140bb",
  • "can_write": true
}

GetAddonCollaborator

Get the details of a single addon collaborator

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "addon": "ce86a799-8c08-4298-8e0b-8c548493890f",
  • "user": "76f62a58-5404-486d-9afc-07bded328704",
  • "organisation_membership": "89a9a62d-4ccd-419c-bc47-31a3102140bb",
  • "can_write": true
}

UpdateAddonCollaborator

Replace the specified addon 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
{ }

PartialUpdateAddonCollaborator

Partially update the specified addon 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
}

DestroyAddonCollaborator

Delete the specified addon collaborator

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

Responses

addon-release-channels

ListAddonReleaseChannels

List addon release channels

Authorizations:
Token
query Parameters
addon
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": [
    ]
}

GetAddonReleaseChannel

Get the details of a single addon release channel

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "addon": "ce86a799-8c08-4298-8e0b-8c548493890f",
  • "name": "string",
  • "slug": "string",
  • "description": "string",
  • "stability_level": -2147483648
}

addon-versions

ListAddonVersions

List addon versions

Authorizations:
Token
query Parameters
uuid
Array of strings
addon
string
release_channel
string
o
string
Enum: "version" "-version"
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": [
    ]
}

GetAddonVersion

Get the details of a single addon version

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "addon": "ce86a799-8c08-4298-8e0b-8c548493890f",
  • "version": "0.0.0",
  • "timestamp_added": "2019-08-24T14:15:22Z",
  • "uploaded_by": "string",
  • "installation_count": "string",
  • "production_installation_count": 0,
  • "release_channels": [
    ],
  • "annotations": [
    ],
  • "download_url": "string",
  • "changelog": "string"
}

UpdateAddonVersion

Replace the specified addon version

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
{ }

PartialUpdateAddonVersion

Partially update the specified addon version

Authorizations:
Token
path Parameters
uuid
required
string <uuid>
Request Body schema: application/json
required
changelog
string (Changelog)
release_channels
Array of strings <uuid> unique [ items <uuid > ]

Responses

Request samples

Content type
application/json
{
  • "changelog": "string",
  • "release_channels": [
    ]
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "version": "string",
  • "changelog": "string",
  • "release_channels": [
    ]
}

addons

ListAddons

List addons

Authorizations:
Token
query Parameters
organisation
string
application
string
name
string
package_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": [
    ]
}

CreateAddon

Create a new addon object

Authorizations:
Token
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 100 ] characters

Name of the Addon.

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.

license
string or null <uuid> (License)
organisation
required
string <uuid> (Organisation)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "package_name": "string",
  • "license": "0062b866-9a29-4aaa-bcb3-34c1f3d5760d",
  • "organisation": "a4b97354-4e56-4723-bc0e-1f22b5fcbed6"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "package_name": "string",
  • "license": "0062b866-9a29-4aaa-bcb3-34c1f3d5760d",
  • "organisation": "a4b97354-4e56-4723-bc0e-1f22b5fcbed6"
}

GetAddon

Get the details of a single addon

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",
  • "owner_name": "string",
  • "package_name": "string",
  • "is_public": true,
  • "is_system_addon": true,
  • "latest_version": {
    },
  • "owner_display_name": "string",
  • "release_channels": [
    ],
  • "license": "0062b866-9a29-4aaa-bcb3-34c1f3d5760d",
  • "default_release_channel": {
    },
  • "most_stable_release_channel": {
    },
  • "repository_url": "http://example.com",
  • "project_url": "http://example.com",
  • "pypi_url": "http://example.com",
  • "docs_url": "http://example.com",
  • "timestamp_added": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "cloud_ready": true,
  • "compatible_project_types": [
    ],
  • "enable_custom_release_channels": true
}

UpdateAddon

Replace the specified addon

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
{ }

PartialUpdateAddon

Partially update the specified addon

Authorizations:
Token
path Parameters
uuid
required
string <uuid>
Request Body schema: application/json
required
owner_display_name
string (Override Author) <= 255 characters

You can override the author that will be listed. If you leave it empty, we will show your or your organisation's name.

description
string (Description)
license
string <uuid> (License)
repository_url
string <uri> (Repository URL) <= 200 characters

Link to the Addon source (e.g on github or bitbucket)

project_url
string <uri> (Project URL) <= 200 characters

Link to a project page (don't repeat the repository url here)

pypi_url
string <uri> (PyPi URL) <= 200 characters

Link to your package on the Python Package Index PyPi

docs_url
string <uri> (Documentation URL) <= 200 characters

Link to Documentation (e.g on readthedocs.org)

name
required
string (Name) [ 1 .. 100 ] characters

Name of the Addon.

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.

default_release_channel
string <uuid> (Default release channel)
compatible_project_types
Array of strings <uuid> unique [ items <uuid > ]

Responses

Request samples

Content type
application/json
{
  • "owner_display_name": "string",
  • "description": "string",
  • "license": "0062b866-9a29-4aaa-bcb3-34c1f3d5760d",
  • "repository_url": "http://example.com",
  • "project_url": "http://example.com",
  • "pypi_url": "http://example.com",
  • "docs_url": "http://example.com",
  • "name": "string",
  • "package_name": "string",
  • "default_release_channel": "58b578da-0974-4f94-8b40-15bd63f2cee9",
  • "compatible_project_types": [
    ]
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "owner_display_name": "string",
  • "description": "string",
  • "license": "0062b866-9a29-4aaa-bcb3-34c1f3d5760d",
  • "repository_url": "http://example.com",
  • "project_url": "http://example.com",
  • "pypi_url": "http://example.com",
  • "docs_url": "http://example.com",
  • "name": "string",
  • "package_name": "string",
  • "default_release_channel": "58b578da-0974-4f94-8b40-15bd63f2cee9",
  • "compatible_project_types": [
    ]
}

DownloadAddonIncludes

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

Responses

Response samples

Content type
application/json
"string"

PublishAddon

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
{ }

TransferAddon

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"
}

UploadAddon

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
{ }

applications

ListApplications

List applications

Authorizations:
Token
query Parameters
id
number
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": [
    ]
}

GetApplication

Get the details of a single application

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",
  • "base_project_version": "c613b8ec-8da4-41a5-8433-abacff8b415f",
  • "base_project_release_channel": "ac0b8528-2d66-48cb-9e85-55deb6873c22",
  • "addons_feature_available": true,
  • "addons_update_count": 0,
  • "addons_bug_count": 0,
  • "addons_not_configured_count": 0,
  • "compatible_project_types": [
    ]
}

GetAddonForm

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

Responses

Request samples

Content type
application/json
{
  • "version": "8b898373-21c7-4028-b85f-cc5068e68df9"
}

ConfigureAddonInApplication

Authorizations:
Token
path Parameters
uuid
required
string <uuid>
Request Body schema: application/json
required
object (Form data)
addon
required
string <uuid> (Addon)

Responses

Request samples

Content type
application/json
{
  • "form_data": {
    },
  • "addon": "ce86a799-8c08-4298-8e0b-8c548493890f"
}

InstallAddonInApplication

Authorizations:
Token
path Parameters
uuid
required
string <uuid>
Request Body schema: application/json
required
release_channel
required
string <uuid> (Release channel)
version
required
string <uuid> (Version)
object (Form data)
without_config
boolean (Without config)

Responses

Request samples

Content type
application/json
{
  • "release_channel": "526faf99-721b-4439-9e5b-1dae4bcad311",
  • "version": "8b898373-21c7-4028-b85f-cc5068e68df9",
  • "form_data": {
    },
  • "without_config": true
}

UninstallAddonFromApplication

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

Responses

Request samples

Content type
application/json
{
  • "addon": "ce86a799-8c08-4298-8e0b-8c548493890f"
}

GetApplicationAnnotations

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

Responses

Response samples

Content type
application/json
{}

GetApplicationRecentAsynchronousTasks

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "running": [
    ],
  • "recently_finished": [
    ]
}

base-project-release-channels

ListBaseProjectReleaseChannels

List base project release channels

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": [
    ]
}

GetBaseProjectReleaseChannel

Get the details of a single base project release channel

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "slug": "string",
  • "baseproject": "3464a42f-dba4-4595-8940-8ce5c04d9262",
  • "description": "string",
  • "order": -2147483648
}

base-project-versions

ListBaseProjectVersions

List base project versions

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": [
    ]
}

GetBaseProjectVersion

Get the details of a single base project version

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "baseproject": "3464a42f-dba4-4595-8940-8ce5c04d9262",
  • "active": true,
  • "description": "string",
  • "changelog_url": "http://example.com",
  • "version": "string"
}

base-projects

ListBaseProjects

List base projects

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": [
    ]
}

GetBaseProject

Get the details of a single base project

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",
  • "order": -2147483648,
  • "icon": "http://example.com",
  • "identifier": "string",
  • "is_public": true
}

environments

ListEnvironments

List environments

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
{}

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": "string",
  • "sharing_url": "http://example.com"
}

GetEnvironmentCommits

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
{}

installed-addons

ListInstalledAddons

List installed addons

Authorizations:
Token
query Parameters
version
string
application
string
addon
string
is_configured
boolean
has_updates
boolean
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": [
    ]
}

GetInstalledAddon

Get the details of a single installed addon

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",
  • "version": {
    },
  • "addon": {
    },
  • "update_exists": "string",
  • "not_configured": "string",
  • "release_channel": {
    },
  • "config": { }
}

UpdateInstalledAddon

Replace the specified installed addon

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
{ }

PartialUpdateInstalledAddon

Partially update the specified installed addon

Authorizations:
Token
path Parameters
uuid
required
string <uuid>
Request Body schema: application/json
required
release_channel
required
string <uuid> (Release channel)
version
required
string <uuid> (Version)

Responses

Request samples

Content type
application/json
{
  • "release_channel": "526faf99-721b-4439-9e5b-1dae4bcad311",
  • "version": "8b898373-21c7-4028-b85f-cc5068e68df9"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "release_channel": "526faf99-721b-4439-9e5b-1dae4bcad311",
  • "version": "8b898373-21c7-4028-b85f-cc5068e68df9"
}

organisations

ListOrganisations

List organisations

Authorizations:
Token
query Parameters
id
number
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
{}

GetOrganisation

Get the details of a single organisation

Authorizations:
Token
path Parameters
uuid
required
string <uuid>

Responses

Response samples

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

project-types

ListProjectTypes

List project types

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": [
    ]
}

GetProjectType

Get the details of a single project type

Authorizations:
Token
path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "identifier": "string",
  • "name": "string",
  • "short_name": "string",
  • "icon_url": "string",
  • "order": -2147483648,
  • "short_description_html": "string",
  • "is_default": true,
  • "is_public": true
}

whoami

whoami_list

Authorizations:
Token

Responses