Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Version:

Onezone REST API Oneprovider REST API Onepanel REST API

Version:

Modify space details

PATCH /provider/spaces/{id}

Modifies the space import/update strategies.

Example cURL requests

Modify space support size

curl -H "X-Auth-Token: $TOKEN" -X PATCH https://$OP_PANEL_HOST/api/v3/onepanel/provider/spaces/$SPACE_ID \
-H "Content-Type: application/json" -d '{"size": 30000000}'

Path parameters

Parameter	Type & Description
id required	string The Id of a space which details should be modified.

Request body

application/json

Property

Type & Description

size

integer

The storage space size in bytes that provider is willing to assign to the space.

autoStorageImportConfig

object (AutoStorageImportConfig)

Configuration of auto storage import mechanism. The auto import is based on scans - gradual traversing of the file system and registration of files and directories.

maxDepth integer Maximum depth of filesystem tree that will be traversed during the scan.
syncAcl boolean Flag that enables synchronization of NFSv4 ACLs.
continuousScan boolean With this option enabled the storage will be scanned periodically and direct changes on the storage will be reflected in the assigned Onedata space (upon the consecutive scan).
scanInterval integer Period between subsequent scans in seconds (counted from end of one scan till beginning of the following). This parameter is relevant only for continuous scans.
detectModifications boolean Flag determining that modifications of files on the synchronized storage will be detected. If disabled, the storage will be treated as immutable (only creations and deletions of files on storage will be detected). This parameter is relevant only for continuous scans.
detectDeletions boolean Flag determining that deletions of files from the synchronized storage will be detected. This parameter is relevant only for continuous scans.

accountingEnabled

boolean

Indicates if accounting is enabled. The accounting mechanism utilizes directory statistics to keep track of quota usage within a space for the corresponding supporting provider.

dirStatsServiceEnabled

boolean

Indicates if the directory statistics service is enabled. The service gathers statistics concerning logical and physical directory size, file count and update times. It cannot be disabled if accounting is enabled.

Responses

application/json

204

The space details has been successfully changed.

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.

404

The user does not exist.

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

503

Services needed to fulfill this request are not running.