Update or Delete Rule

Update â€” omit _METHOD or do not send it; the full rule options object is sent as the body and the rule is updated in place. Delete â€” include "_METHOD": "DELETE" as the only body field. The rule identified by ruleId is permanently removed.

curl -X POST "https://api.5centscdn.com/v2/zones/http/pull/12345/rules/rule/201" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{
  "name": "Cache Images",
  "rule": "/images/*",
  "options": {
    "edge_cache_settings": {
      "enabled": null,
      "control": "default",
      "default": "345600s",
      "value": "345600s",
      "revalidate": null,
      "custom": {
        "default": "",
        "value": ""
      },
      "custom_values": {
        "codes": [],
        "value": []
      }
    },
    "cors": {
      "enabled": null,
      "control": "*",
      "always": false,
      "value": "*",
      "custom": ""
    }
  }
}'

import requests
import json

url = "https://api.5centscdn.com/v2/zones/http/pull/12345/rules/rule/201"
headers = {
  "Content-Type": "application/json",
  "X-API-Key": "YOUR_API_KEY"
}
data = {
  "name": "Cache Images",
  "rule": "/images/*",
  "options": {
    "edge_cache_settings": {
      "enabled": null,
      "control": "default",
      "default": "345600s",
      "value": "345600s",
      "revalidate": null,
      "custom": {
        "default": "",
        "value": ""
      },
      "custom_values": {
        "codes": [],
        "value": []
      }
    },
    "cors": {
      "enabled": null,
      "control": "*",
      "always": false,
      "value": "*",
      "custom": ""
    }
  }
}

response = requests.post(url, headers=headers, json=data)
print(response.json())

const response = await fetch("https://api.5centscdn.com/v2/zones/http/pull/12345/rules/rule/201", {
  method: "POST",
  headers: {
  "Content-Type": "application/json",
  "X-API-Key": "YOUR_API_KEY"
},
  body: JSON.stringify({
  "name": "Cache Images",
  "rule": "/images/*",
  "options": {
    "edge_cache_settings": {
      "enabled": null,
      "control": "default",
      "default": "345600s",
      "value": "345600s",
      "revalidate": null,
      "custom": {
        "default": "",
        "value": ""
      },
      "custom_values": {
        "codes": [],
        "value": []
      }
    },
    "cors": {
      "enabled": null,
      "control": "*",
      "always": false,
      "value": "*",
      "custom": ""
    }
  }
})
});

const data = await response.json();
console.log(data);

package main

import (
    "fmt"
    "net/http"
    "bytes"
    "encoding/json"
)

func main() {
    data := []byte(`{
  "name": "Cache Images",
  "rule": "/images/*",
  "options": {
    "edge_cache_settings": {
      "enabled": null,
      "control": "default",
      "default": "345600s",
      "value": "345600s",
      "revalidate": null,
      "custom": {
        "default": "",
        "value": ""
      },
      "custom_values": {
        "codes": [],
        "value": []
      }
    },
    "cors": {
      "enabled": null,
      "control": "*",
      "always": false,
      "value": "*",
      "custom": ""
    }
  }
}`)

    req, err := http.NewRequest("POST", "https://api.5centscdn.com/v2/zones/http/pull/12345/rules/rule/201", bytes.NewBuffer(data))
    if err != nil {
        panic(err)
    }

    req.Header.Set("Content-Type", "application/json")
    req.Header.Set("X-API-Key", "YOUR_API_KEY")

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    fmt.Println("Response Status:", resp.Status)
}

require 'net/http'
require 'json'

uri = URI('https://api.5centscdn.com/v2/zones/http/pull/12345/rules/rule/201')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request['X-API-Key'] = 'YOUR_API_KEY'
request.body = '{
  "name": "Cache Images",
  "rule": "/images/*",
  "options": {
    "edge_cache_settings": {
      "enabled": null,
      "control": "default",
      "default": "345600s",
      "value": "345600s",
      "revalidate": null,
      "custom": {
        "default": "",
        "value": ""
      },
      "custom_values": {
        "codes": [],
        "value": []
      }
    },
    "cors": {
      "enabled": null,
      "control": "*",
      "always": false,
      "value": "*",
      "custom": ""
    }
  }
}'

response = http.request(request)
puts response.body

{
  "result": "success",
  "message": "Zone EdgeRule Updated. Please wait till the rules validation & deployment completes."
}

{
  "error": "Bad Request",
  "message": "The request contains invalid parameters or malformed data",
  "code": 400,
  "details": [
    {
      "field": "email",
      "message": "Invalid email format"
    }
  ]
}

POST

/zones/http/pull/{zoneId}/rules/rule/{ruleId}

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)

path

zoneIdinteger

Required

Numeric ID of the zone

path

ruleIdinteger

Required

Numeric ID of the edge rule to update or delete

Content-Typestring

Required

The media type of the request body

Options: application/json

namestring

Required

Pre-populated rule name. Send back as received from GET rules.

rulestring

Required

Pre-populated rule pattern. Send back as received from GET rules.

optionsobject

Required

Full options object for the rule update.

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

Numeric ID of the zone

Example:

12345

ruleIdinteger

Required

Numeric ID of the edge rule to update or delete

Example:

201

Body

application/json

namestring

Required

Pre-populated rule name. Send back as received from GET rules.

Example:

Cache Images

rulestring

Required

Pre-populated rule pattern. Send back as received from GET rules.

Example:

/images/*

optionsobject

Required

Full options object for the rule update.

Responses

resultstring

Required

Status of the API response.

Allowed values:success

messagestring

Required

Was this page helpful?

curl -X POST "https://api.5centscdn.com/v2/zones/http/pull/12345/rules/rule/201" \ -H "Content-Type: application/json" \ -H "X-API-Key: YOUR_API_KEY" \ -d '{ "name": "Cache Images", "rule": "/images/*", "options": { "edge_cache_settings": { "enabled": null, "control": "default", "default": "345600s", "value": "345600s", "revalidate": null, "custom": { "default": "", "value": "" }, "custom_values": { "codes": [], "value": [] } }, "cors": { "enabled": null, "control": "*", "always": false, "value": "*", "custom": "" } } }'