Skip to content
Start here

Read matches for string queries by ID

GET/accounts/{account_id}/brand-protection/matches

Return matches for string queries based on ID.

Security
API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
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)
Intel WriteIntel Read
Path ParametersExpand Collapse
account_id: string
minLength1
Query ParametersExpand Collapse
id: optional string
include_dismissed: optional boolean
include_domain_id: optional boolean
limit: optional number
offset: optional number
ReturnsExpand Collapse
matches: optional array of map[unknown]
total: optional number

Read matches for string queries by ID

curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/brand-protection/matches \
    -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN"
{
  "matches": [
    {
      "foo": {}
    }
  ],
  "total": 0
}
Returns Examples
{
  "matches": [
    {
      "foo": {}
    }
  ],
  "total": 0
}