Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Onezone REST API Oneprovider REST API Onepanel REST API

Join existing cluster

POST /join_cluster

Adds this host to administrative cluster. The host handling this request has to be newly started or removed from previous cluster. It cannot have emergency passphrase or other configuration data set. Therefore this request does not need authorization.

Request body

application/json
PropertyType & Description
inviteToken
string

Request Examples

application/json 
{
  "inviteToken": "AS2KLJH1231AJSHDKJBC12KS578A3SDA"
}

Responses

application/json
204

The node successfully joined the cluster.

403

Forbidden request.

409

Operation forbidden. The node is already a part of a cluster.

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