Update Context Creation Model

put https://api.netography.com/api/v1/rule-engine/ccm/{id}

Update a context creation model given the provided object. This does not do a diff. You must send the complete object.

time	status	user agent
Retrieving recent requests…

Loading…

Path Params

string

required

The ID of the context creation model to be updated

Body Params

Context creation model to be updated

action

array of objects

Action for the context model

action

bypassdisplay

boolean

If true, portal and API will not display new events

bypassrule

boolean

If true, alerts will not be processed by policies and integrations

categories

array of strings

Categories for the context model

categories

description

string

required

Context model description

discards

array of strings

Discard lists are NQL statements that if matched do not get processed through the event. It enables skipping certain combinations without disabling the context model

discards

enabled

boolean

If true, the context model is enabled

expiration

integer

required

Number of seconds the context creation model will remain active

factors

array of strings

Factors for the context model

factors

name

string

required

Name of the context model

rollupperiod

integer

required

The lookback period for the context model. Min 15 seconds. Max 1 hour (3600)

search_by

array of objects

required

Search criteria for the context model

search_by*

thresholds

array of objects

required

Thresholds for the context model

thresholds*

track_by

array of arrays of strings

required

Tracking criteria for the context model

track_by*

updateinterval

integer

When ongoing updates should be sent. Max 6 hours (21600). 0 for disabled

algo_record_type

string

required

The context of record to be used for the context model

Responses

Response body

object

categories

array of strings

Categories for the context model

categories

description

string

Context model description

discards

array of strings

Discard lists are NQL statements that if matched do not get processed through the event. It enables skipping certain combinations without disabling the context model

discards

enabled

boolean

If true, the context model is enabled

expiration

integer

Number of seconds the context creation model will remain active

factors

array of strings

Factors for the context model

factors

name

string

Name of the context model

rollupperiod

integer

The lookback period for the context model. Min 15 seconds. Max 1 hour (3600)

search_by

array of objects

Search criteria for the context model

search_by

object

array of strings

type

string

thresholds

array of objects

Thresholds for the context model

thresholds

object

severity

string

threshold

string

track_by

array of arrays of strings

Tracking criteria for the context model

track_by

array of strings

updateinterval

integer

When ongoing updates should be sent. Max 6 hours (21600). 0 for disabled

algo_record_type

string

The context of record to be used for the context model

flow dns

Language

Credentials

Bearer

JWT


xxxxxxxxxx
1
curl --request PUT \
2
     --url https://api.netography.com/api/v1/rule-engine/ccm/id \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "algo_record_type": "flow"
8
}
9
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Requested Context Creation Model

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

401Access token is missing or invalid

403Access is forbidden

defaultUnknown Error Occurred