Skip to navigation
BotBye APIAnti-PhishingProject Domains

list domains

View as Markdown

List all domain records of a project.

Every record is WHITELISTED: a host of yours that is never flagged as a clone. The site BotBye protects is not a record — it is the project’s own domain.

Accepted permissions Account → Phishing Projects → Phishing projects list

Token scope Account Phishing Projects View

Authentication

X-Api-Keystring

Personal access token. Create it in your BotBye account under Profile → Personal Access Tokens, tick the scopes the endpoints you call require (see each endpoint’s Token scope), and send the token in the X-Api-Key request header. A token works only for the account it was created in.

Path parameters

account_idstringRequired
project_idstringRequired

Response

success
idstringformat: "uuid"
domainstring
createdAtstringformat: "utc-millisec"
updatedAtstringformat: "utc-millisec"
authorobject
projectIdstringformat: "uuid"
statusenum
Allowed values:
deletedAtstring or nullOptionalformat: "utc-millisec"
notestring or nullOptional