CacheUpdate Cache

Update Cache

Update cache settings of VoD push zone

curl -X POST "https://api.5centscdn.com/v2/zones/vod/push/42/cache" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{
  "cache": "Y",
  "expiry": "1d",
  "querystring": "Y",
  "cachecontrol": "Y",
  "usestale": "Y",
  "revalidate": "Y",
  "cacheInSecs": 0,
  "cacheInMins": 0,
  "expiryInSecs": 86400,
  "expiryInMins": 1440
}'
{
  "result": "success",
  "message": "Zone updated successfully",
  "zone": {
    "type": "push",
    "id": 12345,
    "serviceid": 67890,
    "mode": "http",
    "cnames": "",
    "edgeruleids": 0,
    "deleted": null,
    "name": "my-cdn-zone",
    "hashid": "abc123def456",
    "fqdn": "cdn.example.com",
    "fqdnVoD": "vod.example.com",
    "edgerules": {
      "enabled": "N"
    },
    "domainlock": {
      "policy": "N",
      "list": "example.com,cdn.example.com",
      "ips": "203.0.113.10",
      "noreferer": "N",
      "type": "push",
      "enabled": "N",
      "active": "N"
    },
    "geoblock": {
      "policy": "N",
      "list": [
        "US",
        "GB"
      ],
      "ips": "203.0.113.10",
      "enabled": "N",
      "active": "N"
    },
    "securetoken": {
      "policy": "F",
      "keyip": "N",
      "list": "ab12cd34ef56gh78",
      "timeout": 3600,
      "session": "0",
      "ips": "",
      "dirs": "",
      "enabled": "N",
      "active": "N"
    },
    "eac": {
      "policy": "N",
      "list": "http://example.com/auth.script",
      "ips": "203.0.113.10",
      "enabled": "N",
      "active": "N"
    },
    "ssl": {
      "http": "N",
      "http2": "Y",
      "redirect": "Y",
      "mode": "S",
      "certid": null,
      "zerossl": null,
      "enabled": "Y",
      "warning": false
    },
    "cache": {
      "smart": "0",
      "cache": "4h",
      "expiry": "1M",
      "querystring": "N",
      "cachecontrol": "Y",
      "usestale": "Y",
      "revalidate": "Y",
      "cacheInSecs": 14400,
      "cacheInMins": 240,
      "expiryInSecs": 2592000,
      "expiryInMins": 43200
    },
    "edge": {
      "compression": "N",
      "compressionlevel": 5,
      "disposition": "N",
      "stripcookie": "N",
      "xff": "N",
      "cors": "Y",
      "webp": "N",
      "pseudostreaming": "N",
      "wp": "N",
      "lfo": "Y",
      "prefresh": "N"
    },
    "transcodefile": {
      "profiles": [
        "1",
        "2"
      ],
      "emails": [
        "admin@example.com"
      ],
      "webhooks": [
        "https://hooks.example.com/webhook"
      ]
    },
    "ftpdetails": {
      "username": "user_67890_push_12345",
      "password": "••••••••"
    },
    "server": {
      "code": "206",
      "name": "Singapore",
      "country": "SouthEast Asia",
      "meta": {
        "uploadPort": "21",
        "uploadHost": "upload.example.com"
      }
    },
    "ssl_enabled": "Y"
  }
}
POST
/zones/vod/push/{zoneid}/cache
POST
Base URLstring

Target server for requests. Edit to use your own host.

API Key (header: X-API-Key)
X-API-Keystring
Required

API key (sent in header)

Content-Typestring
Required

The media type of the request body

Options: application/json
cachestring

Cache configuration settings for the zone.

Options: Y, N
expirystring

Browser cache TTL duration code

Options: 0s, 10s, 1m, 10m, 30m, 1h, 4h, 12h, 1d, 7d, 14d, 1M, 3M, 6M, 1y
querystringstring

Whether query string caching is enabled (Y/N)

Options: Y, N
cachecontrolstring

Cache-Control header value.

Options: Y, N
usestalestring

Whether stale content is served while revalidating (Y/N)

Options: Y, N
revalidatestring

Whether content is revalidated after expiry (Y/N)

Options: Y, N
cacheInSecsnumber

Derived cache TTL in seconds.

cacheInMinsnumber

Derived cache TTL in minutes.

expiryInSecsnumber

Derived expiry in seconds.

expiryInMinsnumber

Derived expiry in minutes.

Request Preview
Response

Response will appear here after sending the request

Authentication

header
X-API-Keystring
Required

API Key for authentication. Provide your API key in the header.

Path Parameters

zoneidinteger
Required

Zone ID

Example:
42

Body

application/json
cachestring

Cache configuration settings for the zone.

Allowed values:YN
expirystring

Browser cache TTL duration code

Allowed values:0s10s1m10m30m1h4h12h1d7d14d1M3M6M1y
querystringstring

Whether query string caching is enabled (Y/N)

Allowed values:YN
cachecontrolstring

Cache-Control header value.

Allowed values:YN
usestalestring

Whether stale content is served while revalidating (Y/N)

Allowed values:YN
revalidatestring

Whether content is revalidated after expiry (Y/N)

Allowed values:YN
cacheInSecsnumber

Derived cache TTL in seconds.

Example:
0
cacheInMinsnumber

Derived cache TTL in minutes.

Example:
0
expiryInSecsnumber

Derived expiry in seconds.

Example:
86400
expiryInMinsnumber

Derived expiry in minutes.

Example:
1440

Responses

resultstring

Status of the API response.

messagestring

Human-readable status message describing the outcome.

zoneobject