projects/{pid}/archival/offload (POST)

This asynchronous method transfers project files and segments to cold storage. The purpose is to reduce storage requirements. Projects can later be restored from cold storage.

The calling user must be an Administrator.

URL

CODE

(POST) /api/projects/{pid}/archival/offload

PARAMETERS

The URL parameters are:

pid

A valid project ID

int, Mandatory

The body may contain an optional JSON object:

callbackurl

Optional URL which will be called upon success or failure of operation. This makes polling for results unnecessary. URL is called as POST request with operation result included in the body, see "RESULTS" chapter below for the JSON format.

string?, Optional

RESULTS

This is an asynchronous method and the result contains the operation status.

See explanations at: Asynchronous operations