Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Version:

Onezone REST API Oneprovider REST API Onepanel REST API

Version:

Modify settings of a Onezone GUI message.

PATCH /zone/gui_messages/{id}

Enables, disables or modifies a message displayed in Onezone GUI.

Path parameters

Parameter	Type & Description
id required	string Possible values are: cookie_consent_notification - for the contents of cookie consent popup privacy_policy - for the privacy policy signin_notification - for the message displayed on the Onezone sign in screen

Request body

application/json

Property	Type & Description
enabled boolean True if the message should be displayed.
body string HTML content of the message to display.

Request Examples

Shell

onepanel-rest-cli -u onepanel:$PASSPHRASE modifyGuiMessage id=signin_notification enabled==true --host https://$HOST:9443

Responses

application/json

204

Changes successfully saved.

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

Unauthorized request.

403

Forbidden request.

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