Endpoint

/v1/portal/spokes/{id}/evict-data

POST

Recover cluster capacity by removing cached file data.

Parameters

Name Description Required
id Portal ID Yes

Request

Schema

{
  "description": "api_portal_evict_data_request",
  "type": "object",
  "properties": {
    "file_id": {
      "description": "ID of the file to evict data from. The file must belong to a portal.",
      "type": "string"
    }
  }
}

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "api_portal_eviction_result",
  "type": "object",
  "properties": {
    "evicted_blocks": {
      "description": "Number of 4096 byte blocks that have been freed. It can be less than requested and even 0 if no eviction was possible. The cluster's reported free capacity may take time to reflect the eviction.",
      "type": "string"
    }
  }
}