Lists all connections detected by Page Shield.
/zones/{zone_id}/page_shield/connections
get
Page Shield
page-shield-list-page-shield-connections
{
"business": true,
"enterprise": true,
"free": false,
"pro": false
}null[
{
"in": "path",
"name": "zone_id",
"required": true,
"schema": {
"description": "Identifier",
"example": "023e105f4ecef8ad9ca31a8372d0c353",
"maxLength": 32,
"readOnly": true,
"type": "string"
}
},
{
"in": "query",
"name": "exclude_urls",
"schema": {
"description": "Excludes connections whose URL contains one of the URL-encoded URLs separated by commas.\n",
"example": "blog.cloudflare.com,www.example",
"type": "string"
}
},
{
"in": "query",
"name": "urls",
"schema": {
"description": "Includes connections whose URL contain one or more URL-encoded URLs separated by commas.\n",
"example": "blog.cloudflare.com,www.example",
"type": "string"
}
},
{
"in": "query",
"name": "hosts",
"schema": {
"description": "Includes connections that match one or more URL-encoded hostnames separated by commas.\n\nWildcards are supported at the start and end of each hostname to support starts with, ends with\nand contains. If no wildcards are used, results will be filtered by exact match\n",
"example": "blog.cloudflare.com,www.example*,*cloudflare.com",
"type": "string"
}
},
{
"in": "query",
"name": "page",
"schema": {
"description": "The current page number of the paginated results.\n\nWe additionally support a special value \"all\". When \"all\" is used, the API will return all the connections\nwith the applied filters in a single page. Additionally, when using this value, the API will not return \nthe categorisation data for the URL and domain of the connections. This feature is best-effort and it may \nonly work for zones with a low number of connections\n",
"example": 2,
"type": "string"
}
},
{
"in": "query",
"name": "per_page",
"schema": {
"description": "The number of results per page.",
"example": 100,
"maximum": 100,
"minimum": 1,
"type": "number"
}
},
{
"in": "query",
"name": "order_by",
"schema": {
"description": "The field used to sort returned connections.",
"enum": [
"first_seen_at",
"last_seen_at"
],
"example": "first_seen_at",
"type": "string"
}
},
{
"in": "query",
"name": "direction",
"schema": {
"description": "The direction used to sort returned connections.",
"enum": [
"asc",
"desc"
],
"example": "asc",
"type": "string"
}
},
{
"in": "query",
"name": "prioritize_malicious",
"schema": {
"description": "When true, malicious connections appear first in the returned connections.",
"example": true,
"type": "boolean"
}
},
{
"in": "query",
"name": "exclude_cdn_cgi",
"schema": {
"description": "When true, excludes connections seen in a `/cdn-cgi` path from the returned connections. The default value is true.",
"example": true,
"type": "boolean"
}
},
{
"in": "query",
"name": "status",
"schema": {
"description": "Filters the returned connections using a comma-separated list of connection statuses. Accepted values: `active`, `infrequent`, and `inactive`. The default value is `active`.",
"example": "active,inactive",
"type": "string"
}
},
{
"in": "query",
"name": "page_url",
"schema": {
"description": "Includes connections that match one or more page URLs (separated by commas) where they were last seen\n\nWildcards are supported at the start and end of each page URL to support starts with, ends with\nand contains. If no wildcards are used, results will be filtered by exact match\n",
"example": "example.com/page,*/checkout,example.com/*,*checkout*",
"type": "string"
}
},
{
"in": "query",
"name": "export",
"schema": {
"description": "Export the list of connections as a file. Cannot be used with per_page or page options.",
"enum": [
"csv"
],
"example": "csv",
"type": "string"
}
}
]null{
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"allOf": [
{
"properties": {
"errors": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"messages": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"result": {
"anyOf": [
{
"type": "object"
},
{
"items": {},
"type": "array"
},
{
"type": "string"
}
]
},
"success": {
"description": "Whether the API call was successful",
"enum": [
true
],
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result": {
"items": {},
"nullable": true,
"type": "array"
},
"result_info": {
"properties": {
"count": {
"description": "Total number of results for the requested service",
"example": 1,
"type": "number"
},
"page": {
"description": "Current page within paginated list of results",
"example": 1,
"type": "number"
},
"per_page": {
"description": "Number of results per page of results",
"example": 20,
"type": "number"
},
"total_count": {
"description": "Total results available without any search parameters",
"example": 2000,
"type": "number"
}
},
"type": "object"
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"items": {
"properties": {
"added_at": {
"example": "2021-08-18T10:51:10.09615Z"
},
"domain_reported_malicious": {
"example": false
},
"first_page_url": {
"example": "blog.cloudflare.com/page"
},
"first_seen_at": {
"example": "2021-08-18T10:51:08Z"
},
"host": {
"example": "blog.cloudflare.com"
},
"id": {
"example": "c9ef84a6bf5e47138c75d95e2f933e8f"
},
"last_seen_at": {
"example": "2021-09-02T09:57:54Z"
},
"page_urls": {
"example": [
"blog.cloudflare.com/page1",
"blog.cloudflare.com/page2"
]
},
"url": {
"example": "https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/4.6.0/js/bootstrap.min.js"
},
"url_contains_cdn_cgi_path": {
"example": false
}
}
},
"type": "array"
},
"result_info": {
"properties": {
"count": {
"description": "Total number of results for the requested service",
"example": 1,
"type": "number"
},
"page": {
"description": "Current page within paginated list of results",
"example": 1,
"type": "number"
},
"per_page": {
"description": "Number of results per page of results",
"example": 20,
"type": "number"
},
"total_count": {
"description": "Total results available without any search parameters",
"example": 2000,
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
}
]
}
}
},
"description": "List Page Shield connections response"
},
"4XX": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"allOf": [
{
"allOf": [
{
"properties": {
"errors": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"messages": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"result": {
"anyOf": [
{
"type": "object"
},
{
"items": {},
"type": "array"
},
{
"type": "string"
}
]
},
"success": {
"description": "Whether the API call was successful",
"enum": [
true
],
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result": {
"items": {},
"nullable": true,
"type": "array"
},
"result_info": {
"properties": {
"count": {
"description": "Total number of results for the requested service",
"example": 1,
"type": "number"
},
"page": {
"description": "Current page within paginated list of results",
"example": 1,
"type": "number"
},
"per_page": {
"description": "Number of results per page of results",
"example": 20,
"type": "number"
},
"total_count": {
"description": "Total results available without any search parameters",
"example": 2000,
"type": "number"
}
},
"type": "object"
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"items": {
"properties": {
"added_at": {
"example": "2021-08-18T10:51:10.09615Z"
},
"domain_reported_malicious": {
"example": false
},
"first_page_url": {
"example": "blog.cloudflare.com/page"
},
"first_seen_at": {
"example": "2021-08-18T10:51:08Z"
},
"host": {
"example": "blog.cloudflare.com"
},
"id": {
"example": "c9ef84a6bf5e47138c75d95e2f933e8f"
},
"last_seen_at": {
"example": "2021-09-02T09:57:54Z"
},
"page_urls": {
"example": [
"blog.cloudflare.com/page1",
"blog.cloudflare.com/page2"
]
},
"url": {
"example": "https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/4.6.0/js/bootstrap.min.js"
},
"url_contains_cdn_cgi_path": {
"example": false
}
}
},
"type": "array"
},
"result_info": {
"properties": {
"count": {
"description": "Total number of results for the requested service",
"example": 1,
"type": "number"
},
"page": {
"description": "Current page within paginated list of results",
"example": 1,
"type": "number"
},
"per_page": {
"description": "Number of results per page of results",
"example": 20,
"type": "number"
},
"total_count": {
"description": "Total results available without any search parameters",
"example": 2000,
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
}
]
},
{
"properties": {
"errors": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": [
{
"code": 7003,
"message": "No route for the URI"
}
],
"minLength": 1
},
"messages": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": []
},
"result": {
"enum": [
null
],
"nullable": true,
"type": "object"
},
"success": {
"description": "Whether the API call was successful",
"enum": [
false
],
"example": false,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
}
]
}
}
},
"description": "List Page Shield connections response failure"
}
}[
{
"api_email": [],
"api_key": []
}
]