Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Onezone REST API Oneprovider REST API Onepanel REST API

Get Ids of of the space auto-cleaning reports

GET /provider/spaces/{id}/auto-cleaning/reports

Returns the list of Ids of space auto-cleaning reports. The list is sorted descending by start time of an auto-cleaning run (the newest report is first).

Path parameters

Parameter Type & Description
id required
string

The Id of a space.

Query parameters

Parameter Type & Description
offset
integer

Allows to skip N first report Ids.
limit
integer

Allows to limit the number of returned report Ids up to N last reports. By default, all report Ids will be returned.
index
string

Allows to list the report Ids starting from the specific report.

Request Examples

Shell
onepanel-rest-cli -u onepanel:$PASSPHRASE --host https://$HOST:9443 getProviderSpaceAutoCleaningReports id=$SPACE_ID offset=5 limit=10 index=1234148561abcdef

Responses

application/json
200

The list of Ids of space auto-cleaning reports.

PropertyType & Description
ids
array of strings

The list of Ids of space auto-cleaning reports.

Example

application/json
{
  "ids": [
    "x7It3cpgNgLZ8RwOrOoW",
    "Q1boCClpCS5mUNhM7YCy"
  ]
}
401

Unauthorized request.

403

Forbidden request.

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

Services needed to fulfill this request are not running.