Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Onezone REST API Oneprovider REST API Onepanel REST API

Get harvester configuration

GET /harvesters/{id}/gui_plugin_config

Returns JSON configuration for harvester GUI plugin.

If called by user who is not member of the harvester, requires oz_harvesters_view admin privilege.

Example cURL requests

Get harvester details

curl -u admin:password -X GET \
https://$ZONE_HOST/api/v3/onezone/harvesters/$HARVESTER_ID/config

{
  "config" : {
    "typeMapping": [ { "id": 0, "name": "Type 1" }, { "id": 1, "name": "Type 1" } ],
    "externalHelpLink": "http://example.com/some_help_page",
    "refreshDataTimeout": 1000
  }
}

Path parameters

Parameter Type & Description
id required
string

Harvester Id.

Request Examples

Shell
onezone-rest-cli getHarvesterConfig id=b752ceafabb662b4e5728b2ded25cdd1

Responses

application/json
200

Harvester GUI plugin configuration.

Property
Type & Description
guiPluginConfig
object

Example

application/json
{
  "config": {
    "typeMapping": [
      {
        "id": 0,
        "name": "Type 1"
      },
      {
        "id": 1,
        "name": "Type 1"
      }
    ],
    "externalHelpLink": "http://example.com/some_help_page",
    "refreshDataTimeout": 1000
  }
}
400

Invalid request.

Property
Type & 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."
  }
}
401

Authentication error.

Property
Type & 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."
  }
}
403

Authorization error.

Property
Type & 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."
  }
}
404

Resource not found.

Property
Type & 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."
  }
}
500

Internal server Error.

Property
Type & 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."
  }
}