List CDN proxy rules

List hostname-level proxy rules for a CDN zone. Use this before PATCH or DELETE because those endpoints require the public cprule_... ID returned as data[].id.

CDN & Edge Other

Authentication

Required API scopes: read:dnsread:domains

Use Authorization: Bearer <token> for API keys. Dashboard sessions may also use hostup_session.

Context

Related endpoints

POST /api/v2/cdn/zones/{id}/proxy-rules Create CDN proxy rule PATCH /api/v2/cdn/zones/{id}/proxy-rules/{ruleId} Update CDN proxy rule DELETE /api/v2/cdn/zones/{id}/proxy-rules/{ruleId} Delete CDN proxy rule

Path Parameters

id string required Example: id_01hxa3b4c5d6e7f8g9h0j1k2m3

Public resource ID for `id`.

Headers

Accept Example

Content-Type Example

Responses

200 CDN proxy rules.

data array<object>

data[].id string required · Example: cprule_01hxa3b4c5d6e7f8g9h0j1k2m3

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

data[].fqdn stringnull required · Example: www.example.com

data[].zone stringnull required · Example: example.com

data[].proxy object required

data[].proxy.enabled boolean required · Example: true

data[].proxy.mode string · enum required · Example: always

always

smart

off

data[].proxy.priority integer required · Example: 100

data[].state object required

data[].state.active boolean required · Example: true

data[].state.reason stringnull required · Example: null

data[].createdAt stringnull required · Example: 2026-04-27T12:00:00.000Z

data[].updatedAt stringnull required · Example: 2026-04-27T12:00:00.000Z

data[].description stringnull required · Example: Proxy website traffic through the CDN.

data[].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.

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.

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.

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.

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.

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.

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

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

For AI assistants

View as Markdown

cURL

curl -X GET "https://cloud.hostup.se/api/v2/cdn/zones/id_01hxa3b4c5d6e7f8g9h0j1k2m3/proxy-rules" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Response

{
  "data": [
    {
      "id": "cprule_01hxa3b4c5d6e7f8g9h0j1k2m3",
      "fqdn": "www.example.com",
      "zone": "example.com",
      "proxy": {
        "enabled": true,
        "mode": "always",
        "priority": 100
      },
      "state": {
        "active": true,
        "reason": null
      },
      "createdAt": "2026-04-27T12:00:00.000Z",
      "updatedAt": "2026-04-27T12:00:00.000Z",
      "description": "Proxy website traffic through the CDN."
    }
  ]
}

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "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",
              "null"
            ]
          },
          "zone": {
            "type": [
              "string",
              "null"
            ]
          },
          "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",
                  "null"
                ]
              }
            }
          },
          "createdAt": {
            "type": [
              "string",
              "null"
            ]
          },
          "updatedAt": {
            "type": [
              "string",
              "null"
            ]
          },
          "description": {
            "type": [
              "string",
              "null"
            ]
          },
          "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."
          }
        }
      }
    }
  }
}