Channels

Disable, enable or rename a channel

PATCH/v1/channels/{id}

Enabling a channel clears its failure streak (a channel failing for 24 hours is disabled automatically).

Authentication: API key (Authorization: Bearer)
Required scope: write

Path parameters#

idstring · uuidrequired

Request body#

statestring
Values active disabled
namestring
1 to 80 characters

Responses#

200Updated channel.

Object fields

idstring · uuid
kindstring
Values webhook discord slack email telegram hellome
namestringnullable
statestring
Values active disabled
rolestring
Values alerts escalation
targetstringnullable
Masked destination, e.g. https://hooks.example.com/aicscan, a***@example.com.
created_atstring · date-time
disabled_atstring · date-timenullable
disabled_reasonstringnullable
last_success_atstring · date-timenullable
linked_atstring · date-timenullable

4xx · 5xxError.

Standard error format: see Errors.

Request

cURL

curl -X PATCH "https://aicscan.io/v1/channels/0193a1b3-7d21-7c55-8e0a-9f1b2c3d4e5f" \
  -H "Authorization: Bearer $AICSCAN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "state": "disabled"
  }'

JavaScript

const res = await fetch('https://aicscan.io/v1/channels/0193a1b3-7d21-7c55-8e0a-9f1b2c3d4e5f', {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${process.env.AICSCAN_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "state": "disabled"
  }),
});
const data = await res.json();
if (!res.ok) throw new Error(data.error.code);
console.log(data);

Python

import os
import requests

resp = requests.patch(
    "https://aicscan.io/v1/channels/0193a1b3-7d21-7c55-8e0a-9f1b2c3d4e5f",
    headers={
        "Authorization": f"Bearer {os.environ['AICSCAN_API_KEY']}",
    },
    json={
        "state": "disabled"
    },
    timeout=10,
)
resp.raise_for_status()
print(resp.json())

Response 200

JSON

{
  "id": "0193a1b3-7d21-7c55-8e0a-9f1b2c3d4e5f",
  "kind": "webhook",
  "name": "SIEM",
  "state": "active",
  "role": "alerts",
  "target": "https://hooks.example.com/aicscan",
  "created_at": "2026-11-14T09:12:40.118Z",
  "disabled_at": null,
  "disabled_reason": null,
  "last_success_at": "2026-11-14T09:30:14.020Z",
  "linked_at": null
}