Cloudflare API | Page Shield › Connections › List Page Shield Connections

Wildcards are supported at the start and end of each hostname to support starts with, ends with and contains. If no wildcards are used, results will be filtered by exact match

order_by:

Optional

The field used to sort returned connections.

"first_seen_at"

"last_seen_at"

page: string

Optional

The current page number of the paginated results.

We additionally support a special value "all". When "all" is used, the API will return all the connections with the applied filters in a single page. This feature is best-effort and it may only work for zones with a low number of connections

page_url: string

Optional

Includes connections that match one or more page URLs (separated by commas) where they were last seen

Wildcards are supported at the start and end of each page URL to support starts with, ends with and contains. If no wildcards are used, results will be filtered by exact match

per_page: number

Optional

(maximum: 100, minimum: 1)

The number of results per page.

prioritize_malicious: boolean

Optional

When true, malicious connections appear first in the returned connections.

status: string

Optional

Filters the returned connections using a comma-separated list of connection statuses. Accepted values: active, infrequent, and inactive. The default value is active.

urls: string

Optional

Includes connections whose URL contain one or more URL-encoded URLs separated by commas.

Response fields

result_info: { count, page, per_page, 2 more... }

success: true

Whether the API call was successful

errors: Array<

ResponseInfo

Optional

messages: Array<

ResponseInfo

Optional

result: Array<

Connection

Optional

Request example

curl https://api.cloudflare.com/client/v4/zones/$ZONE_ID/page_shield/connections \
    -H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
    -H "X-Auth-Key: $CLOUDFLARE_API_KEY"

200Example

{
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000,
    "total_pages": 100
  },
  "success": true,
  "errors": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "result": [
    {
      "id": "023e105f4ecef8ad9ca31a8372d0c353",
      "added_at": "2021-08-18T10:51:10.09615Z",
      "first_seen_at": "2021-08-18T10:51:08Z",
      "host": "blog.cloudflare.com",
      "last_seen_at": "2021-09-02T09:57:54Z",
      "url": "https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/4.6.0/js/bootstrap.min.js",
      "url_contains_cdn_cgi_path": false,
      "domain_reported_malicious": false,
      "first_page_url": "blog.cloudflare.com/page",
      "malicious_domain_categories": [
        "Malware"
      ],
      "malicious_url_categories": [
        "Malware"
      ],
      "page_urls": [
        "blog.cloudflare.com/page1",
        "blog.cloudflare.com/page2"
      ],
      "url_reported_malicious": false
    }
  ]
}

Domain types

Connection = { id, added_at, first_seen_at, 10 more... }

Page Shield

Cookies

page_shield.cookies

Methods

Get A Page Shield Cookie -> Envelope<{ id, first_seen_at, host, 11 more... }>

get/zones/{zone_id}/page_shield/cookies/{cookie_id}

Fetches a cookie collected by Page Shield by cookie ID.

List Page Shield Cookies -> SinglePage<{ id, first_seen_at, host, 11 more... }>

get/zones/{zone_id}/page_shield/cookies

Lists all cookies collected by Page Shield.

Page Shield

Policies

page_shield.policies

Methods

Create A Page Shield Policy -> Envelope<{ id, action, description, 3 more... }>

post/zones/{zone_id}/page_shield/policies

Create a Page Shield policy.

Delete A Page Shield Policy ->

delete/zones/{zone_id}/page_shield/policies/{policy_id}

Delete a Page Shield policy by ID.

Get A Page Shield Policy -> Envelope<{ id, action, description, 3 more... }>

get/zones/{zone_id}/page_shield/policies/{policy_id}

Fetches a Page Shield policy by ID.

List Page Shield Policies -> SinglePage<{ id, action, description, 3 more... }>

get/zones/{zone_id}/page_shield/policies

Lists all Page Shield policies.

Update A Page Shield Policy -> Envelope<{ id, action, description, 3 more... }>

put/zones/{zone_id}/page_shield/policies/{policy_id}

Update a Page Shield policy by ID.

Domain types

Policy = { action, description, enabled, 2 more... }

Page Shield

Scripts

page_shield.scripts

Methods

Get A Page Shield Script -> Envelope<{ id, added_at, first_seen_at, 19 more... }>

get/zones/{zone_id}/page_shield/scripts/{script_id}

Fetches a script detected by Page Shield by script ID.

List Page Shield Scripts -> SinglePage<

Script

get/zones/{zone_id}/page_shield/scripts

Lists all scripts detected by Page Shield.

Domain types

Script = { id, added_at, first_seen_at, 18 more... }