Skip to main content
POST
Delete threat detection config

Overview

Soft-delete one org-scoped threat detection config by configId so it stops scanning. Other configs sharing the same source keep running. Only configs owned by your organization can be deleted through this endpoint; global configs stay staff-only.

When to use

  • Remove a config you no longer need.
  • Retire one variant of a multi-config source without touching the others.
Deleting the last config for a source that is enabled by default for your organization is not permanent: automation re-creates a default config for that source on its next run. To stop such a source durably, call Update Detection Config with status set to DISABLED instead — automation will not override that.

How it works

  • Look up the configId with List Detection Configs.
  • The config’s deletedAt and updatedAt are set, and a history row is written with unchanged status so default-sync jobs don’t treat the deletion as a status change.

Authorizations

X-API-KEY
string
header
required

Your API key. This is required by most endpoints to access our API programatically. Reach out to us at support@chainpatrol.io to get an API key for your use.

Body

application/json

Delete a threat detection config

Deletes one detection config so it stops scanning. Deleting a config that shares a source with others leaves the others running.

Deleting the last config for a source that is enabled by default for your organization is not permanent: automation re-creates a default config for that source on its next run. To stop such a source durably, set status to DISABLED through /detection/configs/update instead, which automation will not override.

configId
integer
required

ID of the config to delete, from /detection/configs/list

Required range: x > 0
slug
string

Organization slug. Defaults to the organization your API key is scoped to, so you only need this when authenticating with a key that spans organizations.

Minimum string length: 1

Response

Successful response

Deleted detection config

success
boolean
required
id
number
required

ID of the deleted config