CentralCSP
APIWebsites

Update ingestion settings

Changes how incoming reports are filtered and cleaned: which origins may send them, whether query strings, fragments, and referrers are stripped, and whether browser-extension noise is dropped. Only the fields you send are changed, and the new settings apply to reports received from then on.

Requires the manager role on the website.

PATCH
/v1/workspaces/{workspaceId}/websites/{websiteId}/settings

Authorization

AuthorizationBearer <token>

An OpenID Connect access token issued by Keycloak, acting as the signed-in user.

In: header

Path Parameters

workspaceId*string
websiteId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Only the fields you send are changed.

allowedOrigins?array<>|

Only accept reports sent from these origins. null accepts any origin, which is the default.

dropQueryAndFragments?boolean

Strip the query string and fragment from reported URLs before storing them. Useful when URLs carry order numbers or tokens.

dropReferrer?boolean

Do not store the referrer a report came with.

dropReportsFromExtensions?boolean

Discard reports caused by browser extensions, which are noise you cannot fix.

Response Body

application/json

curl -X PATCH "https://api-next.centralcsp.com/v1/workspaces/string/websites/string/settings" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string",  "workspaceId": "string",  "name": "Acme Shop",  "url": "https://shop.example.com",  "endpointUrl": "https://acme.reports.centralcsp.com",  "endpointEnabled": true,  "usageLimit": 0,  "settings": {    "allowedOrigins": [      "https://shop.example.com"    ],    "dropQueryAndFragments": true,    "dropReferrer": true,    "dropReportsFromExtensions": true  },  "role": "viewer",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}