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

200
default

application/json

{"data": [{"id": "651586fca6078e98982dbd90",
"hub_id": "651586fca6078e98982dbd90",
"container_id": "string",
"instance_id": "string",
"target": {"integration_id": "my-image-source",
"path": "string",
"file_id": "string",
"size": 0
},
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z"
}
}
],
"includes": {"integrations": {"property1": {"id": "651586fca6078e98982dbd90",
"name": "string",
"vendor": "string",
"identifier": "string",
"auth": {"region": "string",
"namespace": "string",
"api_key": "string",
"key_id": "string",
"secret": "string",
"subscription_id": "string",
"client_id": "string",
"base64_config": "string"
},
"extra": {"property1": "string",
"property2": "string"
},
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"hub_id": "651586fca6078e98982dbd90",
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z"
},
"meta": {"definition": {"vendor": "string",
"name": "string",
"supports_verification": true,
"supports_multiple": true,
"features": ["string"
],
"extends": ["string"
],
"extended_configuration": {"options": [{ }
]
},
"fields": {"extra": {"property1": { },
"property2": { }
},
"auth": {"property1": { },
"property2": { }
}
},
"url": "http://example.com",
"public": true,
"usable": true,
"editable": true
}
}
},
"property2": {"id": "651586fca6078e98982dbd90",
"name": "string",
"vendor": "string",
"identifier": "string",
"auth": {"region": "string",
"namespace": "string",
"api_key": "string",
"key_id": "string",
"secret": "string",
"subscription_id": "string",
"client_id": "string",
"base64_config": "string"
},
"extra": {"property1": "string",
"property2": "string"
},
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"hub_id": "651586fca6078e98982dbd90",
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z"
},
"meta": {"definition": {"vendor": "string",
"name": "string",
"supports_verification": true,
"supports_multiple": true,
"features": ["string"
],
"extends": ["string"
],
"extended_configuration": {"options": [{ }
]
},
"fields": {"extra": {"property1": { },
"property2": { }
},
"auth": {"property1": { },
"property2": { }
}
},
"url": "http://example.com",
"public": true,
"usable": true,
"editable": true
}
}
}
}
}
}

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

200
default

application/json

{"data": {"id": "651586fca6078e98982dbd90",
"hub_id": "651586fca6078e98982dbd90",
"container_id": "string",
"instance_id": "string",
"target": {"integration_id": "my-image-source",
"path": "string",
"file_id": "string",
"size": 0
},
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z"
}
},
"includes": {"integrations": {"property1": {"id": "651586fca6078e98982dbd90",
"name": "string",
"vendor": "string",
"identifier": "string",
"auth": {"region": "string",
"namespace": "string",
"api_key": "string",
"key_id": "string",
"secret": "string",
"subscription_id": "string",
"client_id": "string",
"base64_config": "string"
},
"extra": {"property1": "string",
"property2": "string"
},
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"hub_id": "651586fca6078e98982dbd90",
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z"
},
"meta": {"definition": {"vendor": "string",
"name": "string",
"supports_verification": true,
"supports_multiple": true,
"features": ["string"
],
"extends": ["string"
],
"extended_configuration": {"options": [{ }
]
},
"fields": {"extra": {"property1": { },
"property2": { }
},
"auth": {"property1": { },
"property2": { }
}
},
"url": "http://example.com",
"public": true,
"usable": true,
"editable": true
}
}
},
"property2": {"id": "651586fca6078e98982dbd90",
"name": "string",
"vendor": "string",
"identifier": "string",
"auth": {"region": "string",
"namespace": "string",
"api_key": "string",
"key_id": "string",
"secret": "string",
"subscription_id": "string",
"client_id": "string",
"base64_config": "string"
},
"extra": {"property1": "string",
"property2": "string"
},
"creator": {"id": "651586fca6078e98982dbd90",
"type": "account"
},
"hub_id": "651586fca6078e98982dbd90",
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z"
},
"meta": {"definition": {"vendor": "string",
"name": "string",
"supports_verification": true,
"supports_multiple": true,
"features": ["string"
],
"extends": ["string"
],
"extended_configuration": {"options": [{ }
]
},
"fields": {"extra": {"property1": { },
"property2": { }
},
"auth": {"property1": { },
"property2": { }
}
},
"url": "http://example.com",
"public": true,
"usable": true,
"editable": true
}
}
}
}
}
}

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

Payload

application/json

{"action": "restore",
"contents": {"instance_id": "string"
}
}

Response samples

202
default

application/json

{"data": {"action": "string",
"job": {"id": "string",
"accepted": true,
"queue": "string",
"schedule": "2021-01-30T08:30:00Z",
"parallel": {"sub_queue": "string",
"tasks": true
},
"tasks": [{"caption": "string",
"header": "string",
"steps": [{"caption": "string",
"description": "string",
"started": "2021-01-30T08:30:00Z",
"completed": "2021-01-30T08:30:00Z"
}
],
"input": {"property1": null,
"property2": null
}
}
]
}
}
}

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

200
default

application/json

{"data": [{"id": "651586fca6078e98982dbd90",
"container_id": "string",
"instance_id": "string",
"backup_id": "string",
"hub_id": "651586fca6078e98982dbd90",
"type": "restore",
"log": "string",
"error": {"message": "string",
"message_internal": "string",
"stack": [{"file": "string",
"function": "string",
"line": 0
}
]
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z"
}
}
]
}

➔ Next to Zones