diff --git a/hugo/content/en/api/v2/security-monitoring/examples.json b/hugo/content/en/api/v2/security-monitoring/examples.json index c0c490224a3..2d9aa8a17f1 100644 --- a/hugo/content/en/api/v2/security-monitoring/examples.json +++ b/hugo/content/en/api/v2/security-monitoring/examples.json @@ -13399,6 +13399,17 @@ "data": [ { "attributes": { + "attributes": { + "workflow": { + "first_seen": "2020-06-23T14:46:01.000Z", + "last_seen": "2020-06-23T14:46:49.000Z", + "rule": { + "id": "0f5-e0c-805", + "name": "Brute Force Attack Grouped By User", + "version": 12 + } + } + }, "custom": { "workflow": { "first_seen": "2020-06-23T14:46:01.000Z", @@ -13425,12 +13436,15 @@ "next": "https://app.datadoghq.com/api/v2/security_monitoring/signals?filter[query]=foo&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==" }, "meta": { + "elapsed": 132, "page": { "after": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==" - } + }, + "request_id": "example-request-id", + "status": "done" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array of security signals matching the request.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The object containing all signal attributes and their\nassociated values.

\n
\n
\n
\n
\n
\n

custom

\n
\n

object

\n

A JSON object of attributes in the security signal.

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

The message in the security signal defined by the rule that generated the signal.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

An array of tags associated with the security signal.

\n
\n \n
\n
\n
\n
\n
\n

timestamp

\n
\n

date-time

\n

The timestamp of the security signal.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique ID of the security signal.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of event. \nAllowed enum values: signal

default: signal

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Links attributes.

\n
\n
\n
\n
\n
\n

next

\n
\n

string

\n

The link for the next set of results. Note: The request can also be made using the\nPOST endpoint.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Meta attributes.

\n
\n
\n
\n
\n
\n

page

\n
\n

object

\n

Paging attributes.

\n
\n
\n
\n
\n
\n

after

\n
\n

string

\n

The cursor used to get the next results, if any. To make the next request, use the same\nparameters with the addition of the page[cursor].

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array of security signals matching the request.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The object containing all signal attributes and their\nassociated values.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

A JSON object of attributes in the security signal, returned when listing or searching signals.

\n
\n \n
\n
\n
\n
\n
\n

custom

\n
\n

object

\n

A JSON object of attributes in the security signal, returned when retrieving a single signal.

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

The message in the security signal defined by the rule that generated the signal.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

An array of tags associated with the security signal.

\n
\n \n
\n
\n
\n
\n
\n

timestamp

\n
\n

date-time

\n

The timestamp of the security signal.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique ID of the security signal.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of event. \nAllowed enum values: signal

default: signal

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Links attributes.

\n
\n
\n
\n
\n
\n

next

\n
\n

string

\n

The link for the next set of results. Note: The request can also be made using the\nPOST endpoint.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Meta attributes.

\n
\n
\n
\n
\n
\n

elapsed

\n
\n

int64

\n

The time elapsed in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

page

\n
\n

object

\n

Paging attributes.

\n
\n
\n
\n
\n
\n

after

\n
\n

string

\n

The cursor used to get the next results, if any. To make the next request, use the same\nparameters with the addition of the page[cursor].

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

request_id

\n
\n

string

\n

The unique identifier of the request.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

The status of the response.

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -13842,6 +13856,17 @@ "data": [ { "attributes": { + "attributes": { + "workflow": { + "first_seen": "2020-06-23T14:46:01.000Z", + "last_seen": "2020-06-23T14:46:49.000Z", + "rule": { + "id": "0f5-e0c-805", + "name": "Brute Force Attack Grouped By User", + "version": 12 + } + } + }, "custom": { "workflow": { "first_seen": "2020-06-23T14:46:01.000Z", @@ -13868,12 +13893,15 @@ "next": "https://app.datadoghq.com/api/v2/security_monitoring/signals?filter[query]=foo&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==" }, "meta": { + "elapsed": 132, "page": { "after": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==" - } + }, + "request_id": "example-request-id", + "status": "done" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array of security signals matching the request.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The object containing all signal attributes and their\nassociated values.

\n
\n
\n
\n
\n
\n

custom

\n
\n

object

\n

A JSON object of attributes in the security signal.

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

The message in the security signal defined by the rule that generated the signal.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

An array of tags associated with the security signal.

\n
\n \n
\n
\n
\n
\n
\n

timestamp

\n
\n

date-time

\n

The timestamp of the security signal.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique ID of the security signal.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of event. \nAllowed enum values: signal

default: signal

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Links attributes.

\n
\n
\n
\n
\n
\n

next

\n
\n

string

\n

The link for the next set of results. Note: The request can also be made using the\nPOST endpoint.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Meta attributes.

\n
\n
\n
\n
\n
\n

page

\n
\n

object

\n

Paging attributes.

\n
\n
\n
\n
\n
\n

after

\n
\n

string

\n

The cursor used to get the next results, if any. To make the next request, use the same\nparameters with the addition of the page[cursor].

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array of security signals matching the request.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The object containing all signal attributes and their\nassociated values.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

A JSON object of attributes in the security signal, returned when listing or searching signals.

\n
\n \n
\n
\n
\n
\n
\n

custom

\n
\n

object

\n

A JSON object of attributes in the security signal, returned when retrieving a single signal.

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

The message in the security signal defined by the rule that generated the signal.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

An array of tags associated with the security signal.

\n
\n \n
\n
\n
\n
\n
\n

timestamp

\n
\n

date-time

\n

The timestamp of the security signal.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique ID of the security signal.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of event. \nAllowed enum values: signal

default: signal

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Links attributes.

\n
\n
\n
\n
\n
\n

next

\n
\n

string

\n

The link for the next set of results. Note: The request can also be made using the\nPOST endpoint.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Meta attributes.

\n
\n
\n
\n
\n
\n

elapsed

\n
\n

int64

\n

The time elapsed in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

page

\n
\n

object

\n

Paging attributes.

\n
\n
\n
\n
\n
\n

after

\n
\n

string

\n

The cursor used to get the next results, if any. To make the next request, use the same\nparameters with the addition of the page[cursor].

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

request_id

\n
\n

string

\n

The unique identifier of the request.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

The status of the response.

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -13923,6 +13951,17 @@ "json": { "data": { "attributes": { + "attributes": { + "workflow": { + "first_seen": "2020-06-23T14:46:01.000Z", + "last_seen": "2020-06-23T14:46:49.000Z", + "rule": { + "id": "0f5-e0c-805", + "name": "Brute Force Attack Grouped By User", + "version": 12 + } + } + }, "custom": { "workflow": { "first_seen": "2020-06-23T14:46:01.000Z", @@ -13945,7 +13984,7 @@ "type": "signal" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Object description of a security signal.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The object containing all signal attributes and their\nassociated values.

\n
\n
\n
\n
\n
\n

custom

\n
\n

object

\n

A JSON object of attributes in the security signal.

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

The message in the security signal defined by the rule that generated the signal.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

An array of tags associated with the security signal.

\n
\n \n
\n
\n
\n
\n
\n

timestamp

\n
\n

date-time

\n

The timestamp of the security signal.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique ID of the security signal.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of event. \nAllowed enum values: signal

default: signal

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Object description of a security signal.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The object containing all signal attributes and their\nassociated values.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

A JSON object of attributes in the security signal, returned when listing or searching signals.

\n
\n \n
\n
\n
\n
\n
\n

custom

\n
\n

object

\n

A JSON object of attributes in the security signal, returned when retrieving a single signal.

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

The message in the security signal defined by the rule that generated the signal.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

An array of tags associated with the security signal.

\n
\n \n
\n
\n
\n
\n
\n

timestamp

\n
\n

date-time

\n

The timestamp of the security signal.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique ID of the security signal.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of event. \nAllowed enum values: signal

default: signal

\n
\n \n
\n
\n
\n
" }, "403": { "json": { @@ -14761,6 +14800,17 @@ "data": [ { "attributes": { + "attributes": { + "workflow": { + "first_seen": "2020-06-23T14:46:01.000Z", + "last_seen": "2020-06-23T14:46:49.000Z", + "rule": { + "id": "0f5-e0c-805", + "name": "Brute Force Attack Grouped By User", + "version": 12 + } + } + }, "custom": { "workflow": { "first_seen": "2020-06-23T14:46:01.000Z", @@ -14787,12 +14837,15 @@ "next": "https://app.datadoghq.com/api/v2/security_monitoring/signals?filter[query]=foo&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==" }, "meta": { + "elapsed": 132, "page": { "after": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==" - } + }, + "request_id": "example-request-id", + "status": "done" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array of security signals matching the request.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The object containing all signal attributes and their\nassociated values.

\n
\n
\n
\n
\n
\n

custom

\n
\n

object

\n

A JSON object of attributes in the security signal.

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

The message in the security signal defined by the rule that generated the signal.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

An array of tags associated with the security signal.

\n
\n \n
\n
\n
\n
\n
\n

timestamp

\n
\n

date-time

\n

The timestamp of the security signal.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique ID of the security signal.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of event. \nAllowed enum values: signal

default: signal

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Links attributes.

\n
\n
\n
\n
\n
\n

next

\n
\n

string

\n

The link for the next set of results. Note: The request can also be made using the\nPOST endpoint.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Meta attributes.

\n
\n
\n
\n
\n
\n

page

\n
\n

object

\n

Paging attributes.

\n
\n
\n
\n
\n
\n

after

\n
\n

string

\n

The cursor used to get the next results, if any. To make the next request, use the same\nparameters with the addition of the page[cursor].

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array of security signals matching the request.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The object containing all signal attributes and their\nassociated values.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

A JSON object of attributes in the security signal, returned when listing or searching signals.

\n
\n \n
\n
\n
\n
\n
\n

custom

\n
\n

object

\n

A JSON object of attributes in the security signal, returned when retrieving a single signal.

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

The message in the security signal defined by the rule that generated the signal.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

An array of tags associated with the security signal.

\n
\n \n
\n
\n
\n
\n
\n

timestamp

\n
\n

date-time

\n

The timestamp of the security signal.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique ID of the security signal.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of event. \nAllowed enum values: signal

default: signal

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Links attributes.

\n
\n
\n
\n
\n
\n

next

\n
\n

string

\n

The link for the next set of results. Note: The request can also be made using the\nPOST endpoint.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Meta attributes.

\n
\n
\n
\n
\n
\n

elapsed

\n
\n

int64

\n

The time elapsed in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

page

\n
\n

object

\n

Paging attributes.

\n
\n
\n
\n
\n
\n

after

\n
\n

string

\n

The cursor used to get the next results, if any. To make the next request, use the same\nparameters with the addition of the page[cursor].

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

request_id

\n
\n

string

\n

The unique identifier of the request.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

The status of the response.

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -14840,6 +14893,17 @@ "data": [ { "attributes": { + "attributes": { + "workflow": { + "first_seen": "2020-06-23T14:46:01.000Z", + "last_seen": "2020-06-23T14:46:49.000Z", + "rule": { + "id": "0f5-e0c-805", + "name": "Brute Force Attack Grouped By User", + "version": 12 + } + } + }, "custom": { "workflow": { "first_seen": "2020-06-23T14:46:01.000Z", @@ -14866,12 +14930,15 @@ "next": "https://app.datadoghq.com/api/v2/security_monitoring/signals?filter[query]=foo&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==" }, "meta": { + "elapsed": 132, "page": { "after": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==" - } + }, + "request_id": "example-request-id", + "status": "done" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array of security signals matching the request.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The object containing all signal attributes and their\nassociated values.

\n
\n
\n
\n
\n
\n

custom

\n
\n

object

\n

A JSON object of attributes in the security signal.

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

The message in the security signal defined by the rule that generated the signal.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

An array of tags associated with the security signal.

\n
\n \n
\n
\n
\n
\n
\n

timestamp

\n
\n

date-time

\n

The timestamp of the security signal.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique ID of the security signal.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of event. \nAllowed enum values: signal

default: signal

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Links attributes.

\n
\n
\n
\n
\n
\n

next

\n
\n

string

\n

The link for the next set of results. Note: The request can also be made using the\nPOST endpoint.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Meta attributes.

\n
\n
\n
\n
\n
\n

page

\n
\n

object

\n

Paging attributes.

\n
\n
\n
\n
\n
\n

after

\n
\n

string

\n

The cursor used to get the next results, if any. To make the next request, use the same\nparameters with the addition of the page[cursor].

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array of security signals matching the request.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The object containing all signal attributes and their\nassociated values.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

A JSON object of attributes in the security signal, returned when listing or searching signals.

\n
\n \n
\n
\n
\n
\n
\n

custom

\n
\n

object

\n

A JSON object of attributes in the security signal, returned when retrieving a single signal.

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

The message in the security signal defined by the rule that generated the signal.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

An array of tags associated with the security signal.

\n
\n \n
\n
\n
\n
\n
\n

timestamp

\n
\n

date-time

\n

The timestamp of the security signal.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique ID of the security signal.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of event. \nAllowed enum values: signal

default: signal

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Links attributes.

\n
\n
\n
\n
\n
\n

next

\n
\n

string

\n

The link for the next set of results. Note: The request can also be made using the\nPOST endpoint.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Meta attributes.

\n
\n
\n
\n
\n
\n

elapsed

\n
\n

int64

\n

The time elapsed in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

page

\n
\n

object

\n

Paging attributes.

\n
\n
\n
\n
\n
\n

after

\n
\n

string

\n

The cursor used to get the next results, if any. To make the next request, use the same\nparameters with the addition of the page[cursor].

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

request_id

\n
\n

string

\n

The unique identifier of the request.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

The status of the response.

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -14929,6 +14996,17 @@ "json": { "data": { "attributes": { + "attributes": { + "workflow": { + "first_seen": "2020-06-23T14:46:01.000Z", + "last_seen": "2020-06-23T14:46:49.000Z", + "rule": { + "id": "0f5-e0c-805", + "name": "Brute Force Attack Grouped By User", + "version": 12 + } + } + }, "custom": { "workflow": { "first_seen": "2020-06-23T14:46:01.000Z", @@ -14951,7 +15029,7 @@ "type": "signal" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Object description of a security signal.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The object containing all signal attributes and their\nassociated values.

\n
\n
\n
\n
\n
\n

custom

\n
\n

object

\n

A JSON object of attributes in the security signal.

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

The message in the security signal defined by the rule that generated the signal.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

An array of tags associated with the security signal.

\n
\n \n
\n
\n
\n
\n
\n

timestamp

\n
\n

date-time

\n

The timestamp of the security signal.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique ID of the security signal.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of event. \nAllowed enum values: signal

default: signal

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Object description of a security signal.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The object containing all signal attributes and their\nassociated values.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

A JSON object of attributes in the security signal, returned when listing or searching signals.

\n
\n \n
\n
\n
\n
\n
\n

custom

\n
\n

object

\n

A JSON object of attributes in the security signal, returned when retrieving a single signal.

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

The message in the security signal defined by the rule that generated the signal.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

An array of tags associated with the security signal.

\n
\n \n
\n
\n
\n
\n
\n

timestamp

\n
\n

date-time

\n

The timestamp of the security signal.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique ID of the security signal.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of event. \nAllowed enum values: signal

default: signal

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -15792,6 +15870,17 @@ "data": [ { "attributes": { + "attributes": { + "workflow": { + "first_seen": "2020-06-23T14:46:01.000Z", + "last_seen": "2020-06-23T14:46:49.000Z", + "rule": { + "id": "0f5-e0c-805", + "name": "Brute Force Attack Grouped By User", + "version": 12 + } + } + }, "custom": { "workflow": { "first_seen": "2020-06-23T14:46:01.000Z", @@ -15818,12 +15907,15 @@ "next": "https://app.datadoghq.com/api/v2/security_monitoring/signals?filter[query]=foo&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==" }, "meta": { + "elapsed": 132, "page": { "after": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==" - } + }, + "request_id": "example-request-id", + "status": "done" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array of security signals matching the request.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The object containing all signal attributes and their\nassociated values.

\n
\n
\n
\n
\n
\n

custom

\n
\n

object

\n

A JSON object of attributes in the security signal.

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

The message in the security signal defined by the rule that generated the signal.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

An array of tags associated with the security signal.

\n
\n \n
\n
\n
\n
\n
\n

timestamp

\n
\n

date-time

\n

The timestamp of the security signal.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique ID of the security signal.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of event. \nAllowed enum values: signal

default: signal

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Links attributes.

\n
\n
\n
\n
\n
\n

next

\n
\n

string

\n

The link for the next set of results. Note: The request can also be made using the\nPOST endpoint.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Meta attributes.

\n
\n
\n
\n
\n
\n

page

\n
\n

object

\n

Paging attributes.

\n
\n
\n
\n
\n
\n

after

\n
\n

string

\n

The cursor used to get the next results, if any. To make the next request, use the same\nparameters with the addition of the page[cursor].

\n
\n \n
\n
\n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array of security signals matching the request.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The object containing all signal attributes and their\nassociated values.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

A JSON object of attributes in the security signal, returned when listing or searching signals.

\n
\n \n
\n
\n
\n
\n
\n

custom

\n
\n

object

\n

A JSON object of attributes in the security signal, returned when retrieving a single signal.

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

string

\n

The message in the security signal defined by the rule that generated the signal.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

An array of tags associated with the security signal.

\n
\n \n
\n
\n
\n
\n
\n

timestamp

\n
\n

date-time

\n

The timestamp of the security signal.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The unique ID of the security signal.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of event. \nAllowed enum values: signal

default: signal

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

links

\n
\n

object

\n

Links attributes.

\n
\n
\n
\n
\n
\n

next

\n
\n

string

\n

The link for the next set of results. Note: The request can also be made using the\nPOST endpoint.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Meta attributes.

\n
\n
\n
\n
\n
\n

elapsed

\n
\n

int64

\n

The time elapsed in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

page

\n
\n

object

\n

Paging attributes.

\n
\n
\n
\n
\n
\n

after

\n
\n

string

\n

The cursor used to get the next results, if any. To make the next request, use the same\nparameters with the addition of the page[cursor].

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

request_id

\n
\n

string

\n

The unique identifier of the request.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

The status of the response.

\n
\n \n
\n
\n
\n
" }, "400": { "json": { diff --git a/hugo/content/en/api/v2/security-monitoring/request.SearchSecurityMonitoringSignals.json b/hugo/content/en/api/v2/security-monitoring/request.SearchSecurityMonitoringSignals.json new file mode 100644 index 00000000000..ca88ecdf5fb --- /dev/null +++ b/hugo/content/en/api/v2/security-monitoring/request.SearchSecurityMonitoringSignals.json @@ -0,0 +1,11 @@ +{ + "filter": { + "from": "2021-11-11T10:56:11+00:00", + "query": "security:attack status:high", + "to": "2021-11-11T11:11:11+00:00" + }, + "page": { + "limit": 25 + }, + "sort": "timestamp" +} \ No newline at end of file diff --git a/hugo/data/api/v2/CodeExamples.json b/hugo/data/api/v2/CodeExamples.json index e960e8f0dce..94664c158fe 100644 --- a/hugo/data/api/v2/CodeExamples.json +++ b/hugo/data/api/v2/CodeExamples.json @@ -2330,6 +2330,11 @@ } ], "SearchSecurityMonitoringSignals": [ + { + "group": "security_monitoring", + "suffix": "", + "description": "Get a list of security signals returns \"OK\" response" + }, { "group": "security_monitoring", "suffix": "_1309350146", diff --git a/hugo/data/api/v2/full_spec.yaml b/hugo/data/api/v2/full_spec.yaml index 7a039bfcc67..f0a116efcb9 100644 --- a/hugo/data/api/v2/full_spec.yaml +++ b/hugo/data/api/v2/full_spec.yaml @@ -104974,9 +104974,21 @@ components: additionalProperties: {} description: "The object containing all signal attributes and their\nassociated values." properties: + attributes: + additionalProperties: {} + description: A JSON object of attributes in the security signal, returned when listing or searching signals. + example: + workflow: + first_seen: "2020-06-23T14:46:01.000Z" + last_seen: "2020-06-23T14:46:49.000Z" + rule: + id: 0f5-e0c-805 + name: "Brute Force Attack Grouped By User" + version: 12 + type: object custom: additionalProperties: {} - description: A JSON object of attributes in the security signal. + description: A JSON object of attributes in the security signal, returned when retrieving a single signal. example: workflow: first_seen: "2020-06-23T14:46:01.000Z" @@ -105809,8 +105821,21 @@ components: SecurityMonitoringSignalsListResponseMeta: description: Meta attributes. properties: + elapsed: + description: The time elapsed in milliseconds. + example: 132 + format: int64 + type: integer page: $ref: '#/components/schemas/SecurityMonitoringSignalsListResponseMetaPage' + request_id: + description: The unique identifier of the request. + example: example-request-id + type: string + status: + description: The status of the response. + example: done + type: string type: object SecurityMonitoringSignalsListResponseMetaPage: description: Paging attributes. @@ -212791,6 +212816,12 @@ paths: value: data: - attributes: + attributes: + workflow: + rule: + id: 0f5-e0c-805 + name: "Brute Force Attack Grouped By User" + version: 12 tags: - "source:cloudtrail" id: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA @@ -212798,8 +212829,11 @@ paths: links: next: "" meta: + elapsed: 132 page: after: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== + request_id: example-request-id + status: done schema: $ref: '#/components/schemas/SecurityMonitoringSignalsListResponse' description: OK