NAV
shell ruby python csharp php

Backup

The Backup object

The Backup object looks like this in JSON:

{
    "object": "backup",
    "id": 6,
    "status": "in_progress",
    "started_at": "2020-11-16T20:00:01+00:00",
    "completed_at": null,
    "on_complete_email": "0",
    "on_complete_url": null,
    "added_at": "2020-11-10T19:59:25+00:00",
    "added_by_id": 1,
    "deleted_at": null,
    "sandbox": true
}
Attribute Required Data Type
id Yes int
status Yes enum (waiting, in_progress, completed, deleted, error)
started_at No datetime
completed_at No datetime
on_complete_email No text (300)
on_complete_url No text (1000)
added_at No datetime
added_by_id No int
deleted_at No datetime
sandbox No bool

index

Example code to call this method:

curl "https://yourschool.populiweb.com/api2/backups" \
-H "Content-Type: application/json" \ 
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \ 
-X GET

require 'httparty'
response = HTTParty.get(
 'https://yourschool.populiweb.com/api2/backups',
 headers: {
  'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
 },
)
puts response.body

import requests
response = requests.get(
 'https://yourschool.populiweb.com/api2/backups',
 headers={
  'Authorization': 'Bearer YOUR_POPULI_API_KEY'
 },
)
print(response.json())

using Newtonsoft.Json;
using RestSharp;
var client = new RestClient();
var request = new RestRequest(new Uri("https://yourschool.populiweb.com/api2/backups"), Method.Get);
request.AddHeader("Authorization", "Bearer YOUR_POPULI_API_KEY");
var response = client.Execute(request);
var response_object = JsonConvert.DeserializeObject(response.Content);
Console.Write(response_object);

$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, 'https://yourschool.populiweb.com/api2/backups');
curl_setopt($curl, CURLOPT_HTTPHEADER, ['Authorization: Bearer YOUR_POPULI_API_KEY']);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
$response = curl_exec($curl);
$response_decoded = json_decode($response);
var_dump($response_decoded);

Example response:

{
    "object": "list",
    "count": 2,
    "results": 2,
    "results_per_page": null,
    "pages": 1,
    "page": 1,
    "offset": 0,
    "has_more": false,
    "data": [
        {
            "object": "backup",
            "id": 6,
            "status": "in_progress",
            "started_at": "2020-11-16T20:00:01+00:00",
            "completed_at": null,
            "on_complete_email": "0",
            "on_complete_url": null,
            "added_at": "2020-11-10T19:59:25+00:00",
            "added_by_id": 1,
            "deleted_at": null
        }
    ],
    "sandbox": true
}

Retrieves all Backup objects.

HTTP Request

GET /backups

Parameters

None

Permissions

Only keys that have been granted Populi Account Administrator permissions may call this method.

show

Example code to call this method:

curl "https://yourschool.populiweb.com/api2/backups/(backup)" \
-H "Content-Type: application/json" \ 
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \ 
-X GET

require 'httparty'
response = HTTParty.get(
 'https://yourschool.populiweb.com/api2/backups/(backup)',
 headers: {
  'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
 },
)
puts response.body

import requests
response = requests.get(
 'https://yourschool.populiweb.com/api2/backups/(backup)',
 headers={
  'Authorization': 'Bearer YOUR_POPULI_API_KEY'
 },
)
print(response.json())

using Newtonsoft.Json;
using RestSharp;
var client = new RestClient();
var request = new RestRequest(new Uri("https://yourschool.populiweb.com/api2/backups/(backup)"), Method.Get);
request.AddHeader("Authorization", "Bearer YOUR_POPULI_API_KEY");
var response = client.Execute(request);
var response_object = JsonConvert.DeserializeObject(response.Content);
Console.Write(response_object);

$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, 'https://yourschool.populiweb.com/api2/backups/(backup)');
curl_setopt($curl, CURLOPT_HTTPHEADER, ['Authorization: Bearer YOUR_POPULI_API_KEY']);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
$response = curl_exec($curl);
$response_decoded = json_decode($response);
var_dump($response_decoded);

Example response:

{
    "object": "backup",
    "id": 6,
    "status": "in_progress",
    "started_at": "2020-11-16T20:00:01+00:00",
    "completed_at": null,
    "on_complete_email": "0",
    "on_complete_url": null,
    "added_at": "2020-11-10T19:59:25+00:00",
    "added_by_id": 1,
    "deleted_at": null,
    "sandbox": true
}

Retrieves a specific Backup object.

HTTP Request

GET /backups/(backup)

Parameters

No additional parameters are needed beyond the ID of the object being requested that appears in the URL.

Permissions

Only keys that have been granted Populi Account Administrator permissions may call this method.

download

curl "https://yourschool.populiweb.com/api2/backups/(backup)/download" \
-H "Content-Type: application/json" \ 
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \ 
-X GET

require 'httparty'
response = HTTParty.get(
 'https://yourschool.populiweb.com/api2/backups/(backup)/download',
 headers: {
  'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
 },
)
puts response.body

