Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Onezone REST API Oneprovider REST API Onepanel REST API

Get emergency passphrase status

GET /emergency_passphrase

Returns information whether emergency passphrase is set.

Request Examples

Shell
onepanel-rest-cli getEmergencyPassphraseStatus --host https://$PANEL_HOST:9443

Responses

application/json
200

The passphrase status.

Property
Type & Description
isSet
boolean

True if the passphrase is set.

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

Unauthorized request.

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