api.spanningbackup.com Open in urlscan Pro
44.218.77.144  Public Scan

Form analysis
0 forms found in the DOM

Text Content

Contact Support

 * Overview
 * Authentication
   * Users
     * unassign
     * get
     * assign
     * list
   * Shared Drives
     * list
     * export
   * Exports
     * initiate
     * list
     * get


OVERVIEW

The Spanning Backup API allows users to execute a small number of administrative
operations. The documentation here describes the interface to our RESTful API.

Please make sure to consult the authentication page for instructions on how to
access the API.


AUTHENTICATION

To access the Spanning Backup API, you will need to obtain an access token
through the Administrator section of the Spanning Backup application. Here is a
direct link.

Spanning Backup services are accessed using HTTP Basic Authentication over
HTTPS, with your domain name being specified as the user name, your access token
being specified as the password and region(US, EU, AP, UK, CA). For example, the
syntax to retrieve a list of users using curl would be similar to:

curl --user {domainName}:{accessToken} https://api-{region}.spanningbackup.com/api/v1/users



Passing an invalid user name/access token pair will result in a response code of
401.


SERVICES

This page will contain an overview of the services we are exposing.


USERS

The Users service provides methods for viewing and managing Spanning Backup
licenses.



OBJECT DEFINITION



{
  "type": "user",
  "email": "{string}",
  "licensed": "{boolean}"
}



Property name Type Description type string The type of the resource: "user".
email string The email address of the user. licensed boolean The user is
assigned a Spanning Backup Standard license. archived boolean The user is
assigned a Spanning Backup Archived license.






METHODS



Name Description unassign Unassigns the specified user's license. get Gets the
specified user. assign Assigns the specified user a license. list Get a list of
users for the caller's domain.




USERS : GET

Gets a user.



HTTP REQUEST

GET https://api-{region}.spanningbackup.com/api/v1/users/{email}




PARAMETERS

Parameter name Type Required Description email string Y The email address of the
user to be retrieved. region string Y The region: US, EU, AP, UK, CA.




RESPONSE

A successful response will return a user object.

STATUS CODES

Status code Description 200 The user information was successfully retrieved. 404
The user does not exist in the caller's domain.




EXAMPLE

curl --user abc.com:{apiToken} -X GET \
    https://api-us.spanningbackup.com/api/v1/users/user1@abc.com


USERS : ASSIGN

Assigns a Spanning Backup license to users. If a single user is not found in the
list of users, that user will be omitted. If all users are not found the result
will be a 404.



HTTP REQUEST

POST https://api-{region}.spanningbackup.com/api/v1/users/assign




PARAMETERS

Parameter name Type Required Description region string Y The region: US, EU, AP,
UK, CA.

BODY PARAMETERS

Parameter name Type Required Description emails array Y A string array of user
emails. Maximum size is 500. licenseType string The type of license that should
be allocated to users: STANDARD or ARCHIVE




RESPONSE

A successful response will object with boolean value as described below.

{
  "licensed": true
}



Property name Type Description licensed boolean True if at least one user has
been assigned a license. This value will be false if the user already had a
license.



STATUS CODES

Status code Description 200 The user's license was successfully added. This
status will be returned even if the user currently has a license. 404 Users were
not found in the caller's domain.




EXAMPLE

curl --user abc.com:{apiToken} -X POST \
    https://api-us.spanningbackup.com/api/v1/users/assign -H \
    "Content-Type: application/json" -d \
    '{
          "emails": ["user@example.com"],
          "licenseType": "STANDARD"
     }'


USERS : UNASSIGN

Unassigns a Spanning Backup license from users. If a single user is not found in
the list of users, that user will be omitted. If all users are not found the
result will be a 404.



HTTP REQUEST

POST https://api-{region}.spanningbackup.com/api/v1/users/unassign




PARAMETERS

Parameter name Type Required Description region string Y The region: US, EU, AP,
UK, CA.

BODY PARAMETERS

Parameter name Type Required Description emails array Y A string array of user
emails. Maximum size is 500.




RESPONSE

A successful response will object with boolean value as described below.

{
  "licensed": false
}



Property name Type Description licensed boolean False if user has been
unassigned a license. This value will also be false if user did not have a
license prior to the call to unassign a license.



STATUS CODES

