The brand API lets your own tools read monitors, matches, searches and exports, and act on them. Access uses a machine credential: a bearer token limited to one store and to the scopes you select.
Issue a credential
Only the store owner can manage credentials. Issuing one needs the Protect plan; listing and revoking remain available on any plan.
Open Brand → Settings → Credentials
Under Issue a machine credential, enter a Credential name.
Set the expiry
Expires at UTC takes a time within the next 365 days, in the form
YYYY-MM-DDTHH:mm:ss.sssZ.Select scopes
Grant only what the integration needs. Read and write scopes are separate.
Area Read Write Monitors monitors:readmonitors:writeLogos assets:readassets:writeMatches matches:readmatches:reviewSearches searches:readsearches:startChanges changes:readExports exports:readexports:startNotifications notifications:readnotifications:write,notifications:test,notifications:retryInvestigations investigations:readinvestigations:lookup,registration:lookup,network:lookupSecurity scans security:scan,security:review,security:respondBind it to an agency user (optional)
Agency binding ties the credential to one agency user’s grant on your store, and write scopes need a role that permits actions. Changing the user’s role, granting them again, or revoking the grant invalidates the credential.
Copy the token
New bearer token is shown once. Copy it before you click Hide bearer.
Call the API
Requests go to your store’s path and carry the token in the Authorization header:
curl https://app.use-protect.com/api/brand/your-store.myshopify.com/monitors \
-H "Authorization: Bearer $PROTECT_TOKEN" \
-H "Api-Version: 1"The Api-Version header pins the contract your integration was written against. Without it you get the current version; every response names the version it was served with, and an unsupported version is refused with 400.
The full contract, with every endpoint and schema, is the OpenAPI document at /api/brand/openapi.json.
Revoke a credential
Under Issued credentials, revoke the credential and enter a Revocation reason. Revocation applies to the next request, and also stops a download that is already running.