Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Onezone REST API Oneprovider REST API Onepanel REST API

Get transfers mock status

GET /provider/debug/transfers_mock

Returns information whether transfers mocking is enabled.

Request Examples

Shell
onepanel-rest-cli -u onepanel:$PASSPHRASE getTransfersMock --host https://oz.example.com:9443

Responses

application/json
200

Transfers mock configuration.

PropertyType & Description
transfersMock
boolean

If true, transfers are marked as successful without actually transmiting any data.

Example

application/json
{
  "transfersMock": true
}
403

Forbidden request.

404

Oneprovider cluster is not registered.

500

Internal server error.

PropertyType & Description
error
object

Object describing an error.

id required
string

String identifying the error type. Does not change between error instances.

description required
string

Human readable error description. May contain information specific to given error instance.

details
object

Details about the error instance. The object schema is specific to each error type.

Example

application/json
{
  "error": {
    "id": "badValueString",
    "details": {
      "key": "name"
    },
    "description": "Bad value: provided \"name\" must be a string."
  }
}