Browse the API reference

Get temporary download URL for backup

get/v1/graphs/{graph_id}/backups/{backup_id}/download

Part of Backup.

Generate a temporary download URL for a backup. The filename carries the extension listed as download_extension on the backup: .lbug.zip is a ZIP holding the LadybugDB database file {graph_id}.lbug; .lbug.zst (shared repository snapshots) is a single zstd-compressed database file. Decompress the latter with zstd -d <file>.lbug.zst (install zstd first: brew install zstd, apt-get install zstd, or dnf install zstd) — no --long flag is needed.

Authentication

Authenticate in any one of these ways — not all of them:

  • API key in the X-API-Key header.
  • Bearer token in the Authorization header.

Path parameters

NameTypeDescription
backup_idrequiredstringBackup identifier
graph_idrequiredstringGraph Id

Query parameters

NameTypeDescription
expires_inoptionalintegerURL expiration time in seconds

Default: 3600

Example request

curl
curl -X GET "https://api.robosystems.ai/v1/graphs/{graph_id}/backups/{backup_id}/download" \
  -H "X-API-Key: $ROBOSYSTEMS_API_KEY"

Responses

200 Download URL generated successfully

FieldTypeDescription
download_urlrequiredstring

Pre-signed S3 URL for downloading the backup file

expires_inrequiredinteger

URL expiration time in seconds from now

expires_atrequirednumber

Unix timestamp when the URL expires

backup_idrequiredstring

Backup identifier

graph_idrequiredstring

Graph database identifier

StatusMeaning
403Access denied — admin role on the graph, or an eligible repository subscription, is required
404Backup not found
422Validation Error
500Failed to generate download URL