CentralCSP
APIUsage

Set a website usage limit

Caps how many reports this website may accept per period. Send null to remove the cap. The limit cannot be higher than the workspace plan limit. A website that reaches its limit stops collecting shortly after and resumes at the start of the next period.

Requires the manager role on the website.

PUT
/v1/workspaces/{workspaceId}/websites/{websiteId}/usage/limit

Authorization

headerAuthorizationBearer <JWT>

An OpenID Connect access token from signing in to CentralCSP, acting as the signed-in user.

Path Parameters

workspaceId*string

The workspace's id.

websiteId*string

The website's id.

Request Body

application/json
  1. body

The new usage limit.

limit*||

Reports this website may accept per period, or null to remove the cap. Cannot exceed the workspace plan limit.

Response Body

The website usage limit is updated.

Example Request
curl -X PUT 'https://api.centralcsp.com/v1/workspaces/01936b7a-6f2e-7c31-9a4d-2f8e1c5b7d90/websites/01936b7a-6f2e-7c31-9a4d-2f8e1c5b7d90/usage/limit' \  -H 'Content-Type: application/json' \  -d '{  "limit": 100000}'
Example Response
Empty

Get website usage GET

Returns how many reports this website has accepted this period and the limit set on it. A null limit means only the workspace limit applies.

List workspace usage-alert recipients GET

Returns the members emailed when the workspace passes 80% of its plan limit and again when it reaches 100%. Each threshold sends at most one email per period.