Skip to main content

Documentation index for AI agents: llms.txt. Every page here is also served as markdown: add .md to its address, or request it with Accept: text/markdown.

Settings API

Application settings (deduplication, reports). This page lists all 5 endpoints in the Settings area of the Visual Sentinel REST API.

Base URL: https://visualsentinel.com. Unless an endpoint says otherwise it accepts an API key or a session cookie, see Authentication. Most error responses use the ErrorResponse shape, see Errors and Rate limits.

Endpoints

Get deduplication settings

GET /api/settings/deduplication

Get alert deduplication settings.

Responses

  • 200: Deduplication settings.

Update deduplication settings

PUT /api/settings/deduplication

Update alert deduplication configuration.

Responses

  • 200: Settings updated.

Get deduplication stats

GET /api/settings/deduplication/stats

Get statistics on how many alerts have been deduplicated.

Responses

  • 200: Deduplication statistics.

Get report settings

GET /api/settings/reports

Get scheduled report configuration.

Responses

  • 200: Report settings.

Update report settings

PUT /api/settings/reports

Update scheduled report configuration (frequency, recipients).

Responses

  • 200: Settings updated.

Generated from the OpenAPI 3.1 specification at https://docs.visualsentinel.com/openapi.json, the same file the interactive reference reads.