Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Onezone REST API Oneprovider REST API Onepanel REST API

Create node invite token

POST /invite_tokens

Creates node invite token. The token can be used by other nodes to join cluster.

Request Examples

Shell
onepanel-rest-cli -u onepanel:$PASSPHRASE createInviteToken --host https://$HOST:9443

Responses

application/json
200

Invite token created.

PropertyType & Description
inviteToken
string

Example

application/json
{
  "inviteToken": "AS2KLJH1231AJSHDKJBC12KS578A3SDA"
}
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."
  }
}