API Resources

Admin - Data Dumps API

Manage data dumps. Note that currently, creating a data dump replaces existing data dumps, so an account will only have one at a time.

Interfaces

Object Synopses

DataDump

  • status String

    Dump status

  • date DateTime

    Dump date

List data dumps

GET /api/admin/data_dumps

Response Codes

  • 200 OK
  • 304 Not Modified

Example Response

{
  "meta": {},
  "data_dumps": [
    {
      "status": "complete",
      "date": "2015-11-12T19:03:37Z"
    }
  ]
}

Create a data dump

POST /api/admin/data_dumps

Response Codes

  • 200 OK

Parameters

  • only Array

    Body parameter. List of model names to include in the dump. E.g. [“users”, “course_templates”]

Example Response

{
  "meta": {},
  "data_dumps": [
    {
      "status": "pending",
      "date": "2015-11-12T19:03:37Z"
    }
  ]
}

Download a data dump

GET /api/admin/data_dumps/download

Redirects to a signed download URL. Returns 404 if there is no completed dump.

Response Codes

  • 302 Found
  • 404 Not Found

Fetch the list of model names that could be included in data dump.

GET /api/admin/data_dumps/model_names

Response Codes

  • 200 Ok

Example Response

{
  "model_names": [
    "users",
    "enrollments",
    "course_templates",
    "..."
  ]
}