Endpoint

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

POST

Remove a cached link from a directory to one of its child files or directories. If no links remain between the directory and its child file or directory this operation also removes the cached child.

Parameters

Name Description Required
id Portal ID Yes

Request

Schema

{
  "description": "api_portal_evict_link_request",
  "type": "object",
  "properties": {
    "dir_id": {
      "description": "ID of the directory from which to evict a link. The directory must belong to a portal.",
      "type": "string"
    },
    "name": {
      "description": "The name of the directory entry to unlink.",
      "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"
    }
  }
}