Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Onezone REST API Oneprovider REST API Onepanel REST API

Get Onezone policies.

GET /zone/policies

Returns restrictions placed on Onezone operations such as registering Oneproviders.

Request Examples

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

Responses

application/json
200

Onezone policies configuration.

PropertyType & Description
oneproviderRegistration
string

Indicates policy enforced during provider registration. Possible options are: open - anyone can acquire a registration token and register a new Oneprovider restricted - requires an administrative privilege 'oz_providers_invite' to generate a Oneprovider registration token. The token can be issued for someone else.

Enum:
openrestricted
subdomainDelegation
boolean

If true, Oneproviders are allowed to request subdomains of the Onezone domain for use as their domains.

guiPackageVerification
boolean

When this value is true, GUI packages uploaded by services operating under Onezone or by harvester admins are checked against known SHA-256 checksums using the compatibility registry. Setting this value to false disables the verification. WARNING: disabling GUI package verification poses a severe security threat, allowing Oneprovider owners to upload arbitrary GUI to Onezone (which is then hosted in Onezone's domain).

harvesterGuiPackageVerification
boolean

This policy can be used to disable GUI package verification for harvester plugins only. See "guiPackageVerification" for detailed description. This setting has no effect if "guiPackageVerification" is set to false.

Example

application/json
{
  "subdomainDelegation": true,
  "guiPackageVerification": true,
  "harvesterGuiPackageVerification": false
}
403

Forbidden request.

404

Onezone cluster is not configured.

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