Get a Page Shield script

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

Fetches a script detected by Page Shield by script ID.

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 Shield ReadDomain Page ShieldPage Shield ReadZone Settings WriteZone Settings Read

Path ParametersExpand Collapse

zone_id: string

Identifier

maxLength32

script_id: string

Identifier

maxLength32

ReturnsExpand Collapse

result: { id, added_at, first_seen_at, 19 more }

id: string

Identifier

maxLength32

added_at: string

formatdate-time

first_seen_at: string

formatdate-time

host: string

last_seen_at: string

formatdate-time

url: string

url_contains_cdn_cgi_path: boolean

cryptomining_score: optional number

The cryptomining score of the JavaScript content.

maximum99

minimum1

Deprecateddataflow_score: optional number

The dataflow score of the JavaScript content. This field has been deprecated in favour of js_integrity_score.

maximum99

minimum1

domain_reported_malicious: optional boolean

fetched_at: optional string

The timestamp of when the script was last fetched.

first_page_url: optional string

hash: optional string

The computed hash of the analyzed script.

maxLength64

minLength64

js_integrity_score: optional number

The integrity score of the JavaScript content.

maximum99

minimum1

magecart_score: optional number

The magecart score of the JavaScript content.

maximum99

minimum1

malicious_domain_categories: optional array of string

malicious_url_categories: optional array of string

malware_score: optional number

The malware score of the JavaScript content.

maximum99

minimum1

Deprecatedobfuscation_score: optional number

The obfuscation score of the JavaScript content. This field has been deprecated in favour of js_integrity_score.

maximum99

minimum1

page_urls: optional array of string

url_reported_malicious: optional boolean

versions: optional array of { cryptomining_score, dataflow_score, fetched_at, 5 more }

cryptomining_score: optional number

The cryptomining score of the JavaScript content.

maximum99

minimum1

Deprecateddataflow_score: optional number

The dataflow score of the JavaScript content. This field has been deprecated in favour of js_integrity_score.

maximum99

minimum1

fetched_at: optional string

The timestamp of when the script was last fetched.

hash: optional string

The computed hash of the analyzed script.

maxLength64

minLength64

js_integrity_score: optional number

The integrity score of the JavaScript content.

maximum99

minimum1

magecart_score: optional number

The magecart score of the JavaScript content.

maximum99

minimum1

malware_score: optional number

The malware score of the JavaScript content.

maximum99

minimum1

Deprecatedobfuscation_score: optional number

The obfuscation score of the JavaScript content. This field has been deprecated in favour of js_integrity_score.

maximum99

minimum1

success: true

Whether the API call was successful

errors: optional array of ResponseInfo { code, message, documentation_url, source }

code: number

minimum1000

message: string

documentation_url: optional string

source: optional { pointer }

pointer: optional string

messages: optional array of ResponseInfo { code, message, documentation_url, source }

code: number

minimum1000

message: string

documentation_url: optional string

source: optional { pointer }

pointer: optional string

Get a Page Shield script

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

{
  "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,
    "cryptomining_score": 1,
    "dataflow_score": 1,
    "domain_reported_malicious": false,
    "fetched_at": "fetched_at",
    "first_page_url": "blog.cloudflare.com/page",
    "hash": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "js_integrity_score": 1,
    "magecart_score": 1,
    "malicious_domain_categories": [
      "Malware"
    ],
    "malicious_url_categories": [
      "Malware"
    ],
    "malware_score": 1,
    "obfuscation_score": 1,
    "page_urls": [
      "blog.cloudflare.com/page1",
      "blog.cloudflare.com/page2"
    ],
    "url_reported_malicious": false,
    "versions": [
      {
        "cryptomining_score": 20,
        "dataflow_score": 1,
        "fetched_at": "2021-08-18T10:51:08Z",
        "hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b423",
        "js_integrity_score": 2,
        "magecart_score": 10,
        "malware_score": 5,
        "obfuscation_score": 1
      }
    ]
  },
  "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",
    "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,
    "cryptomining_score": 1,
    "dataflow_score": 1,
    "domain_reported_malicious": false,
    "fetched_at": "fetched_at",
    "first_page_url": "blog.cloudflare.com/page",
    "hash": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "js_integrity_score": 1,
    "magecart_score": 1,
    "malicious_domain_categories": [
      "Malware"
    ],
    "malicious_url_categories": [
      "Malware"
    ],
    "malware_score": 1,
    "obfuscation_score": 1,
    "page_urls": [
      "blog.cloudflare.com/page1",
      "blog.cloudflare.com/page2"
    ],
    "url_reported_malicious": false,
    "versions": [
      {
        "cryptomining_score": 20,
        "dataflow_score": 1,
        "fetched_at": "2021-08-18T10:51:08Z",
        "hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b423",
        "js_integrity_score": 2,
        "magecart_score": 10,
        "malware_score": 5,
        "obfuscation_score": 1
      }
    ]
  },
  "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"
      }
    }
  ]
}