Saltar al contenido principal
POST
Delete threat detection config

Descripción general

Elimina de forma lógica (soft-delete) una configuración de detección de amenazas de tu organización mediante su configId para que deje de escanear. Las demás configuraciones que comparten la misma fuente siguen ejecutándose. Con este endpoint solo se pueden eliminar las configuraciones que pertenecen a tu organización; las configuraciones globales siguen reservadas al personal (staff).

Cuándo usarlo

  • Quitar una configuración que ya no necesitas.
  • Retirar una variante de una fuente con varias configuraciones sin tocar las demás.
Eliminar la última configuración de una fuente que está activada de forma predeterminada para tu organización no es permanente: la automatización vuelve a crear una configuración predeterminada para esa fuente en su siguiente ejecución. Para detener una fuente así de forma duradera, llama a Actualizar configuración de detección con status establecido en DISABLED; la automatización no sobrescribirá ese valor.

Cómo funciona

  • Busca el configId con Listar configuraciones de detección.
  • Se establecen los campos deletedAt y updatedAt de la configuración, y se escribe una fila de historial con el estado sin cambios para que los trabajos de sincronización de valores predeterminados (default-sync) no traten la eliminación como un cambio de estado.

Autorizaciones

X-API-KEY
string
header
requerido

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.

Cuerpo

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
requerido

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

Rango requerido: 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

Respuesta

Successful response

Deleted detection config

success
boolean
requerido
id
number
requerido

ID of the deleted config