Takedowns Management API

The Takedown Management API provides comprehensive API endpoints for managing takedown requests across different threat types and platforms. This API enables users to create, monitor, and manage takedown requests for malicious content and domains.

Authentication

Check the authentication page to see the available options.

Access and authenticationchevron-right

Takedowns API Base URL

The base URL for the takedown API is https://takedown.bfore.ai/api

Takedown Listing

Retrieves a paginated list of takedown requests

get
Authorizations
OAuth2passwordRequired
Token URL:
Query parameters
sinceany ofOptional
string · date-timeOptional
or
nullOptional
untilany ofOptional
string · date-timeOptional
or
nullOptional
brand_idany ofOptional

Filter by one or more brand IDs

integer[]Optional
or
nullOptional
company_idsany ofOptional
integer[]Optional
or
nullOptional
attack_urlany ofOptional
stringOptional
or
nullOptional
brand_nameany ofOptional
stringOptional
or
nullOptional
status_namesany ofOptional

Filter takedown requests by status

Example: initial_phase
or
nullOptional
takedown_typeany ofOptional

Filter takedown requests by type

Example: identified_threat_domain
or
nullOptional
sortany ofOptionalDefault: created
string · enumOptionalPossible values:
or
nullOptional
orderany ofOptionalDefault: descending
string · enumOptionalPossible values:
or
nullOptional
pageinteger · min: 1Optional

Page number

Default: 1
sizeinteger · min: 1 · max: 100Optional

Page size

Default: 50
Responses
chevron-right
200

Successful Response

application/json
totalany ofRequired
integerOptional
or
nullOptional
pageany ofRequired
integer · min: 1Optional
or
nullOptional
sizeany ofRequired
integer · min: 1Optional
or
nullOptional
pagesany ofOptional
integerOptional
or
nullOptional
get
/v2/takedown/list

Get Takedown Requests By Id

get

Fetches the details of a takedown request using the provided takedown ID

Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
takedown_idstringRequired
Responses
chevron-right
200

Successful Response

application/json
or
nullOptional
get
/v2/takedown/{takedown_id}

Takedown Creation

Start a takedown from a confirmed attack

Takedowns are automatically initiated when your PreCrime configuration is enabled for automatic takedown processing. For manual takedown management, confirmed attacks information can be retrieved using the /v2/takedown/attacks endpoint.

Confirmed attacks are already undergoing disruption through our Network Disruption Partners and are ready for complete takedown processing. Only attacks with confirmed status are eligible for takedown initiation. This endpoint automatically filters requests to include only confirmed attacks.

Get Attacks

get
Authorizations
OAuth2passwordRequired
Token URL:
Query parameters
fromstring · date-timeRequired
untilstring · date-timeRequired
statusany ofOptionalDefault: ["confirmed"]
or
nullOptional
company_idsany ofOptional
integer[]Optional
or
nullOptional
attack_nameany ofOptional
stringOptional
or
nullOptional
sortstring · enumOptionalDefault: updated_atPossible values:
orderstring · enumOptionalDefault: descendingPossible values:
pageinteger · min: 1Optional

Page number

Default: 1
sizeinteger · min: 1 · max: 100Optional

Page size

Default: 50
brand_idany ofOptional

Filter by one or more brand IDs

integer[]Optional
or
nullOptional
protected_asset_idany ofOptional

Filter by one or more brand IDs

integer[]Optional
or
nullOptional
Responses
chevron-right
200

Successful Response

application/json
totalany ofRequired
integerOptional
or
nullOptional
pageany ofRequired
integer · min: 1Optional
or
nullOptional
sizeany ofRequired
integer · min: 1Optional
or
nullOptional
pagesany ofOptional
integerOptional
or
nullOptional
warningany ofOptional
stringOptional
or
nullOptional
get
/v2/takedown/attacks

Accept a confirmed attack takedown

post

Accept a takedown for an attack that has been flagged as confirmed by BforeAI.

Authorizations
OAuth2passwordRequired
Token URL:
Body
attack_idintegerRequired
brand_idintegerRequired
Responses
chevron-right
200

Takedown successfully initiated

application/json
idstringRequired
createdstring · date-timeRequired
attack_urlany ofOptional
stringOptional
or
nullOptional
brand_nameany ofRequired
stringOptional
or
nullOptional
user_idstringRequired
descriptionstringRequired
company_idany ofOptional
integerOptional
or
nullOptional
status_idintegerRequired
status_namestringRequired
updated_atstring · date-timeRequired
brand_idany ofOptional
integerOptional
or
nullOptional
attack_idany ofOptional
integerOptional
or
nullOptional
takedown_typeany ofOptional
stringOptional
or
nullOptional
cancellation_reasonany ofOptional
stringOptional
or
nullOptional
platformany ofOptional
stringOptional
or
nullOptional
threat_typeany ofOptional
stringOptional
or
nullOptional
rejection_reasonany ofOptional
stringOptional
or
nullOptional
rejection_descriptionany ofOptional
stringOptional
or
nullOptional
post
/v2/takedown/accept

