Skip to navigation
BotBye APIProtectionProjects

create

View as Markdown

POST /api/v1/{account_id}/projects

This endpoint creates a project within an account.

Request

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

Request body

  • name (string, required): The name of the project.
  • domain (string, required): The site to protect, as a bare hostname — example.com, not a URL. A value that is not a domain is rejected with protection_domain.not_valid_domain.

Response

200 with the id of the created project, as a bare JSON string.

"0198c39a-6f1b-7c4e-9a2d-5e8f10b3c7d4"

Accepted permissions Account → Projects → Create

Token scope Account Projects Actions

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

Request

This endpoint expects an object.
namestringRequired
domainstringRequired

Site to protect, as a bare hostname — example.com. Not a URL.

Response headers

Content-Lengthinteger
ConnectionstringOptional

Response

success

Errors

400
Bad Request Error