Status code Description 200 The user's license was successfully removed. This
status will be returned even if the user currently had no license. 404 The user
does not exist in the caller's domain.




EXAMPLE

curl --user abc.com:{apiToken} -X POST \
    https://api-us.spanningbackup.com/api/v1/users/unassign -H \
    "Content-Type: application/json" -d \
    '{
          "emails": ["user@example.com"]
     }'


USERS : LIST

Retrieves a list of users.



HTTP REQUEST

GET https://api-{region}.spanningbackup.com/api/v1/users




PARAMETERS

Parameter name Type Required Description region string Y The region: US, EU, AP,
UK, CA.

QUERY PARAMETERS

Parameter name Type Required Description limit integer N The maximum number of
users to retrieve. Should be greater than zero. pageToken string N PageToken is
a marker used in API pagination to indicate the starting point for the next set
of data. The nextLink URL contains pageToken for the next request, allowing
continuous data fetching. It may also sort the data alphabetically by email.




RESPONSE

A successful response will return a list of user objects as defined below.

{
  "nextLink": "nextLink",
  "items": [
    "user object"
  ]
}



Property name Type Description nextLink string The URL from which the next set
of users should be requested. items list A list of user objects.



STATUS CODES

Status code Description 200 The list of users was successfully retrieved. 400 At
least one query parameter is invalid.




EXAMPLE

curl --user abc.com:{apiToken} -X GET \
    https://api-us.spanningbackup.com/api/v1/users


SHARED DRIVES

The Shared Drive service provides methods for viewing Shared Drives.



OBJECT DEFINITION



{
  "name": "{string}",
  "gid": "{string}",
  "licensed": "{boolean}"
}



Property name Type Description name string The name of shared drive. gid string
The Google Id (GID). licensed boolean Whether or not this shared drive is
licensed






METHODS



Name Description list List the shared drives. export Initiate an export of
shared drive.




SHARED DRIVES : LIST

Retrieves a list of Shared Drives.



HTTP REQUEST

GET https://api-{region}.spanningbackup.com/api/v1/team-drives




PARAMETERS

Parameter name Type Required Description region string Y The region: US, EU, AP,
UK, CA.

QUERY PARAMETERS

Parameter name Type Required Description limit integer Y The maximum number of
shared drives to retrieve. Should be greater than zero. order string Y Order
direction for sorting result. Available values: ASC, DESC. adminEmail string Y
The email address of the administrator who is making the request. pageToken
string N Google Id (GID) of Shared Drive. Parameter helps to offset shared
drives.




RESPONSE

A successful response will return a list of shared drive objects as defined
below.

{
  "pageToken": "offset",
  "drives": [
    "shared drive object"
  ]
}



Property name Type Description pageToken string The GID of shared drive from
which the next set of shared drives should be requested. drives list A list of
shared drive objects.



STATUS CODES

Status code Description 200 The list of shared drives was successfully
retrieved. 400 At least one query parameter is invalid. 403 The admin user is
not an administrator for the domain.




EXAMPLE

curl --user abc.com:{apiToken} -X GET \
    https://api-us.spanningbackup.com/api/v1/team-drives


SHARED DRIVES : EXPORT

Initiates an export of shared drive data.



HTTP REQUEST

POST https://api-{region}.spanningbackup.com/api/v1/team-drives/{gid}/export




PARAMETERS

Parameter name Type Required Description gid string Y The GID(Google Id) of the
shared drive which will be exported. region string Y The region: US, EU, AP, UK,
CA.

FORM PARAMETERS

Parameter name Type Required Description adminEmail string Y The email address
of the administrator who is making the request.




RESPONSE

A successful response will return an object containing the job id(s) of the
export.

[
  {
    "jobId": "{string}"
  }
]



Property name Type Description jobId string A unique identifier for the job.



STATUS CODES

Status code Description 200 The export was successfully initiated. 400 No
backups to export for Shared Drive. 403 The admin user is not an administrator
for the domain. 404 Current Shared drive is not found. 409 An export is already
in progress. Only one export may be in progress for a shared drive at a time.




EXAMPLE

curl --user abc.com:{apiToken} -X POST \
    https://api-us.spanningbackup.com/api/v1/team-drives/asbcs/export \
    --data "adminEmail=admin@abc.com


EXPORTS

