Create a Page Shield policy

client.PageShield.Policies.New(ctx, params) (*PolicyNewResponse, error)

POST/zones/{zone_id}/page_shield/policies

Create a Page Shield policy.

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)

Page ShieldDomain Page ShieldZone Settings Write

ParametersExpand Collapse

params PolicyNewParams

ZoneID param.Field[string]

Path param: Identifier

maxLength32

Policy param.Field[Policy]

Body param

ReturnsExpand Collapse

type PolicyNewResponse struct{…}

ID string

Identifier

maxLength32

Action PolicyNewResponseAction

The action to take if the expression matches

One of the following:

const PolicyNewResponseActionAllow PolicyNewResponseAction = "allow"

const PolicyNewResponseActionLog PolicyNewResponseAction = "log"

const PolicyNewResponseActionAddReportingDirectives PolicyNewResponseAction = "add_reporting_directives"

Description string

A description for the policy

Enabled bool

Whether the policy is enabled

Expression string

The expression which must match for the policy to be applied, using the Cloudflare Firewall rule expression syntax

Value string

The policy which will be applied

Create a Page Shield policy

package main

import (
  "context"
  "fmt"

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

func main() {
  client := cloudflare.NewClient(
    option.WithAPIKey("144c9defac04969c7bfad8efaa8ea194"),
    option.WithAPIEmail("user@example.com"),
  )
  policy, err := client.PageShield.Policies.New(context.TODO(), page_shield.PolicyNewParams{
    ZoneID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
    Policy: page_shield.PolicyParam{
      Action: cloudflare.F(page_shield.PolicyActionAllow),
      Description: cloudflare.F("Checkout page CSP policy"),
      Enabled: cloudflare.F(true),
      Expression: cloudflare.F(`ends_with(http.request.uri.path, "/checkout")`),
      Value: cloudflare.F("script-src 'none';"),
    },
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", policy.ID)
}

{
  "result": {
    "id": "023e105f4ecef8ad9ca31a8372d0c353",
    "action": "allow",
    "description": "Checkout page CSP policy",
    "enabled": true,
    "expression": "ends_with(http.request.uri.path, \"/checkout\")",
    "value": "script-src 'none';"
  },
  "success": true,
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ]
}

Returns Examples

{
  "result": {
    "id": "023e105f4ecef8ad9ca31a8372d0c353",
    "action": "allow",
    "description": "Checkout page CSP policy",
    "enabled": true,
    "expression": "ends_with(http.request.uri.path, \"/checkout\")",
    "value": "script-src 'none';"
  },
  "success": true,
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ]
}