CentralCSP
APIWebsites

Get a website

Returns one website with its reporting endpoint, settings, usage limit, and your role on it.

Requires the viewer role on the website.

GET
/v1/workspaces/{workspaceId}/websites/{websiteId}

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

A website and the endpoint that collects its reports.

application/json
  1. response
id*string

Unique identifier of the website.

workspaceId*string

The workspace the website belongs to.

name*string

Display name.

url*|

Address of the site. Empty when none was ever recorded.

endpointUrl*string

Where browsers send this website's reports. Put it in your Reporting-Endpoints header.

Formaturi
endpointEnabled*boolean

Whether the endpoint accepts reports right now. It turns off when the website or its workspace reaches its usage limit, and back on at the start of the next period.

legacyEndpointUrl*|

An older reporting endpoint that still forwards to endpointUrl for now, or null. Move your headers to endpointUrl.

usageLimit*||

Cap on reports accepted per period for this website. null means only the workspace limit applies.

settings*

How incoming reports are filtered and cleaned.

role*|

Your role on this website.

tags*array<>

The workspace tags this website carries, by name.

usage*

Reports accepted in the current calendar month (UTC).

createdAt*string

When the website was created.

Formatdate-time
updatedAt*string

When the website was last changed.

Formatdate-time
Example Request
curl -X GET 'https://api.centralcsp.com/v1/workspaces/01936b7a-6f2e-7c31-9a4d-2f8e1c5b7d90/websites/01936b7a-6f2e-7c31-9a4d-2f8e1c5b7d90'
Example Response
{  "id": "string",  "workspaceId": "string",  "name": "Acme Shop",  "url": "",  "endpointUrl": "https://acme.reports.centralcsp.com",  "endpointEnabled": true,  "legacyEndpointUrl": "https://report.centralcsp.com/64f1c2e8a1b2c3d4e5f60718",  "usageLimit": 0,  "settings": {    "allowedOrigins": [      "https://example.com",      "https://*.example.com"    ],    "dropQueryAndFragments": true,    "dropReferrer": true,    "dropReportsFromExtensions": true  },  "role": "viewer",  "tags": [    {      "id": "string",      "name": "production",      "color": "slate",      "description": "Sites customers reach today."    }  ],  "usage": {    "value": 12840,    "limit": 0  },  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Create a website POST

Creates a website and returns the endpoint browsers send its reports to, as endpointUrl. Point your Reporting-Endpoints header at that URL to start collecting.

Update a website PATCH

Changes the website's display name, address or tags. Only the fields you send are changed, and tagIds replaces the website's tags like setting them does.