Request a an infrastructure takedown

Request a takedown for a potential false negative

post

Request a takedown for a domain not yet identified as malicious. If the domain was already detected, a 202 Accepted response will be returned with a message.

Authorizations
OAuth2passwordRequired
Token URL:
Body
urlstring · uri · min: 1 · max: 2083Required
brand_idintegerRequired
commentstringRequired
Responses
chevron-right
200

Takedown successfully initiated

application/json
or
post
/v2/takedown/request

Request a social media takedown

Create a takedown request for social media content

post

Submit a takedown request for a social media threat. Takedowns created via this endpoint will be assigned a 'pending' status by default.

Authorizations
OAuth2passwordRequired
Token URL:
Body
threat_typestring · enumRequiredPossible values:
platformstring · enumRequiredPossible values:
malicious_urlstring · uri · min: 1 · max: 2083Required
brand_idintegerRequired
commentany ofOptional
stringOptional
or
nullOptional
company_idany ofOptional
integerOptional
or
nullOptional
Responses
chevron-right
200

Takedown successfully initiated

application/json
idstringRequired
createdstring · date-timeRequired
attack_urlany ofOptional
stringOptional
or
nullOptional
brand_nameany ofRequired
stringOptional
or
nullOptional
user_idstringRequired
descriptionstringRequired
company_idany ofOptional
integerOptional
or
nullOptional
status_idintegerRequired
status_namestringRequired
updated_atstring · date-timeRequired
brand_idany ofOptional
integerOptional
or
nullOptional
attack_idany ofOptional
integerOptional
or
nullOptional
takedown_typeany ofOptional
stringOptional
or
nullOptional
cancellation_reasonany ofOptional
stringOptional
or
nullOptional
platformany ofOptional
stringOptional
or
nullOptional
threat_typeany ofOptional
stringOptional
or
nullOptional
rejection_reasonany ofOptional
stringOptional
or
nullOptional
rejection_descriptionany ofOptional
stringOptional
or
nullOptional
post
/v2/takedown/social-media

Takedown Cancelation

Cancel an existing takedown request by providing the takedown ID and a valid cancellation reason. Please note that cancellation success depends on the current status of the takedown process and the involvement of third-party entities. While we will attempt to process all cancellation requests, completion cannot be guaranteed due to external dependencies and process constraints.

Cancel a submitted takedown request

post
Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
takedown_idstringRequired
Body
cancel_reason_idintegerRequired
descriptionany ofOptional
stringOptional
or
nullOptional
Responses
chevron-right
200

Successful Response

application/json
messagestringRequired
takedown_idstringRequired
new_statusstringRequired
descriptionany ofOptional
stringOptional
or
nullOptional
rejection_reasonany ofOptional
stringOptional
or
nullOptional
post
/v2/takedown/{takedown_id}/cancel

Reference Data and Configuration

Here you can find utility endpoints that provide the configuration options used in the rest of the API requests.

Get All Statuses

get
Authorizations
OAuth2passwordRequired
Token URL:
Query parameters
takedown_typeany ofOptional

Filter by takedown type

stringOptional
or
nullOptional
Responses
chevron-right
200

Successful Response

application/json
idintegerRequired
namestringRequired
descriptionstringRequired
get
/v2/takedown/statuses

Get Takedown Types V2

get
Authorizations
OAuth2passwordRequired
Token URL:
Responses
chevron-right
200

Successful Response

application/json
string[]Optional
get
/v2/takedown/takedown_types/
200

Successful Response

Get Social Media Platform Names

get
Authorizations
OAuth2passwordRequired
Token URL:
Responses
chevron-right
200

Successful Response

application/json
itemsstring[]Required
get
/v2/takedown/social_media/platforms
200

Successful Response

Get Cancellation Reasons

get
Authorizations
OAuth2passwordRequired
Token URL:
Responses
chevron-right
200

Successful Response

application/json
idintegerRequired
reasonstringRequired
is_activebooleanOptionalDefault: true
get
/v2/takedown/cancellation_reasons
200

Successful Response

Get Threat Types

get
Authorizations
OAuth2passwordRequired
Token URL:
Responses
chevron-right
200

Successful Response

application/json
itemsstring[]Required
get
/v2/takedown/social_media/threat_types
200

Successful Response

Last updated

Was this helpful?