Update CDN proxy rule

PATCH /api/v2/cdn/zones/{id}/proxy-rules/{ruleId}

Partially update one CDN proxy rule. Use mode: "off" to bypass the CDN for the hostname while keeping the rule, or active: false to disable the rule lifecycle.

CDN & Edge Other

Authentication

Required API scopes: write:cdnwrite:domains

Authenticate with an API key in the Authorization: Bearer <token> header.

Context

Related endpoints

GET /api/v2/cdn/zones/{id}/proxy-rules List CDN proxy rules DELETE /api/v2/cdn/zones/{id}/proxy-rules/{ruleId} Delete CDN proxy rule GET /api/v2/cdn/zones/{id} Get CDN zone details

Path Parameters

id string required Example: cdn_01hxa3b4c5d6e7f8g9h0j1k2m3

Public CDN zone ID. Get it from GET /api/v2/cdn/zones data[].id. Do not invent this value; use the exact ID returned by the referenced API response.

ruleId string required Example: cprule_01hxa3b4c5d6e7f8g9h0j1k2m3

Public CDN proxy rule ID. Get it from GET /api/v2/cdn/zones/{id}/proxy-rules rules[].id. Do not invent this value; use the exact ID returned by the referenced API response.

Headers

Authorization Bearer <token>

Accept application/json

Content-Type application/json

Body

required

application/json

mode string · enum · Example: off

always

smart

off

name string · Example: www

Rename the rule target hostname inside the same zone.

priority integer · min: 0 · max: 65535 · Example: 200

description string · nullable · Example: Temporarily bypass CDN proxying.

active boolean · Example: true

Responses

200 Updated CDN proxy rule. 9 fields

id string · Example: cprule_01hxa3b4c5d6e7f8g9h0j1k2m3

Public CDN proxy rule ID. Get it from GET /api/v2/cdn/zones/{id}/proxy-rules.

fqdn string · nullable · Example: www.example.com

zone string · nullable · Example: example.com

proxy object

proxy.enabled boolean required · Example: true

proxy.mode string · enum required · Example: always

always

smart

off

proxy.priority integer · min: 0 · max: 65535 required · Example: 100

state object

state.active boolean required · Example: true

state.reason string · nullable required · Example: null

Nullable: may be null when not applicable.

createdAt string · nullable · Example: 2026-04-27T12:00:00.000Z

updatedAt string · nullable · Example: 2026-04-27T12:00:00.000Z

description string · nullable · Example: Proxy website traffic through the CDN.

unchanged boolean · Example: true

Present and true only when POST found an existing rule for the same hostname and returned it instead of creating a duplicate.

400 Invalid request. The response body is an RFC 7807 Problem Details document. 10 fields

type string · Example: https://developer.hostup.se/errors/invalid_request

title string · Example: Validation failed

status integer · Example: 400

detail string · Example: The request body failed validation.

code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on detail.

instance string · Example: /api/v2/orders

requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3

timestamp string · Example: 2026-04-27T12:34:56.000Z

errors array<object>

Field-level validation errors when code is invalid_request.

errors[].pointer string required · Example: /items/0/eppCode

errors[].detail string required · Example: `eppCode` is required for this transfer.

errors[].code string required · Example: missing_required

extensions object

401 Unauthorized. Authentication is required. 10 fields

type string · Example: https://developer.hostup.se/errors/invalid_request

title string · Example: Validation failed

status integer · Example: 400

detail string · Example: The request body failed validation.

code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on detail.

instance string · Example: /api/v2/orders

requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3

timestamp string · Example: 2026-04-27T12:34:56.000Z

errors array<object>

Field-level validation errors when code is invalid_request.

errors[].pointer string required · Example: /items/0/eppCode

errors[].detail string required · Example: `eppCode` is required for this transfer.

errors[].code string required · Example: missing_required

extensions object

403 Forbidden. The caller lacks a required scope or does not own the resource. 10 fields

type string · Example: https://developer.hostup.se/errors/invalid_request

title string · Example: Validation failed

status integer · Example: 400

detail string · Example: The request body failed validation.

code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on detail.

instance string · Example: /api/v2/orders

requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3

timestamp string · Example: 2026-04-27T12:34:56.000Z

errors array<object>

