Detect and Respond Threshold Overrides

List Threshold Overrides

get

Returns an array of Threshold Overrides.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

List of Requested Threshold Overrides

application/json

400

Bad Request. Typically due to a malformatted JSON body, or parameter values are not validating.

application/json

401

Access token is missing or invalid

application/json

403

Access is forbidden

application/json

default

Unknown Error Occurred

application/json

get

/api/v1/rule-engine/triggers

HTTPcURLJavaScriptPython

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

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

objectOptional

Threshold Override Create or Update Config

Responses

200

List of Requested Threshold Overrides

application/json

400

Bad Request. Typically due to a malformatted JSON body, or parameter values are not validating.

application/json

401

Access token is missing or invalid

application/json

403

Access is forbidden

application/json

default

Unknown Error Occurred

application/json

put

/api/v1/rule-engine/triggers

HTTPcURLJavaScriptPython

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

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

204

An empty array

400

Bad Request. Typically due to a malformatted JSON body, or parameter values are not validating.

application/json

401

Access token is missing or invalid

application/json

403

Access is forbidden

application/json

default

Unknown Error Occurred

application/json

delete

/api/v1/rule-engine/triggers

HTTPcURLJavaScriptPython

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

BearerAuth

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

400

Bad Request. Typically due to a malformatted JSON body, or parameter values are not validating.

application/json

401

Access token is missing or invalid

application/json

403

Access is forbidden

application/json

default

Unknown Error Occurred

application/json

get

/api/v1/rule-engine/triggers/algorithms/{algorithm}

HTTPcURLJavaScriptPython

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

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

algorithmstringRequired

The algorithm to delete threshold overrides for.

Responses

204

An empty array

400

Bad Request. Typically due to a malformatted JSON body, or parameter values are not validating.

application/json

401

Access token is missing or invalid

application/json

403

Access is forbidden

application/json

default

Unknown Error Occurred

application/json

delete

/api/v1/rule-engine/triggers/algorithms/{algorithm}

HTTPcURLJavaScriptPython

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

BearerAuth

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

400

Bad Request. Typically due to a malformatted JSON body, or parameter values are not validating.

application/json

401

Access token is missing or invalid

application/json

403

Access is forbidden

application/json

default

Unknown Error Occurred

application/json

get

/api/v1/rule-engine/triggers/objects/{object}

HTTPcURLJavaScriptPython

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

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

objectstringRequired

The object to delete threshold overrides for.

Responses

204

An empty array

400

Bad Request. Typically due to a malformatted JSON body, or parameter values are not validating.

application/json

401

Access token is missing or invalid

application/json

403

Access is forbidden

application/json

default

Unknown Error Occurred

application/json

delete

/api/v1/rule-engine/triggers/objects/{object}

HTTPcURLJavaScriptPython

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

BearerAuth

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

400

Bad Request. Typically due to a malformatted JSON body, or parameter values are not validating.

application/json

401

Access token is missing or invalid

application/json

403

Access is forbidden

application/json

default

Unknown Error Occurred

application/json

get

/api/v1/rule-engine/triggers/algorithms/{algorithm}/objects/{object}

HTTPcURLJavaScriptPython

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

BearerAuth

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

400

Bad Request. Typically due to a malformatted JSON body, or parameter values are not validating.

application/json

401

Access token is missing or invalid

application/json

403

Access is forbidden

application/json

default

Unknown Error Occurred

application/json

delete

/api/v1/rule-engine/triggers/algorithms/{algorithm}/objects/{object}

HTTPcURLJavaScriptPython

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