Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Onezone REST API Oneprovider REST API Onepanel REST API

Trigger space auto-cleaning

POST /provider/spaces/{id}/auto-cleaning/start

Trigger one run of auto-cleaning mechanism for given space.

Path parameters

Parameter Type & Description
id required
string

The Id of a space.

Request Examples

Shell
onepanel-rest-cli -u onepanel:$PASSPHRASE triggerAutoCleaning --host https://$OP_PANEL_HOST:9443

Responses

application/json
202

Cleaning of given space has started.

Property
Type & Description
reportId
string
204

No action taken. Auto-cleaning is already running or there are no files to be cleaned.

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

Services needed to fulfill this request are not running.