Detect and Respond Detection Categories

List Detection Categories

get

Returns an array of Detection Categories.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200Success

No content

400Error

401Error

403Error

default

get

/api/v1/rule-engine/categories

HTTPcURLJavaScriptPython

GET /api/v1/rule-engine/categories HTTP/1.1
Host: api.netography.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "$ref": "./responses/detection_categories.yaml"
}

Delete All Custom Detection Categories

delete

Deletes all custom detection categories.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

204

An empty array

400Error

401Error

403Error

default

delete

/api/v1/rule-engine/categories

HTTPcURLJavaScriptPython

DELETE /api/v1/rule-engine/categories HTTP/1.1
Host: api.netography.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Fetch Detection Category

get

Fetches a specific detection category from the NAME supplied in the path.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

namestringRequired

The NAME of the detection category to be returned.

Responses

200Success

No content

400Error

401Error

403Error

default

get

/api/v1/rule-engine/category/{name}

HTTPcURLJavaScriptPython

GET /api/v1/rule-engine/category/{name} HTTP/1.1
Host: api.netography.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "$ref": "./responses/detection_category.yaml"
}

Create or Update Detection Category

put

Create or update a detection category given the provided object.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

namestringRequired

The NAME of the detection category to be created or updeted.

Body

application/json

anyOptional

Responses

200Success

No content

400Error

401Error

403Error

default

put

/api/v1/rule-engine/category/{name}

HTTPcURLJavaScriptPython

PUT /api/v1/rule-engine/category/{name} HTTP/1.1
Host: api.netography.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*

{
  "$ref": "./responses/detection_category.yaml"
}

Delete Detection Model

delete

Deletes a detection model

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

namestringRequired

The NAME of the detection category to be deleted.

Responses

204

An empty array

400Error

401Error

403Error

default

delete

/api/v1/rule-engine/category/{name}

HTTPcURLJavaScriptPython

DELETE /api/v1/rule-engine/category/{name} HTTP/1.1
Host: api.netography.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content