Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Detect And Respond Threshold Overrides

List Threshold Overrides

get

Returns an array of Threshold Overrides.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
200

List of Requested Threshold Overrides

application/json
get/api/v1/rule-engine/triggers
GET /api/v1/rule-engine/triggers HTTP/1.1
Host: api.netography.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "meta": {
    "code": 200,
    "count": 1
  },
  "data": [
    {
      "algorithm": "text",
      "auto": true,
      "beta": true,
      "bypassdisplay": true,
      "bypassrule": true,
      "createdby": "text",
      "default": true,
      "discards": [],
      "items": "text",
      "ndm_score_confidence": 1,
      "ndm_score_threat": 1,
      "rollupperiod": 1,
      "sharedkey": true,
      "state": "text",
      "thresholds": [
        {
          "severity": "low",
          "threshold": "text"
        }
      ],
      "track": "text",
      "updateinterval": 1
    }
  ]
}

Create or Update Threshold Overrides

put

Create or update threshold overrides given the provided object.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body

Threshold Override Create or Update Config

algorithmstringRequired
autobooleanOptional
betabooleanOptional
bypassdisplaybooleanOptional
bypassrulebooleanOptional
createdbystringOptional
defaultbooleanOptional
discardsarrayOptional
itemsstringOptional
ndm_score_confidenceintegerOptional
ndm_score_threatintegerOptional
rollupperiodintegerRequired
sharedkeybooleanOptional
statestringOptional
trackstringRequired
updateintervalintegerRequired
Responses
200

List of Requested Threshold Overrides

application/json
put/api/v1/rule-engine/triggers
PUT /api/v1/rule-engine/triggers HTTP/1.1
Host: api.netography.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 328

{
  "algorithm": "text",
  "auto": true,
  "beta": true,
  "bypassdisplay": true,
  "bypassrule": true,
  "createdby": "text",
  "default": true,
  "discards": [],
  "items": "text",
  "ndm_score_confidence": 1,
  "ndm_score_threat": 1,
  "rollupperiod": 1,
  "sharedkey": true,
  "state": "text",
  "thresholds": [
    {
      "severity": "low",
      "threshold": "text"
    }
  ],
  "track": "text",
  "updateinterval": 1
}
{
  "meta": {
    "code": 200,
    "count": 1
  },
  "data": [
    {
      "algorithm": "text",
      "auto": true,
      "beta": true,
      "bypassdisplay": true,
      "bypassrule": true,
      "createdby": "text",
      "default": true,
      "discards": [],
      "items": "text",
      "ndm_score_confidence": 1,
      "ndm_score_threat": 1,
      "rollupperiod": 1,
      "sharedkey": true,
      "state": "text",
      "thresholds": [
        {
          "severity": "low",
          "threshold": "text"
        }
      ],
      "track": "text",
      "updateinterval": 1
    }
  ]
}

Delete All Threshold Overrides

delete

Deletes custom threshold overrides.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
204

An empty array

No content
delete/api/v1/rule-engine/triggers
DELETE /api/v1/rule-engine/triggers HTTP/1.1
Host: api.netography.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List Threshold Overrides for Algorithm

get

Returns an array of Threshold Overrides for the specified algorithm.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
algorithmstringRequired

The algorithm to fetch threshold overrides for.

Responses
200

List of Requested Threshold Overrides

application/json
get/api/v1/rule-engine/triggers/algorithms/{algorithm}
GET /api/v1/rule-engine/triggers/algorithms/{algorithm} HTTP/1.1
Host: api.netography.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "meta": {
    "code": 200,
    "count": 1
  },
  "data": [
    {
      "algorithm": "text",
      "auto": true,
      "beta": true,
      "bypassdisplay": true,
      "bypassrule": true,
      "createdby": "text",
      "default": true,
      "discards": [],
      "items": "text",
      "ndm_score_confidence": 1,
      "ndm_score_threat": 1,
      "rollupperiod": 1,
      "sharedkey": true,
      "state": "text",
      "thresholds": [
        {
          "severity": "low",
          "threshold": "text"
        }
      ],
      "track": "text",
      "updateinterval": 1
    }
  ]
}

Delete Threshold Overrides for Algorithm

delete

Deletes threshold overrides for the specified algorithm.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
algorithmstringRequired

The algorithm to delete threshold overrides for.

Responses
204

An empty array

No content
delete/api/v1/rule-engine/triggers/algorithms/{algorithm}
DELETE /api/v1/rule-engine/triggers/algorithms/{algorithm} HTTP/1.1
Host: api.netography.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List Threshold Overrides for Object

get

Returns an array of Threshold Overrides for the specified object.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
objectstringRequired

The object to fetch threshold overrides for.

Responses
200

List of Requested Threshold Overrides

application/json
get/api/v1/rule-engine/triggers/objects/{object}
GET /api/v1/rule-engine/triggers/objects/{object} HTTP/1.1
Host: api.netography.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "meta": {
    "code": 200,
    "count": 1
  },
  "data": [
    {
      "algorithm": "text",
      "auto": true,
      "beta": true,
      "bypassdisplay": true,
      "bypassrule": true,
      "createdby": "text",
      "default": true,
      "discards": [],
      "items": "text",
      "ndm_score_confidence": 1,
      "ndm_score_threat": 1,
      "rollupperiod": 1,
      "sharedkey": true,
      "state": "text",
      "thresholds": [
        {
          "severity": "low",
          "threshold": "text"
        }
      ],
      "track": "text",
      "updateinterval": 1
    }
  ]
}

Delete Threshold Overrides for Object

delete

Deletes threshold overrides for the specified object.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
objectstringRequired

The object to delete threshold overrides for.

Responses
204

An empty array

No content
delete/api/v1/rule-engine/triggers/objects/{object}
DELETE /api/v1/rule-engine/triggers/objects/{object} HTTP/1.1
Host: api.netography.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List Threshold Overrides for Algorithm and Object

get

Returns an array of Threshold Overrides for the specified algorithm and object.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
algorithmstringRequired

The algorithm to fetch threshold overrides for.

objectstringRequired

The object to fetch threshold overrides for.

Responses
200

List of Requested Threshold Overrides

application/json
get/api/v1/rule-engine/triggers/algorithms/{algorithm}/objects/{object}
GET /api/v1/rule-engine/triggers/algorithms/{algorithm}/objects/{object} HTTP/1.1
Host: api.netography.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "meta": {
    "code": 200,
    "count": 1
  },
  "data": [
    {
      "algorithm": "text",
      "auto": true,
      "beta": true,
      "bypassdisplay": true,
      "bypassrule": true,
      "createdby": "text",
      "default": true,
      "discards": [],
      "items": "text",
      "ndm_score_confidence": 1,
      "ndm_score_threat": 1,
      "rollupperiod": 1,
      "sharedkey": true,
      "state": "text",
      "thresholds": [
        {
          "severity": "low",
          "threshold": "text"
        }
      ],
      "track": "text",
      "updateinterval": 1
    }
  ]
}

Delete Threshold Overrides for Algorithm and Object

delete

Deletes threshold overrides for the specified algorithm and object.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
algorithmstringRequired

The algorithm to delete threshold overrides for.

objectstringRequired

The object to delete threshold overrides for.

Responses
204

An empty array

No content
delete/api/v1/rule-engine/triggers/algorithms/{algorithm}/objects/{object}
DELETE /api/v1/rule-engine/triggers/algorithms/{algorithm}/objects/{object} HTTP/1.1
Host: api.netography.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content
PreviousDetect And Respond Response Policies
NextTraffic Sources Devices

Last updated