Skip to main content
POST
/
api
/
v1
/
backups
Create a new backup
curl --request POST \
  --url https://api.scholarlysoftware.com/api/v1/backups \
  --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/...",
      "download_checksum_md5": "d41d8cd98f00b204e9800998ecf8427e",
      "progress": {
        "percentage": 45,
        "completed_tables": 23,
        "total_tables": 50,
        "message": "Processing 23 of 50 tables..."
      }
    },
    "relationships": {}
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Authorization
string
required

Bearer token

Response

backup created

​
data
object
required