The Exports service provides methods for initiating exports and retrieving
export status information.



OBJECT DEFINITION



{
  "jobId": "{string}",
  "email": "{string}",
  "objectType": "{string}",
  "status": "{integer}",
  "message": "{string}",
  "initiatorEmail": "{string}",
  "creationDate": "{integer}",
  "expirationDate": "{integer}",
  "urlInfos": "{[url: string, size: long]}"
}



Property name Type Description jobId string The job identifier. email string The
email address of the user. objectType string The object type of the export.
status integer The current status of the export (0 = RUNNING, 1 = COMPLETED, 2 =
FAILED). message string Additional information. initiatorEmail string The email
of the initiator for the export. creationDate integer The time in milliseconds
at which the export was created. expirationDate integer The time in milliseconds
at which the export expires. After the expiration date, the export, including
status information and the export archive, will no longer be available. urlInfos
array Object containing the archive URLs






METHODS



Name Description initiate Initiate an export of user data. list List the
non-expired exports for a user. get Get an export for a user.




EXPORTS : INITIATE

Initiates an export of user data.



HTTP REQUEST

POST https://api-{region}.spanningbackup.com/api/v1/users/{email}/exports




PARAMETERS

Parameter name Type Required Description email string Y The email address of the
user whose data will be exported. region string Y The region: US, EU, AP, UK,
CA.

REQUEST PARAMETERS

Parameter name Type Required Description adminEmail string Y The email address
of the administrator who is making the request. objectType string Y The type of
object to export. Valid values are DOCUMENT, CALENDAR, CONTACT, MAIL, SITE, and
ALL.
This parameter can be used multiple times on a single request to export multiple
object types.




RESPONSE

A successful response will return an object containing the job id(s) of the
export.

[
  {
    "jobId": "{string}"
  }
]



Property name Type Description jobId string A unique identifier for the job.



STATUS CODES

Status code Description 200 The export was successfully initiated. 400 The
objectType value was invalid. 403 The admin user is not an administrator for the
domain. 404 The user is not assigned a Spanning Backup license. 409 An export is
already in progress for the user. Only one export may be in progress for a user
at a time.




EXAMPLE

curl --user abc.com:{apiToken} -X POST \
    https://api-us.spanningbackup.com/api/v1/users/user1@abc.com/exports \
    --data "adminEmail=admin@abc.com&objectType=MAIL"


EXPORTS : LIST

List the non-expired exports for a user.



HTTP REQUEST

GET https://api-{region}.spanningbackup.com/api/v1/users/{email}/exports




PARAMETERS

Parameter name Type Required Description email string Y The email address of the
user for whom to retrieve export data. region string Y The region: US, EU, AP,
UK, CA.

QUERY PARAMETERS

Parameter name Type Required Description adminEmail string Y The email address
of the administrator who is making the request.




RESPONSE

A successful response will return a list of export objects for the user.

STATUS CODES

Status code Description 200 The list of exports was retrieved successfully. 403
The admin user is not an administrator for the domain. 404 The user is not
assigned a Spanning Backup license.




EXAMPLE

curl -G --user abc.com:{apiToken} -X GET \
    https://api-us.spanningbackup.com/api/v1/users/user1@abc.com/exports \
    --data "adminEmail=admin@abc.com"


EXPORTS : GET

Get an export for a user.



HTTP REQUEST

GET https://api-{region}.spanningbackup.com/api/v1/users/{email}/exports/{jobId}




PARAMETERS

Parameter name Type Required Description email string Y The email address of the
user for which data will be exported. jobId string Y The id of the export to
retrieve. region string Y The region: US, EU, AP, UK, CA.

QUERY PARAMETERS

Parameter name Type Required Description adminEmail string Y The email address
of the administrator who is making the request on behalf of the user.




RESPONSE

A successful response will return an export object.

STATUS CODES

Status code Description 200 The export was retrieved successfully. 403 The admin
user is not an administrator for the domain. 404 The user does not exist in the
domain or the export does not exist or is expired or jobId is specified an
incorrect.




EXAMPLE

curl -G --user abc.com:{apiToken} -X GET \
    https://api-us.spanningbackup.com/api/v1/users/user1@abc.com/exports/12345 \
    --data "adminEmail=admin@abc.com"

ABOUT BLOG SUPPORT CONTACT