CentralCSP
APIPolicy Builder

Build a recommended Permissions-Policy

Builds a Permissions-Policy from the website's Permissions-Policy reports over the period (last 7 days by default, up to 30), starting from your policy or every common feature denied. Features your pages or embedded frames used are granted; noise and features only third-party scripts used stay denied.

Send reportingEndpoints as the Reporting-Endpoints header with it. Anyone can send reports to the endpoint, so review granted features before deploying.

Limited to 10 requests a minute for each person, after which it answers 429 with a Retry-After header.

Requires the viewer role on the website and the report:permissions-policy-violation plan feature.

POST
/v1/workspaces/{workspaceId}/websites/{websiteId}/permissions-policy/recommended-policy

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 period of reports to learn from and, optionally, the policy to start from.

range?string

How far back to read reports, counted from now. Defaults to 7d and is ignored when from and to are given.

Value in"24h""7d""14d""30d"
from?string

Start of a calendar period instead of range. It must fall within the last 30 days and comes with to.

Formatdate-time
to?string

End of the calendar period, exclusive. It comes with from.

Formatdate-time
policy?string

The policy to start from, as a Permissions-Policy header value without the header name. Leave it out to start with every common feature denied.

Length1 <= length <= 16384

Response Body

A Permissions-Policy built from the website's reports, ready to deploy.

application/json
  1. response
policy*string

The recommended Permissions-Policy header value, without the header name. Each feature reports to the centralcsp group.

reportingEndpoints*string

The Reporting-Endpoints header value to send alongside the policy, without the header name. It declares the centralcsp group the policy reports to.

Example Request
curl -X POST 'https://api.centralcsp.com/v1/workspaces/01936b7a-6f2e-7c31-9a4d-2f8e1c5b7d90/websites/01936b7a-6f2e-7c31-9a4d-2f8e1c5b7d90/permissions-policy/recommended-policy' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response200
{  "policy": "camera=(self), geolocation=(self), payment=(\"https://pay.example.com\"), usb=()",  "reportingEndpoints": "centralcsp=\"https://e0123456789abcdef0123.report.centralcsp.com\", default=\"https://e0123456789abcdef0123.report.centralcsp.com\""}