Skip to content
Start here

Read matches for string queries by ID

brand_protection.matches.get(MatchGetParams**kwargs) -> MatchGetResponse
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
ParametersExpand Collapse
account_id: str
minLength1
id: Optional[str]
include_dismissed: Optional[bool]
include_domain_id: Optional[bool]
limit: Optional[int]
offset: Optional[int]
ReturnsExpand Collapse
class MatchGetResponse: …
matches: Optional[List[Dict[str, object]]]
total: Optional[int]

Read matches for string queries by ID

import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
match = client.brand_protection.matches.get(
    account_id="x",
)
print(match.matches)
{
  "matches": [
    {
      "foo": {}
    }
  ],
  "total": 0
}
Returns Examples
{
  "matches": [
    {
      "foo": {}
    }
  ],
  "total": 0
}