Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Onezone REST API Oneprovider REST API Onepanel REST API

Set external IPs of nodes in application config

PATCH /zone/cluster_ips

Informs cluster nodes about external IPs which can be used to access them by other zones.

Request body

application/json application/x-yaml

The zone configuration description.

Property
Type & Description
hosts
object

The collection of cluster nodes associated with their IPs.

Request Examples

Shell
cat zone_config.json | onepanel-rest-cli -u onepanel:$PASSPHRASE modifyZoneClusterIps --host https://$OZ_PANEL_HOST:9443 -

Responses

application/json
204

IPs successfully saved.

400

Invalid request.

Property
Type & Description
error
object (ErrorDetails)

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

Forbidden request.

500

Internal server error.

Property
Type & Description
error
object (ErrorDetails)

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