Create Backup

post/v1/graphs/{graph_id}/operations/create-backup

Not allowed on shared repositories. Only full_dump format supported. Retention capped at tier maximum. Monitor progress via SSE at /v1/operations/{operation_id}/stream.

Idempotency: supply an Idempotency-Key header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.

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

Name	Type	Description
`graph_id`required	string	Graph Id

Header parameters

Name	Type	Description
`Idempotency-Key`optional	string	Idempotency-Key

Request body

Required, application/json.

Field	Type	Description
`backup_format`optional	string	Backup format - only 'full_dump' is supported (complete .lbug database file) Default: `full_dump`
`backup_type`optional	string	Backup type - only 'full' is supported Default: `full`
`retention_days`optional	integer	Retention period in days, further capped to the graph tier's maximum (7/30/90). 90 is the hard ceiling: the storage lifecycle expires backup objects then regardless of the requested value. Default: `30`
`compression`optional	boolean	Enable compression (always enabled for optimal storage) Default: `true`
`schedule`optional	string	Optional cron schedule for automated backups

Example request

curl

curl -X POST "https://api.robosystems.ai/v1/graphs/{graph_id}/operations/create-backup" \
  -H "X-API-Key: $ROBOSYSTEMS_API_KEY" \
  -H "Idempotency-Key: <Idempotency-Key>" \
  -H "Content-Type: application/json" \
  -d '{
  "backup_format": "full_dump",
  "backup_type": "full",
  "retention_days": 30,
  "compression": true,
  "schedule": "string"
}'

Responses

202 Successful Response

Field	Type	Description
`operation`required	string	Kebab-case operation name
`operationId`required	string	op_-prefixed ULID for audit and SSE correlation
`status`required	string	Operation lifecycle state One of: `completed`, `pending`, `failed`
`result`optional	any	Command-specific result payload
`at`required	string	ISO-8601 UTC timestamp
`createdBy`optional	string	User ID that initiated the operation (null for legacy callers)
`idempotentReplay`optional	boolean	True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions. Default: `false`

Status	Meaning
400	Invalid request
401	Authentication required
403	Access denied
404	Resource not found
409	Idempotency-Key conflict — key reused with different body
422	Validation error
429	Rate limit exceeded
500	Internal server error