Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Version:

Onezone REST API Oneprovider REST API Onepanel REST API

Version:

Get all space transfers

GET /spaces/{sid}/transfers

Returns the list of all transfer IDs in a space with given state. The list is broken down into pages, each with length less or equal to the limit parameter. If the nextPageToken is present in the response, there are more transfers to list - provide the token in the page_token parameter in the following request.

This operation requires space_view_transfers privilege.

Example cURL requests

List at most 3 ongoing transfers starting from page id 757136151113c2f

curl -X GET -H "X-Auth-Token: $TOKEN" \
"https://$HOST/api/v3/oneprovider/spaces/$SPACE_ID/transfers?state=ongoing&limit=3&page_token=757136151113c2f"

{
  "transfers": [
    "3b6a31fb-ca87-4ea6-8526-fbf5a0773d69",
    "29fa94de-33ad-4347-9cbe-3d8faa9422dd",
    "da426f74-5770-42a1-b799-354a3c4c154b"
  ],
  "nextPageToken": "8471726779817b3a"
}

Path parameters

Parameter	Type & Description
sid required	string Space Id in which to list transfers.

Query parameters

Parameter	Type & Description
state	string Specifies the state of transfers to list. The default is "ongoing".
limit	integer Allows to limit the number of returned transfers.
page_token	string Allows to start the listing from a certain point, identified by the page token.

Request Examples

Shell

oneprovider-rest-cli sid=$SPACE_ID getAllTransfers state=ongoing limit=20 page_token=757136151113c2f

Responses

application/json

200

The list of transfer IDs, nextPageToken is present when there is more to list.

Property	Type & Description
transfers array of strings The list of transfer Ids.
nextPageToken string Token which can be used to list next batch of transfer Ids.

400

Invalid request.

Property	Type & Description
error string Identifier representing internal error code.
error_description string Detailed error message.

Example

application/json

{
  "error": "invalid_token",
  "error_description": "Provided token could not be validated."
}

403

Forbidden request.

Property	Type & Description
error string Identifier representing internal error code.
error_description string Detailed error message.

Example

application/json

{
  "error": "invalid_token",
  "error_description": "Provided token could not be validated."
}

404

Oneprovider REST API not available.

Property	Type & Description
error string Identifier representing internal error code.
error_description string Detailed error message.

Example

application/json

{
  "error": "invalid_token",
  "error_description": "Provided token could not be validated."
}

500

Internal server error.

Property	Type & Description
error string Identifier representing internal error code.
error_description string Detailed error message.

Example

application/json

{
  "error": "invalid_token",
  "error_description": "Provided token could not be validated."
}