Get a custom page

client.CustomPages.Get(ctx, identifier, query) (*CustomPageGetResponse, error)

GET/{accounts_or_zones}/{account_or_zone_id}/custom_pages/{identifier}

Fetches the details of a custom page.

Security

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

Zero Trust: PII ReadAccount Custom Pages WriteAccount Custom Pages ReadAccount Settings WriteAccount Settings Read

ParametersExpand Collapse

identifier CustomPageGetParamsIdentifier

Error Page Types

One of the following:

const CustomPageGetParamsIdentifier1000Errors CustomPageGetParamsIdentifier = "1000_errors"

const CustomPageGetParamsIdentifier500Errors CustomPageGetParamsIdentifier = "500_errors"

const CustomPageGetParamsIdentifierBasicChallenge CustomPageGetParamsIdentifier = "basic_challenge"

const CustomPageGetParamsIdentifierCountryChallenge CustomPageGetParamsIdentifier = "country_challenge"

const CustomPageGetParamsIdentifierIPBlock CustomPageGetParamsIdentifier = "ip_block"

const CustomPageGetParamsIdentifierManagedChallenge CustomPageGetParamsIdentifier = "managed_challenge"

const CustomPageGetParamsIdentifierRatelimitBlock CustomPageGetParamsIdentifier = "ratelimit_block"

const CustomPageGetParamsIdentifierUnderAttack CustomPageGetParamsIdentifier = "under_attack"

const CustomPageGetParamsIdentifierWAFBlock CustomPageGetParamsIdentifier = "waf_block"

const CustomPageGetParamsIdentifierWAFChallenge CustomPageGetParamsIdentifier = "waf_challenge"

query CustomPageGetParams

AccountID param.Field[string]optional

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

ZoneID param.Field[string]optional

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

ReturnsExpand Collapse

type CustomPageGetResponse struct{…}

ID stringoptional

CreatedOn Timeoptional

formatdate-time

Description stringoptional

ModifiedOn Timeoptional

formatdate-time

PreviewTarget stringoptional

RequiredTokens []stringoptional

State CustomPageGetResponseStateoptional

The custom page state.

One of the following:

const CustomPageGetResponseStateDefault CustomPageGetResponseState = "default"

const CustomPageGetResponseStateCustomized CustomPageGetResponseState = "customized"

URL stringoptional

The URL associated with the custom page.

formaturi

Get a custom page

package main

import (
  "context"
  "fmt"

  "github.com/cloudflare/cloudflare-go"
  "github.com/cloudflare/cloudflare-go/custom_pages"
  "github.com/cloudflare/cloudflare-go/option"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIKey("144c9defac04969c7bfad8efaa8ea194"),
    option.WithAPIEmail("user@example.com"),
  )
  customPage, err := client.CustomPages.Get(
    context.TODO(),
    custom_pages.CustomPageGetParamsIdentifierRatelimitBlock,
    custom_pages.CustomPageGetParams{

    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", customPage.ID)
}

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": {
    "id": "basic_challenge",
    "created_on": "2014-01-01T05:20:00.12345Z",
    "description": "Basic Challenge",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "preview_target": "block:basic-sec-captcha",
    "required_tokens": [
      "::CAPTCHA_BOX::"
    ],
    "state": "default",
    "url": "http://www.example.com"
  }
}

Returns Examples

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": {
    "id": "basic_challenge",
    "created_on": "2014-01-01T05:20:00.12345Z",
    "description": "Basic Challenge",
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "preview_target": "block:basic-sec-captcha",
    "required_tokens": [
      "::CAPTCHA_BOX::"
    ],
    "state": "default",
    "url": "http://www.example.com"
  }
}