Takedowns Management API
Authentication
Access and authenticationTakedowns API Base URL
Takedown Listing
Query parameters
sincestring · date-timeOptional
untilstring · date-timeOptional
brand_idinteger[]Optional
Filter by one or more brand IDs
company_idsinteger[]Optional
attack_urlstringOptional
brand_namestringOptional
sortall ofOptionalDefault:
createdstring · enumOptionalPossible values:
An enumeration.
orderall ofOptionalDefault:
descendingstring · enumOptionalPossible values:
An enumeration.
pageinteger · min: 1OptionalDefault:
1sizeinteger · min: 1 · max: 100OptionalDefault:
50Header parameters
X-AuthorizationstringOptional
Responses
200
Successful Response
application/json
422
Validation Error
application/json
get
/v2/takedown/listTakedown Creation
Start a takedown from a confirmed attack
Query parameters
fromstring · date-timeRequired
untilstring · date-timeRequired
company_idsinteger[]Optional
attack_namestringOptional
sortall ofOptionalDefault:
updated_atstring · enumOptionalPossible values:
An enumeration.
orderall ofOptionalDefault:
descendingstring · enumOptionalPossible values:
An enumeration.
pageinteger · min: 1OptionalDefault:
1sizeinteger · min: 1 · max: 100OptionalDefault:
50brand_idinteger[]Optional
Filter by one or more brand IDs
protected_asset_idinteger[]Optional
Filter by one or more brand IDs
Header parameters
X-AuthorizationstringOptional
Responses
200
Successful Response
application/json
422
Validation Error
application/json
get
/v2/takedown/attacksHeader parameters
X-AuthorizationstringOptional
Body
attack_idintegerRequired
brand_idintegerRequired
Responses
200
Takedown successfully initiated
application/json
404
Not Found - Threat ID not found or no company assigned
422
Validation Error
application/json
post
/v2/takedown/acceptRequest a an infrastructure takedown
Header parameters
X-AuthorizationstringOptional
Body
urlstring · uri · min: 1 · max: 2083Required
brand_idintegerRequired
commentstringRequired
Responses
200
Takedown successfully initiated
application/json
202
Takedown accepted but attack was already detected
application/json
400
Bad Request - e.g., brand is not active
404
Not Found - e.g., brand ID does not exist
422
Validation Error
application/json
post
/v2/takedown/requestRequest a social media takedown
Header parameters
X-AuthorizationstringOptional
Body
threat_typestring · enumRequiredPossible values:
An enumeration.
platformstring · enumRequiredPossible values:
An enumeration.
malicious_urlstring · uri · min: 1 · max: 2083Required
brand_idintegerRequired
commentstringRequired
Responses
200
Takedown successfully initiated
application/json
400
Bad Request - e.g., brand is not active
404
Not Found - e.g., brand ID does not exist
422
Validation Error
application/json
post
/v2/takedown/social-mediaTakedown Cancelation
Path parameters
takedown_idstringRequired
Header parameters
X-AuthorizationstringOptional
Body
cancel_reason_idintegerRequired
descriptionstringOptional
Responses
200
Successful Response
application/json
422
Validation Error
application/json
post
/v2/takedown/{takedown_id}/cancelReference Data and Configuration
Last updated
Was this helpful?