Brands management API
The Brand Management API provides the following functionality
Current Features:
List all protected brands in your account
Upcoming Features:
Add new brands to your protected list
Remove brands from your protected list
Additional brand management capabilities are currently in development and will be available in future releases.
Authentication
Check the authentication page to see the available options.
Access and authenticationManage Brands
Retrieve all domains protected by a specific company with optional pagination.
Authorization:
User must have access to the specified company
Pagination:
When
ippandpnare both 0 (default), returns simple array of domainsWhen pagination parameters are set, returns object with domains, total count, and pagination info
ippis clamped between 1-100pnminimum is 1
Auth header token that doesn't expire
Company ID
1Items per page (1-100). Setting to 0 disables pagination.
0Example: 20Page number (minimum 1). Setting to 0 disables pagination.
0Example: 1Hide parameter (filter criteria)
Protection statuses to filter by
["active","pending"]Successfully retrieved domains
Access denied - user not authorized for this company
Internal server error
GET /domain/company?c=1 HTTP/1.1
Host: api.bfore.ai
X-Authorization: YOUR_API_KEY
Accept: */*
[
{
"id": 500,
"name": "acme.com"
},
{
"id": 501,
"name": "example.com"
}
]Create a protection relationship between a company and a domain.
Authorization:
User must have access to the specified company
Domain Handling:
If
DomainIdis provided, uses existing domainIf
DomainNameis provided and domain doesn't exist, creates it firstMust provide either
DomainIdorDomainName
Status:
StatusNamedefaults to "active" if not provided
Auth header token that doesn't expire
Company ID (required)
1Existing domain ID (use this OR domainName)
500Domain name (creates if doesn't exist, use this OR domainId)
newdomain.comProtection status name (defaults to "active")
activeExample: activeDomain protection created successfully
Bad request - missing required fields
Access denied - user not authorized for this company
Internal server error
POST /company/protect HTTP/1.1
Host: api.bfore.ai
X-Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 52
{
"companyId": 1,
"domainId": 500,
"statusName": "active"
}{
"message": "Success",
"protectionId": 12345
}Add a status record to a domain's protection history for a specific company.
Authorization:
You must have access to the specified company
Requirements:
The domain must already be protected by the company (exist in the protection relationship)
The status must be a valid protection status value
Behavior:
Creates a new status entry in the domain's protection history
Does not remove previous statuses - maintains full history
Uses the current timestamp for the status entry
Available Status Values:
active- Domain protection is activedeactivated- Domain protection has been deactivateddeleted- Domain protection marked as deletedonboarded- Domain has been successfully onboardederror- An error occurred with the domain protectionowned- Domain is owned/controlled
Auth header token that doesn't expire
Company ID (required)
1Domain name (required). Must already be protected by the company.
example.comProtection status (required)
activePossible values: Status added successfully
Bad request - missing required fields, domain not found, or invalid status
Access denied - you do not have access to the specified company
Internal server error
POST /domainprotection/addStatus HTTP/1.1
Host: api.bfore.ai
X-Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 56
{
"companyId": 1,
"domain": "example.com",
"status": "active"
}{
"success": true
}Last updated
Was this helpful?