Skip to content
Cloudflare API
Start here
API Reference

Custom Pages

resource cloudflare_custom_pages

required Expand Collapse
identifier: String

Error Page Types

state: String

The custom page state.

url: String

The URL associated with the custom page.

optional Expand Collapse
account_id?: String

The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.

zone_id?: String

The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.

computed Expand Collapse
id: String

Error Page Types

created_on: Time
description: String
modified_on: Time
preview_target: String
required_tokens: List[String]

cloudflare_custom_pages

resource "cloudflare_custom_pages" "example_custom_pages" {
  identifier = "ratelimit_block"
  state = "default"
  url = "http://www.example.com"
  zone_id = "zone_id"
}

data cloudflare_custom_pages

required Expand Collapse
identifier: String

Error Page Types

optional Expand Collapse
account_id?: String

The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.

zone_id?: String

The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.

computed Expand Collapse
id: String

Error Page Types

created_on: Time
description: String
modified_on: Time
preview_target: String
state: String

The custom page state.

url: String

The URL associated with the custom page.

required_tokens: List[String]

cloudflare_custom_pages

data "cloudflare_custom_pages" "example_custom_pages" {
  identifier = "ratelimit_block"
  account_id = "account_id"
  zone_id = "zone_id"
}

data cloudflare_custom_pages_list

optional Expand Collapse
account_id?: String

The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.

zone_id?: String

The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.

max_items?: Int64

Max items to fetch, default: 1000

computed Expand Collapse
result: List[Attributes]

The items returned by the data source

id: String
created_on: Time
description: String
modified_on: Time
preview_target: String
required_tokens: List[String]
state: String

The custom page state.

url: String

The URL associated with the custom page.

cloudflare_custom_pages_list

data "cloudflare_custom_pages_list" "example_custom_pages_list" {
  account_id = "account_id"
  zone_id = "zone_id"
}

Custom PagesAssets

resource cloudflare_custom_page_asset

required Expand Collapse
name: String

The unique name of the custom asset. Can only contain letters (A-Z, a-z), numbers (0-9), and underscores (_).

description: String

A short description of the custom asset.

url: String

The URL where the asset content is fetched from.

optional Expand Collapse
account_id?: String

The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.

zone_id?: String

The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.

computed Expand Collapse
id: String

The unique name of the custom asset. Can only contain letters (A-Z, a-z), numbers (0-9), and underscores (_).

last_updated: Time
size_bytes: Int64

The size of the asset content in bytes.

cloudflare_custom_page_asset

resource "cloudflare_custom_page_asset" "example_custom_page_asset" {
  description = "Custom 500 error page"
  name = "my_custom_error_page"
  url = "https://example.com/error.html"
  zone_id = "zone_id"
}

data cloudflare_custom_page_asset

required Expand Collapse
asset_name: String

The unique name of the custom asset. Can only contain letters (A-Z, a-z), numbers (0-9), and underscores (_).

optional Expand Collapse
account_id?: String

The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.

zone_id?: String

The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.

computed Expand Collapse
id: String

The unique name of the custom asset. Can only contain letters (A-Z, a-z), numbers (0-9), and underscores (_).

description: String

A short description of the custom asset.

last_updated: Time
name: String

The unique name of the custom asset. Can only contain letters (A-Z, a-z), numbers (0-9), and underscores (_).

size_bytes: Int64

The size of the asset content in bytes.

url: String

The URL where the asset content is fetched from.

cloudflare_custom_page_asset

data "cloudflare_custom_page_asset" "example_custom_page_asset" {
  asset_name = "my_custom_error_page"
  account_id = "account_id"
  zone_id = "zone_id"
}

data cloudflare_custom_page_assets

optional Expand Collapse
account_id?: String

The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.

zone_id?: String

The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.

max_items?: Int64

Max items to fetch, default: 1000

computed Expand Collapse
result: List[Attributes]

The items returned by the data source

id: String

The unique name of the custom asset. Can only contain letters (A-Z, a-z), numbers (0-9), and underscores (_).

description: String

A short description of the custom asset.

last_updated: Time
name: String

The unique name of the custom asset. Can only contain letters (A-Z, a-z), numbers (0-9), and underscores (_).

size_bytes: Int64

The size of the asset content in bytes.

url: String

The URL where the asset content is fetched from.

cloudflare_custom_page_assets

data "cloudflare_custom_page_assets" "example_custom_page_assets" {
  account_id = "account_id"
  zone_id = "zone_id"
}