Browse the API reference

List graph database backups

get/v1/graphs/{graph_id}/backups

Part of Backup.

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
graph_idrequiredstringGraph Id

Query parameters

NameTypeDescription
limitoptionalintegerMaximum number of backups to return

Default: 50

offsetoptionalintegerNumber of backups to skip

Default: 0

Example request

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

Responses

200 Successful Response

FieldTypeDescription
backupsrequiredBackupResponse[]

Response model for backup information.

BackupResponse fields
FieldTypeDescription
backup_idrequiredstring
graph_idrequiredstring
backup_formatrequiredstring
backup_typerequiredstring
initiated_byoptionalstring

Who started this backup. 'user' is one you requested and it counts against the tier's daily backup limit; 'scheduled' is taken nightly on your behalf and does not; 'final' is the copy taken when a graph is deprovisioned, so you can still retrieve your data afterwards.

Default: user

memory_includedoptionalboolean

Whether the archive carries this graph's semantic memory store. Null for backups taken before memory was included, which make no claim either way — distinct from false, which means the graph had none.

statusrequiredstring
original_size_bytesrequiredinteger
compressed_size_bytesrequiredinteger
compression_ratiorequirednumber
node_countrequiredinteger
relationship_countrequiredinteger
backup_duration_secondsrequirednumber
compression_enabledrequiredboolean
download_extensionoptionalstring

Extension the download will carry, and therefore how to unpack it: '.lbug.zip' is a ZIP holding the LadybugDB database file, '.lbug.zst' is zstd-compressed (`zstd -d`). Null only when the backup has no stored object yet.

created_atrequiredstring
completed_atrequiredstring
expires_atrequiredstring
total_countrequiredinteger
graph_idrequiredstring
is_shared_repositoryoptionalboolean

Whether this is a shared repository (limits apply)

Default: false

download_quotaoptionalDownloadQuota

Download quota for shared repositories

DownloadQuota fields
FieldTypeDescription
limit_per_monthrequiredinteger

Maximum downloads allowed per month

used_this_monthrequiredinteger

Number of downloads used this month

remainingrequiredinteger

Downloads remaining this month

resets_atrequiredstring (date-time)

When the monthly limit resets (UTC)

StatusMeaning
400Invalid request
401Authentication required
403Access denied
404Resource not found
422Validation Error
429Rate limit exceeded
500Internal server error