Skip to navigation
BotBye APIProtectionProjects

find

View as Markdown

GET /api/v1/{account_id}/projects/{project_id}

This endpoint retrieves project details for a specific project within an account.

Request

No request body parameters are required for this endpoint.

  • base_url (string): The base URL of the API.
  • account_id (string): The unique identifier of the account.
  • project_id (string): The unique identifier of the project.

Response

The response for this request is a JSON object with the following schema:

{
  "id": "",
  "customerId": "",
  "name": "",
  "domain": "",
  "siteKey": "",
  "serverKey": "",
  "isProtected": true,
  "rules": {
    "order": [],
    "rules": []
  },
  "rateLimits": {
    "order": [],
    "rateLimits": []
  },
  "cdnConfig": null,
  "phishingIntegrationConfig": null,
  "captchaConfig": null,
  "responseExtraFields": [],
  "updatedAt": "",
  "createdAt": "",
  "subscriptionId": ""
}
  • id (string): The unique identifier of the project.
  • customerId (string): The unique identifier of the customer that owns the project.
  • name (string): The name of the project.
  • domain (string): The site the project protects, as a bare hostname — example.com.
  • siteKey (string): The site key of the project.
  • serverKey (string): The server key of the project.
  • isProtected (boolean): Indicates whether the project is protected.
  • rules (object): order holds the rule ids in evaluation order, rules the rules themselves.
  • rateLimits (object): order holds the rate limiter ids in evaluation order, rateLimits the rate limiters themselves.
  • cdnConfig (object | null): CDN integration, null when not configured.
  • phishingIntegrationConfig (object | null): Anti-Phishing integration, null when not configured.
  • captchaConfig (object | null): CAPTCHA integration, null when not configured.
  • responseExtraFields (array of string): Extra fields the validator attaches to its response.
  • updatedAt (string): When the project was last updated, epoch milliseconds.
  • createdAt (string): When the project was created, epoch milliseconds.
  • subscriptionId (string): The subscription the project is billed under.

Accepted permissions Project → Project → Info

Token scope Project 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 headers

Content-Lengthinteger
ConnectionstringOptional

Response

success
idstringformat: "uuid"
customerIdstringformat: "uuid"
namestring
domainstring
siteKeystringformat: "uuid"
serverKeystringformat: "uuid"
isProtectedboolean
rulesobject
rateLimitsobject
cdnConfigobject or null

CDN integration; null when not configured.

phishingIntegrationConfigobject or null

Anti-Phishing integration; null when not configured.

captchaConfigobject or null

CAPTCHA integration; null when not configured.

responseExtraFieldslist of enums
updatedAtstringformat: "utc-millisec"
createdAtstringformat: "utc-millisec"
subscriptionIdstringformat: "uuid"

Errors

400
Bad Request Error