Field-level validation errors when code is invalid_request.

errors[].pointer string required · Example: /items/0/eppCode

errors[].detail string required · Example: `eppCode` is required for this transfer.

errors[].code string required · Example: missing_required

extensions object

404 Not found. The resource does not exist or is not owned by the caller. 10 fields

type string · Example: https://developer.hostup.se/errors/invalid_request

title string · Example: Validation failed

status integer · Example: 400

detail string · Example: The request body failed validation.

code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on detail.

instance string · Example: /api/v2/orders

requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3

timestamp string · Example: 2026-04-27T12:34:56.000Z

errors array<object>

Field-level validation errors when code is invalid_request.

errors[].pointer string required · Example: /items/0/eppCode

errors[].detail string required · Example: `eppCode` is required for this transfer.

errors[].code string required · Example: missing_required

extensions object

429 Rate limited. Retry after the limit resets. 429 responses include Retry-After seconds plus X-RateLimit-* headers. 10 fields

type string · Example: https://developer.hostup.se/errors/invalid_request

title string · Example: Validation failed

status integer · Example: 400

detail string · Example: The request body failed validation.

code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on detail.

instance string · Example: /api/v2/orders

requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3

timestamp string · Example: 2026-04-27T12:34:56.000Z

errors array<object>

Field-level validation errors when code is invalid_request.

errors[].pointer string required · Example: /items/0/eppCode

errors[].detail string required · Example: `eppCode` is required for this transfer.

errors[].code string required · Example: missing_required

extensions object

500 Internal error. Retry later or contact support if the issue persists. 10 fields

type string · Example: https://developer.hostup.se/errors/invalid_request

title string · Example: Validation failed

status integer · Example: 400

detail string · Example: The request body failed validation.

code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on detail.

instance string · Example: /api/v2/orders

requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3

timestamp string · Example: 2026-04-27T12:34:56.000Z

errors array<object>

Field-level validation errors when code is invalid_request.

errors[].pointer string required · Example: /items/0/eppCode

errors[].detail string required · Example: `eppCode` is required for this transfer.

errors[].code string required · Example: missing_required

extensions object

PATCH https://cloud.hostup.se/api/v2/cdn/zones/{id}/proxy-rules/{ruleId}

For AI assistants

View as Markdown

cURL

curl -X PATCH "https://cloud.hostup.se/api/v2/cdn/zones/cdn_01hxa3b4c5d6e7f8g9h0j1k2m3/proxy-rules/cprule_01hxa3b4c5d6e7f8g9h0j1k2m3" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "mode": "off",
    "description": "Temporarily bypass CDN proxying."
  }'

Response

{
  "id": "cprule_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "fqdn": "www.example.com",
  "zone": "example.com",
  "proxy": {
    "enabled": false,
    "mode": "off",
    "priority": 100
  },
  "state": {
    "active": true,
    "reason": null
  },
  "createdAt": "2026-04-27T12:00:00.000Z",
  "updatedAt": "2026-04-27T12:00:00.000Z",
  "description": "Temporarily bypass CDN proxying."
}

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Public CDN proxy rule ID. Get it from `GET /api/v2/cdn/zones/{id}/proxy-rules`."
    },
    "fqdn": {
      "type": "string",
      "nullable": true
    },
    "zone": {
      "type": "string",
      "nullable": true
    },
    "proxy": {
      "type": "object",
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "mode": {
          "type": "string",
          "enum": [
            "always",
            "smart",
            "off"
          ]
        },
        "priority": {
          "type": "integer",
          "minimum": 0,
          "maximum": 65535
        }
      }
    },
    "state": {
      "type": "object",
      "properties": {
        "active": {
          "type": "boolean"
        },
        "reason": {
          "type": "string",
          "nullable": true
        }
      }
    },
    "createdAt": {
      "type": "string",
      "nullable": true
    },
    "updatedAt": {
      "type": "string",
      "nullable": true
    },
    "description": {
      "type": "string",
      "nullable": true
    },
    "unchanged": {
      "type": "boolean",
      "description": "Present and true only when POST found an existing rule for the same hostname and returned it instead of creating a duplicate."
    }
  }
}

Request Body Bypass proxy for rule

{
  "mode": "off",
  "description": "Temporarily bypass CDN proxying."
}