Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Onezone REST API Oneprovider REST API Onepanel REST API

Modify harvester configuration

PATCH /harvesters/{id}/gui_plugin_config

Updates harvester GUI plugin configuration.

This operation requires harvester_update privilege or oz_harvesters_update admin privilege.

Example cURL requests

Change harvester name

curl -u username:password -H "Content-type: application/json" \
-X PATCH -d '{"config": {}}' \
https://$ZONE_HOST/api/v3/onezone/harvesters/$HARVESTER_ID/config

Path parameters

Parameter Type & Description
id required
string

Harvester Id.

Request body

application/json

New harvester config

Property
Type & Description
guiPluginConfig
object

Request Examples

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

Responses

application/json
204

Harvester configuration has been updated successfully.

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