/v1/portal/spokes/eviction-settings

Endpoint

/v1/portal/spokes/eviction-settings

GET

Retrieve the configuration for recovering cluster capacity by removing cached data automatically.

Important
This preview REST API is under development. Its functionality or backwards compatibility can change without notice.

Parameters

This resource has no parameters.

Response

Codes

Code	Description
200	Return value on success

Schema

{
  "description": "api_portal_eviction_settings",
  "type": "object",
  "properties": {
    "free_threshold": {
      "description": "Fraction of free total cluster capacity that the system will try to maintain by evicting cached spoke portal data, in the range [0.0, 1.0]. Default is 0.15, 0.0 means no eviction, 1.0 means always evict.",
      "type": "number"
    }
  }
}

PUT

Overwrite the configuration for recovering cluster capacity by removing cached data automatically.

Important
This preview REST API is under development. Its functionality or backwards compatibility can change without notice.

Parameters

Name	Description	Required
`If-Match`	ETag for expected version	No

Request

Schema

{
  "description": "api_portal_eviction_settings",
  "type": "object",
  "properties": {
    "free_threshold": {
      "description": "Fraction of free total cluster capacity that the system will try to maintain by evicting cached spoke portal data, in the range [0.0, 1.0]. Default is 0.15, 0.0 means no eviction, 1.0 means always evict.",
      "type": "number"
    }
  }
}

Response

Codes

Code	Description
200	Return value on success

Schema

{
  "description": "api_portal_eviction_settings",
  "type": "object",
  "properties": {
    "free_threshold": {
      "description": "Fraction of free total cluster capacity that the system will try to maintain by evicting cached spoke portal data, in the range [0.0, 1.0]. Default is 0.15, 0.0 means no eviction, 1.0 means always evict.",
      "type": "number"
    }
  }
}

PATCH

Change the configuration for recovering cluster capacity by removing cached data automatically.

Important
This preview REST API is under development. Its functionality or backwards compatibility can change without notice.

Parameters

Name	Description	Required
`If-Match`	ETag for expected version	No

Request

Schema

{
  "description": "api_portal_eviction_settings",
  "type": "object",
  "properties": {
    "free_threshold": {
      "description": "Fraction of free total cluster capacity that the system will try to maintain by evicting cached spoke portal data, in the range [0.0, 1.0]. Default is 0.15, 0.0 means no eviction, 1.0 means always evict.",
      "type": "number"
    }
  }
}

Response

Codes

Code	Description
200	Return value on success

Schema

{
  "description": "api_portal_eviction_settings",
  "type": "object",
  "properties": {
    "free_threshold": {
      "description": "Fraction of free total cluster capacity that the system will try to maintain by evicting cached spoke portal data, in the range [0.0, 1.0]. Default is 0.15, 0.0 means no eviction, 1.0 means always evict.",
      "type": "number"
    }
  }
}