Download a backup

Stream a ready backup file. Composite backups download as ZIP files; incomplete historical file inventories return a conflict error.

GET/api/customer/v1/projects/{projectId}/backups/{policyId}/artifacts/{artifactId}/download

Permission: secrets:read
Operation ID: downloadBackupArtifact

Path parameters

Name	Value
`projectId`	Required resource ID from an earlier API response.
`policyId`	Required resource ID from an earlier API response.
`artifactId`	Required resource ID from an earlier API response.

Example request

Set HCODE_BASE_URL and HCODE_API_KEY as shown in Getting started. Replace resource variables with your own IDs.

curl --request GET "$HCODE_BASE_URL/api/customer/v1/projects/${PROJECT_ID}/backups/${POLICY_ID}/artifacts/${ARTIFACT_ID}/download" \
  --header "Authorization: Bearer $HCODE_API_KEY" \
  --output ./backup.bin

Response

The response contains file bytes. A composite backup is a ZIP file; a single-object backup is a dump. Use the response's Content-Type and Content-Disposition when saving it.

See errors and retries for failure responses.