Skip to main content
PUT
Update finding location settings
Switches page locations on or off for your organisation’s analyses; the setting is off by default. Send { "enabled": true } or { "enabled": false }, and the response returns the saved value.

Permission

Requires organisation_settings:write, which the Owner role holds by default. A caller without it receives 403.

What Changes

  • Past analyses too. The setting applies whenever an analysis is read, including analyses made before you changed it. If you switch it off, locations disappear from every analysis. If you switch it back on, they return. Nothing is analysed again or deleted.
  • Nothing else changes. Risk scores, findings and every other field in the analysis are the same with the setting on or off.
  • Changes are audited. Each change is recorded in the audit log as finding_location_settings.updated.

Best Practices

  • Send only enabled, as a boolean. A body with a missing or non-boolean enabled, or any other field, is rejected with 400.

Authorizations

x-api-key
string
header
required

Body

application/json

Request payload for updating finding location settings

enabled
boolean
required

Response

Finding location settings updated

enabled
boolean
required