import requests
response = requests.get(
 'https://yourschool.populiweb.com/api2/backups/(backup)/download',
 headers={
  'Authorization': 'Bearer YOUR_POPULI_API_KEY'
 },
)
print(response.json())

using Newtonsoft.Json;
using RestSharp;
var client = new RestClient();
var request = new RestRequest(new Uri("https://yourschool.populiweb.com/api2/backups/(backup)/download"), Method.Get);
request.AddHeader("Authorization", "Bearer YOUR_POPULI_API_KEY");
var response = client.Execute(request);
var response_object = JsonConvert.DeserializeObject(response.Content);
Console.Write(response_object);

$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, 'https://yourschool.populiweb.com/api2/backups/(backup)/download');
curl_setopt($curl, CURLOPT_HTTPHEADER, ['Authorization: Bearer YOUR_POPULI_API_KEY']);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
$response = curl_exec($curl);
$response_decoded = json_decode($response);
var_dump($response_decoded);

Example response:

{}

HTTP Request

GET /backups/(backup)/download

Parameters

None

Permissions

Only keys that have been granted Populi Account Administrator permissions may call this method.

most_recent_completed

Example code to call this method:

curl "https://yourschool.populiweb.com/api2/backups/most_recent_completed" \
-H "Content-Type: application/json" \ 
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \ 
-X GET

require 'httparty'
response = HTTParty.get(
 'https://yourschool.populiweb.com/api2/backups/most_recent_completed',
 headers: {
  'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
 },
)
puts response.body

import requests
response = requests.get(
 'https://yourschool.populiweb.com/api2/backups/most_recent_completed',
 headers={
  'Authorization': 'Bearer YOUR_POPULI_API_KEY'
 },
)
print(response.json())

using Newtonsoft.Json;
using RestSharp;
var client = new RestClient();
var request = new RestRequest(new Uri("https://yourschool.populiweb.com/api2/backups/most_recent_completed"), Method.Get);
request.AddHeader("Authorization", "Bearer YOUR_POPULI_API_KEY");
var response = client.Execute(request);
var response_object = JsonConvert.DeserializeObject(response.Content);
Console.Write(response_object);

$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, 'https://yourschool.populiweb.com/api2/backups/most_recent_completed');
curl_setopt($curl, CURLOPT_HTTPHEADER, ['Authorization: Bearer YOUR_POPULI_API_KEY']);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'GET');
$response = curl_exec($curl);
$response_decoded = json_decode($response);
var_dump($response_decoded);

Example response:

{
    "object": "backup",
    "id": 7,
    "status": "completed",
    "started_at": "2020-11-16T20:00:01+00:00",
    "completed_at": null,
    "on_complete_email": "0",
    "on_complete_url": null,
    "added_at": "2020-11-10T19:59:25+00:00",
    "added_by_id": 1,
    "deleted_at": null,
    "sandbox": true
}

HTTP Request

GET /backups/most_recent_completed

Parameters

None

Permissions

Only keys that have been granted Populi Account Administrator permissions may call this method.

request

Example code to call this method:

curl "https://yourschool.populiweb.com/api2/backups/request" \
-H "Content-Type: application/json" \ 
-H "Authorization: Bearer YOUR_POPULI_API_KEY" \ 
-X POST

require 'httparty'
response = HTTParty.post(
 'https://yourschool.populiweb.com/api2/backups/request',
 headers: {
  'Authorization' => 'Bearer YOUR_POPULI_API_KEY'
 },
)
puts response.body

import requests
response = requests.post(
 'https://yourschool.populiweb.com/api2/backups/request',
 headers={
  'Authorization': 'Bearer YOUR_POPULI_API_KEY'
 },
)
print(response.json())

using Newtonsoft.Json;
using RestSharp;
var client = new RestClient();
var request = new RestRequest(new Uri("https://yourschool.populiweb.com/api2/backups/request"), Method.Post);
request.AddHeader("Authorization", "Bearer YOUR_POPULI_API_KEY");
var response = client.Execute(request);
var response_object = JsonConvert.DeserializeObject(response.Content);
Console.Write(response_object);

$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, 'https://yourschool.populiweb.com/api2/backups/request');
curl_setopt($curl, CURLOPT_HTTPHEADER, ['Authorization: Bearer YOUR_POPULI_API_KEY']);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'POST');
$response = curl_exec($curl);
$response_decoded = json_decode($response);
var_dump($response_decoded);

Example response:

{
    "object": "backup",
    "id": 8,
    "status": "waiting",
    "started_at": null,
    "completed_at": null,
    "on_complete_email": null,
    "on_complete_url": null,
    "added_at": "2026-07-25T16:24:09+00:00",
    "added_by_id": 22,
    "deleted_at": null,
    "sandbox": true
}

HTTP Request

POST /backups/request

Parameters

Name Required Data Type Description
on_complete_email No text (300)
on_complete_url No text (1000)

Permissions

Only keys that have been granted Populi Account Administrator permissions may call this method.

shell ruby python csharp php