Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Version:

Onezone REST API Oneprovider REST API Onepanel REST API

Version:

Get replicas by path Deprecated

GET /replicas/{path}

This enpoint is deprecated, please use this one.

Returns file distribution information about a specific file.

Example cURL requests

Get file distribution map by path

curl -X GET -H "X-Auth-Token: $TOKEN" \
"https://$HOST/api/v3/oneprovider/replicas/MySpace1/MyFile1.txt"

[
  {
    "blocks": [ [ 0, 4 ], [ 10, 20 ] ],
    "providerId": "784dae9d-34a3-4aef-ab4b-2c6c60b74e27"
  },
  {
    "blocks": [ [ 5, 9 ] ],
    "providerId": "b296ab05-3d62-4755-be46-c57ced411ff1"
  }
]

Path parameters

Parameter	Type & Description
path required	string File path (e.g. '/MySpace/testfiles/file1.txt')

Request Examples

Shell

oneprovider-rest-cli getFileReplicas path='/MySpace/testfiles/file1.txt' key=value1

Responses

application/json

200

The list of file blocks stored at each provider.

No schema provided.

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."
}