Sign in
Environment Backups

Get an environment backup's info

Get the details of a specific backup from an environment using the id of the entry retrieved by the Get backups list endpoint.

get/projects/{projectId}/environments/{environmentId}/backups/{backupId}

Path parameters

projectIdstring required
environmentIdstring required
backupIdstring required

Response

idstring required

The identifier of Backup

created_atstring date-time nullable required

The creation date

updated_atstring date-time nullable required

The update date

attributesobject required

Arbitrary attributes attached to this resource

status'CREATED' | 'DELETING' required

The status of the backup

expires_atstring date-time nullable required

Expiration date of the backup

indexinteger nullable required

The index of this automated backup

commit_idstring required

The ID of the code commit attached to the backup

environmentstring required

The environment the backup belongs to

safeboolean required

Whether this backup was taken in a safe way

size_of_volumesinteger nullable required

Total size of volumes backed up

size_usedinteger nullable required

Total size of space used on volumes backed up

deploymentstring nullable required

The current deployment at the time of backup

restorableboolean required

Whether the backup is restorable

automatedboolean required

Whether the backup is automated

Changes

No recorded changes to this endpoint across all 1 revision of this API.