Sign in

v1

latestOpenAPI 3.0.02026-08-065019221.4 KB
Incidents

Update Incident options

Update specific runtime options of the incident

put/api/v1/user/incidents/{incidentId}

Path parameters

incidentIdstring required

ID of incident

Request body

Example request

{
  "incident": {
    "scanInterval": 3600,
    "watchedAttributes": [
      "detections",
      "tls"
    ],
    "userAgents": [
      "Chrome on Linux",
      "Chrome on macOS"
    ],
    "userAgentsPerInterval": 1,
    "countries": [
      "de",
      "us"
    ],
    "countriesPerInterval": 2,
    "stopDelaySuspended": 3600,
    "stopDelayInactive": 86400,
    "stopDelayMalicious": 90000,
    "scanIntervalAfterSuspended": 86400,
    "scanIntervalAfterMalicious": 86400,
    "observable": "foobar.com",
    "visibility": "private",
    "channels": [
      "{{channelId}}"
    ],
    "scanIntervalMode": "automatic",
    "expireAfter": 86400
  }
}

Response

Incident body

Example response

{
  "incident": {
    "_id": "{{incidentId}}",
    "scanInterval": 3600,
    "watchedAttributes": [
      "detections",
      "tls"
    ],
    "userAgents": [
      "Chrome on Linux",
      "Chrome on macOS"
    ],
    "userAgentsPerInterval": 1,
    "countries": [
      "de",
      "us"
    ],
    "countriesPerInterval": 2,
    "stopDelaySuspended": 3600,
    "stopDelayInactive": 86400,
    "stopDelayMalicious": 90000,
    "scanIntervalAfterSuspended": 86400,
    "scanIntervalAfterMalicious": 86400,
    "owner": "own",
    "type": "hostname",
    "observable": "foobar.com",
    "state": "active",
    "visibility": "private",
    "channels": [
      "{{channelId}}"
    ],
    "sourceType": "manual",
    "sourceId": "{{sourceId}}",
    "stateSize": 3717,
    "stateCount": 3,
    "scanIntervalMode": "automatic",
    "labels": [
      "hasHTTP",
      "hasIP",
      "hasMX",
      "hasNS"
    ],
    "expireAt": "2025-01-24T11:44:52.563Z",
    "createdAt": "2025-01-21T11:44:52.566Z",
    "scannedAt": "2025-01-21T12:44:52.566Z"
  }
}