Read matches for string queries by ID

client.brandProtection.matches.get(, ?): MatchGetResponse { matches, total }

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

Accepted Permissions (at least one required)

Intel WriteIntel Read

ParametersExpand Collapse

params: MatchGetParams { account_id, id, include_domain_id, 2 more }

account_id: string

Path param

minLength1

id?: string

Query param

include_domain_id?: boolean

Query param

limit?: number

Query param

offset?: number

Query param

ReturnsExpand Collapse

MatchGetResponse { matches, total }

matches?: Array<Record<string, unknown>>

total?: number

Read matches for string queries by ID

import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const match = await client.brandProtection.matches.get({ account_id: 'x' });

console.log(match.matches);

{
  "matches": [
    {
      "foo": "bar"
    }
  ],
  "total": 0
}

Returns Examples

{
  "matches": [
    {
      "foo": "bar"
    }
  ],
  "total": 0
}