logo

Backups

Endpoints related to managing container backups.

List Container Backups

Requires the containers-backups-view capability.

SecuritybearerAuth and hubAuth
Request
path Parameters
containerId
required
string

The ID of the requested Container.

query Parameters
include
Array of strings

A comma separated list of include values. Included resources will show up under the root document's include field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.

Items Value: "integrations"
sort
Array of strings

An array of sort values. To sort descending, put a - in front of the value, e.g. -id.

object

In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be page[size]=20&page[number]=2

Responses
200

Returns a list of container backup resources.

default

General error response from the platform

get/v1/containers/{containerId}/backups
Response samples
application/json
{
  • "data": [
    ],
  • "includes": {
    }
}

Get a specific Container Backup

Gets the specified Container Backup.

Requires the containers-backups-view capability.

SecuritybearerAuth and hubAuth
Request
path Parameters
containerId
required
string

The ID of the requested container.

backupId
required
string

The ID for the container backup.

query Parameters
include
Array of strings

A comma separated list of include values. Included resources will show up under the root document's include field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.

Items Value: "integrations"
Responses
200

Returns a Container Backup.

default

General error response from the platform

get/v1/containers/{containerId}/backups/{backupId}
Response samples
application/json
{
  • "data": {
    },
  • "includes": {
    }
}

Create Container Backup Job

Creates a Container Backup Job. Can be used to restore a Container Backup for a given Container Instance.

Requires the containers-backups-manage capability.

SecuritybearerAuth and hubAuth
Request
path Parameters
containerId
required
string

The ID of the requested container.

backupId
required
string

The ID of the backup.

Request Body schema: application/json
action
required
string

The action to take.

Value: "restore"
required
object

Additional information the platform needs to create this Job.

Responses
202

Returns a Job Descriptor.

default

General error response from the platform

post/v1/containers/{containerId}/backups/{backupId}/tasks
Request samples
application/json
{
  • "action": "restore",
  • "contents": {
    }
}
Response samples
application/json
{
  • "data": {
    }
}

List Container Backup Logs

Requires the containers-backups-view capability.

SecuritybearerAuth and hubAuth
Request
path Parameters
containerId
required
string

The ID of the requested container.

backupId
required
string

The ID for the container backup.

Responses
200

Returns a collection of Container Backup Logs.

default

General error response from the platform

get/v1/containers/{containerId}/backups/{backupId}/logs
Response samples
application/json
{
  • "data": [
    ]
}
➔ Next to Zones