Purge the LB Cache.

Deprecated

POST

/api/cdn/namespaces/{namespace}/http_loadbalancer/{name}/cache-purge

curl --request POST \
  --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/cdn/namespaces/example/http_loadbalancer/example/cache-purge \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "hard_purge": {}, "hostname": "example", "pattern": "example", "purge_all": {}, "soft_purge": {}, "url": "https://example.com" }'

• F5 Distributed Cloud Console

Initiate Purge on the LB Cache.

Examples of this operation.

Authorizations

• ApiToken

Parameters

Path Parameters

namespace

required

string

Namespace x-required Namespace scope of the metric request.

name

required

string

CDN Distribution Name x-required Format: string.

Request Body^required

Media typeapplication/json

Cache Purge Request

CDN Cache Purge.

object

hard_purge

object

hostname

Hostname

Exclusive with [pattern purge_all URL] Purge cached content by Hostname.

string

<= 1024 characters

pattern

Regex Pattern to match

Exclusive with [hostname purge_all URL] Purge cached content using PCRE 1 compliant regular expression.

string

>= 1 characters <= 256 characters

purge_all

object

soft_purge

object

url

URL

Exclusive with [hostname pattern purge_all] Purge cache by using a URL path.

string format: uri

<= 1024 characters

Example^generated

{
  "hard_purge": {},
  "hostname": "example",
  "pattern": "example",
  "purge_all": {},
  "soft_purge": {},
  "url": "https://example.com"
}

Responses

200

A successful response.

Media typeapplication/json

Purge Response

Cache Purge message.

object

purge_request_id

Purge Request Id

Request ID to track the status of the purge request.

integer format: int64

Example^generated

{
  "purge_request_id": 1
}

401

Returned when operation is not authorized.

Media typeapplication/json

string format: string

Example^generated

example

403

Returned when there is no permission to access resource.

Media typeapplication/json

string format: string

Example^generated

example

404

Returned when resource is not found.

Media typeapplication/json

string format: string

Example^generated

example

409

Returned when operation on resource is conflicting with current value.

Media typeapplication/json

string format: string

Example^generated

example

429

Returned when operation has been rejected as it is happening too frequently.

Media typeapplication/json

string format: string

Example^generated

example

500

Returned when server encountered an error in processing API.

Media typeapplication/json

string format: string

Example^generated

example

503

Returned when service is unavailable temporarily.

Media typeapplication/json

string format: string

Example^generated

example

504

Returned when server timed out processing request.

Media typeapplication/json

string format: string

Example^generated

example