curl --request GET \
--url https://api.scholarlysoftware.com/api/v1/backups/{id} \
--header 'Authorization: Bearer <token>'{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "backup",
"attributes": {
"status": "completed",
"created_at": "2025-11-18T12:00:00Z",
"updated_at": "2025-11-18T12:05:00Z",
"file_size": 1048576,
"download_url": "https://app.scholarly.edu/rails/active_storage/blobs/...",
"progress": {
"percentage": 45,
"completed_tables": 23,
"total_tables": 50,
"message": "Processing 23 of 50 tables..."
}
},
"relationships": {}
}
}Returns details of a specific backup
curl --request GET \
--url https://api.scholarlysoftware.com/api/v1/backups/{id} \
--header 'Authorization: Bearer <token>'{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "backup",
"attributes": {
"status": "completed",
"created_at": "2025-11-18T12:00:00Z",
"updated_at": "2025-11-18T12:05:00Z",
"file_size": 1048576,
"download_url": "https://app.scholarly.edu/rails/active_storage/blobs/...",
"progress": {
"percentage": 45,
"completed_tables": 23,
"total_tables": 50,
"message": "Processing 23 of 50 tables..."
}
},
"relationships": {}
}
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Bearer token
Backup UUID
backup found
Show child attributes
"backup""backup"
Show child attributes
Current status of the backup (pending, processing, completed, failed)
"completed"
When the backup was requested
"2025-11-18T12:00:00Z"
When the backup was last updated
"2025-11-18T12:05:00Z"
Size of the backup file in bytes (only available when completed)
1048576
URL to download the backup file (only available when completed)
"https://app.scholarly.edu/rails/active_storage/blobs/..."
Progress information for in-progress backups
{
"percentage": 45,
"completed_tables": 23,
"total_tables": 50,
"message": "Processing 23 of 50 tables..."
}