CentralCSP
APIUsage

List website usage-alert recipients

Returns the members emailed when this website passes 80% of its usage limit and again when it reaches 100%. A recipient who has lost access to the website is returned with hasAccess: false and is not emailed until access is restored.

Requires the manager role on the website.

GET
/v1/workspaces/{workspaceId}/websites/{websiteId}/usage-alerts/recipients

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.

Response Body

Who is emailed as usage approaches the limit.

application/json
  1. response
recipients*array<>

Members on the list. An empty array means nobody is emailed.

Example Request
curl -X GET 'https://api.centralcsp.com/v1/workspaces/01936b7a-6f2e-7c31-9a4d-2f8e1c5b7d90/websites/01936b7a-6f2e-7c31-9a4d-2f8e1c5b7d90/usage-alerts/recipients'
Example Response
{  "recipients": [    {      "memberId": "string",      "hasAccess": true,      "email": "string",      "firstName": "string",      "lastName": "string"    }  ]}

Set workspace usage-alert recipients PUT

Replaces the recipient list. Send an empty array to turn workspace usage emails off. Every id must belong to a member of this workspace.

Set website usage-alert recipients PUT

Replaces the recipient list for this website. Send an empty array to turn its usage emails off. Every id must belong to a member who has access to this website.