diff --git a/hugo/config/_default/menus/api.en.yaml b/hugo/config/_default/menus/api.en.yaml index b74b2dc3830..6eba45208dc 100644 --- a/hugo/config/_default/menus/api.en.yaml +++ b/hugo/config/_default/menus/api.en.yaml @@ -12507,6 +12507,46 @@ menu: unstable: - v2 order: 5 + - name: Data Deletion + url: /api/latest/data-deletion/ + identifier: data-deletion + generated: true + - name: Cancels a data deletion request + url: /api/latest/data-deletion/cancels-a-data-deletion-request/ + identifier: data-deletion-cancels-a-data-deletion-request + parent: data-deletion + generated: true + params: + versions: + - v2 + operationids: + - CancelDataDeletionRequest + unstable: [] + order: 2 + - name: Gets a list of data deletion requests + url: /api/latest/data-deletion/gets-a-list-of-data-deletion-requests/ + identifier: data-deletion-gets-a-list-of-data-deletion-requests + parent: data-deletion + generated: true + params: + versions: + - v2 + operationids: + - GetDataDeletionRequests + unstable: [] + order: 3 + - name: Creates a data deletion request + url: /api/latest/data-deletion/creates-a-data-deletion-request/ + identifier: data-deletion-creates-a-data-deletion-request + parent: data-deletion + generated: true + params: + versions: + - v2 + operationids: + - CreateDataDeletionRequest + unstable: [] + order: 1 - name: Data Observability url: /api/latest/data-observability/ identifier: data-observability diff --git a/hugo/content/en/api/latest/data-deletion/_index.md b/hugo/content/en/api/latest/data-deletion/_index.md new file mode 100644 index 00000000000..0304ea5a3d9 --- /dev/null +++ b/hugo/content/en/api/latest/data-deletion/_index.md @@ -0,0 +1,3 @@ +--- +title: Data Deletion +--- diff --git a/hugo/content/en/api/latest/data-deletion/cancels-a-data-deletion-request/index.md b/hugo/content/en/api/latest/data-deletion/cancels-a-data-deletion-request/index.md new file mode 100644 index 00000000000..d906edc86a9 --- /dev/null +++ b/hugo/content/en/api/latest/data-deletion/cancels-a-data-deletion-request/index.md @@ -0,0 +1,3 @@ +--- +title: Cancels a data deletion request +--- diff --git a/hugo/content/en/api/latest/data-deletion/creates-a-data-deletion-request/index.md b/hugo/content/en/api/latest/data-deletion/creates-a-data-deletion-request/index.md new file mode 100644 index 00000000000..3d9c22a01b0 --- /dev/null +++ b/hugo/content/en/api/latest/data-deletion/creates-a-data-deletion-request/index.md @@ -0,0 +1,3 @@ +--- +title: Creates a data deletion request +--- diff --git a/hugo/content/en/api/latest/data-deletion/gets-a-list-of-data-deletion-requests/index.md b/hugo/content/en/api/latest/data-deletion/gets-a-list-of-data-deletion-requests/index.md new file mode 100644 index 00000000000..7fe454123e4 --- /dev/null +++ b/hugo/content/en/api/latest/data-deletion/gets-a-list-of-data-deletion-requests/index.md @@ -0,0 +1,3 @@ +--- +title: Gets a list of data deletion requests +--- diff --git a/hugo/content/en/api/v2/data-deletion/_index.md b/hugo/content/en/api/v2/data-deletion/_index.md new file mode 100644 index 00000000000..31206b57e2e --- /dev/null +++ b/hugo/content/en/api/v2/data-deletion/_index.md @@ -0,0 +1,4 @@ +--- +title: Data Deletion +headless: true +--- diff --git a/hugo/content/en/api/v2/data-deletion/examples.json b/hugo/content/en/api/v2/data-deletion/examples.json index 1344b8411a0..7e42a4e39b5 100644 --- a/hugo/content/en/api/v2/data-deletion/examples.json +++ b/hugo/content/en/api/v2/data-deletion/examples.json @@ -7,6 +7,9 @@ "attributes": { "created_at": "2024-01-01T00:00:00.000000Z", "created_by": "test.user@datadoghq.com", + "customer_message": "Your deletion request is being processed.", + "displayed_total": 100, + "error_category": "validation_error", "from_time": 1672527600000, "indexes": [ "test-index", @@ -37,7 +40,7 @@ "request_status": "canceled" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The created data deletion request information.

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

attributes [required]

\n
\n

object

\n

Deletion attribute for data deletion response.

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

created_at [required]

\n
\n

string

\n

Creation time of the deletion request.

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

created_by [required]

\n
\n

string

\n

User who created the deletion request.

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

from_time [required]

\n
\n

int64

\n

Start of requested time window, milliseconds since Unix epoch.

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

indexes

\n
\n

[string]

\n

List of indexes for the search. If not provided, the search is performed in all indexes.

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

is_created [required]

\n
\n

boolean

\n

Whether the deletion request is fully created or not. It can take several minutes to fully create a deletion request depending on the target query and timeframe.

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

org_id [required]

\n
\n

int64

\n

Organization ID.

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

product [required]

\n
\n

string

\n

Product name.

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

query [required]

\n
\n

string

\n

Query for creating a data deletion request.

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

starting_at [required]

\n
\n

string

\n

Starting time of the process to delete the requested data.

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

status [required]

\n
\n

string

\n

Status of the deletion request.

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

to_time [required]

\n
\n

int64

\n

End of requested time window, milliseconds since Unix epoch.

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

total_unrestricted [required]

\n
\n

int64

\n

Total number of elements to be deleted. Only the data accessible to the current user that matches the query and timeframe provided will be deleted.

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

updated_at [required]

\n
\n

string

\n

Update time of the deletion request.

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

id [required]

\n
\n

string

\n

The ID of the created data deletion request.

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

type [required]

\n
\n

string

\n

The type of the request created.

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

meta

\n
\n

object

\n

The metadata of the data deletion response.

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

count_product

\n
\n

object

\n

The total deletion requests created by product.

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

<any-key>

\n
\n

int64

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

count_status

\n
\n

object

\n

The total deletion requests created by status.

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

<any-key>

\n
\n

int64

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

next_page

\n
\n

string

\n

The next page when searching deletion requests created in the current organization.

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

product

\n
\n

string

\n

The product of the deletion request.

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

request_status

\n
\n

string

\n

The status of the executed request.

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

data

\n
\n

object

\n

The created data deletion request information.

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

attributes [required]

\n
\n

object

\n

Deletion attribute for data deletion response.

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

created_at [required]

\n
\n

string

\n

Creation time of the deletion request.

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

created_by [required]

\n
\n

string

\n

User who created the deletion request.

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

customer_message

\n
\n

string

\n

A message for the customer regarding the deletion request, if any.

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

displayed_total [required]

\n
\n

int64

\n

Total number of elements to be deleted as displayed to the user.

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

error_category

\n
\n

string

\n

The category of the error for the deletion request, if any.

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

from_time [required]

\n
\n

int64

\n

Start of requested time window, milliseconds since Unix epoch.

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

indexes

\n
\n

[string]

\n

List of indexes for the search. If not provided, the search is performed in all indexes.

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

is_created [required]

\n
\n

boolean

\n

Whether the deletion request is fully created or not. It can take several minutes to fully create a deletion request depending on the target query and timeframe.

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

org_id [required]

\n
\n

int64

\n

Organization ID.

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

product [required]

\n
\n

string

\n

Product name.

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

query [required]

\n
\n

string

\n

Query for creating a data deletion request.

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

starting_at [required]

\n
\n

string

\n

Starting time of the process to delete the requested data.

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

status [required]

\n
\n

string

\n

Status of the deletion request.

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

to_time [required]

\n
\n

int64

\n

End of requested time window, milliseconds since Unix epoch.

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

total_unrestricted [required]

\n
\n

int64

\n

Total number of elements to be deleted. Only the data accessible to the current user that matches the query and timeframe provided will be deleted.

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

updated_at [required]

\n
\n

string

\n

Update time of the deletion request.

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

id [required]

\n
\n

string

\n

The ID of the created data deletion request.

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

type [required]

\n
\n

string

\n

The type of the request created.

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

meta

\n
\n

object

\n

The metadata of the data deletion response.

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

count_product

\n
\n

object

\n

The total deletion requests created by product.

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

<any-key>

\n
\n

int64

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

count_status

\n
\n

object

\n

The total deletion requests created by status.

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

<any-key>

\n
\n

int64

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

next_page

\n
\n

string

\n

The next page when searching deletion requests created in the current organization.

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

product

\n
\n

string

\n

The product of the deletion request.

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

request_status

\n
\n

string

\n

The status of the executed request.

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -45,7 +48,7 @@ "Bad Request" ] }, - "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" }, "403": { "json": { @@ -53,7 +56,7 @@ "Bad Request" ] }, - "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" }, "412": { "json": { @@ -61,7 +64,7 @@ "Bad Request" ] }, - "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" }, "429": { "json": { @@ -69,7 +72,7 @@ "Bad Request" ] }, - "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" }, "500": { "json": { @@ -77,22 +80,25 @@ "Bad Request" ] }, - "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" } }, "request": { "json_curl": { "data": { "attributes": { + "displayed_total": 100, "from": 1672527600000, "query": {}, "to": 1704063600000 - } + }, + "type": "create_deletion_req" } }, "json": { "data": { "attributes": { + "displayed_total": 100, "from": 1672527600000, "indexes": [ "test-index", @@ -102,10 +108,11 @@ "": "string" }, "to": 1704063600000 - } + }, + "type": "create_deletion_req" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data needed to create a data deletion request.

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

attributes [required]

\n
\n

object

\n

Attributes for creating a data deletion request.

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

from [required]

\n
\n

int64

\n

Start of requested time window, milliseconds since Unix epoch.

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

indexes

\n
\n

[string]

\n

List of indexes for the search. If not provided, the search is performed in all indexes.

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

query [required]

\n
\n

object

\n

Query for creating a data deletion request.

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

<any-key>

\n
\n

string

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

to [required]

\n
\n

int64

\n

End of requested time window, milliseconds since Unix epoch.

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

data [required]

\n
\n

object

\n

Data needed to create a data deletion request.

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

attributes [required]

\n
\n

object

\n

Attributes for creating a data deletion request.

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

displayed_total [required]

\n
\n

int64

\n

Total number of elements to be deleted as displayed to the user.

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

from [required]

\n
\n

int64

\n

Start of requested time window, milliseconds since Unix epoch.

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

indexes

\n
\n

[string]

\n

List of indexes for the search. If not provided, the search is performed in all indexes.

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

query [required]

\n
\n

object

\n

Query for creating a data deletion request.

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

<any-key>

\n
\n

string

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

to [required]

\n
\n

int64

\n

End of requested time window, milliseconds since Unix epoch.

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

type [required]

\n
\n

enum

\n

The deletion request type. \nAllowed enum values: create_deletion_req

\n
\n \n
\n
\n
\n
" } }, "GetDataDeletionRequests": { @@ -117,6 +124,9 @@ "attributes": { "created_at": "2024-01-01T00:00:00.000000Z", "created_by": "test.user@datadoghq.com", + "customer_message": "Your deletion request is being processed.", + "displayed_total": 100, + "error_category": "validation_error", "from_time": 1672527600000, "indexes": [ "test-index", @@ -148,7 +158,7 @@ "request_status": "canceled" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

The list of data deletion requests that matches the query.

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

attributes [required]

\n
\n

object

\n

Deletion attribute for data deletion response.

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

created_at [required]

\n
\n

string

\n

Creation time of the deletion request.

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

created_by [required]

\n
\n

string

\n

User who created the deletion request.

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

from_time [required]

\n
\n

int64

\n

Start of requested time window, milliseconds since Unix epoch.

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

indexes

\n
\n

[string]

\n

List of indexes for the search. If not provided, the search is performed in all indexes.

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

is_created [required]

\n
\n

boolean

\n

Whether the deletion request is fully created or not. It can take several minutes to fully create a deletion request depending on the target query and timeframe.

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

org_id [required]

\n
\n

int64

\n

Organization ID.

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

product [required]

\n
\n

string

\n

Product name.

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

query [required]

\n
\n

string

\n

Query for creating a data deletion request.

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

starting_at [required]

\n
\n

string

\n

Starting time of the process to delete the requested data.

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

status [required]

\n
\n

string

\n

Status of the deletion request.

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

to_time [required]

\n
\n

int64

\n

End of requested time window, milliseconds since Unix epoch.

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

total_unrestricted [required]

\n
\n

int64

\n

Total number of elements to be deleted. Only the data accessible to the current user that matches the query and timeframe provided will be deleted.

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

updated_at [required]

\n
\n

string

\n

Update time of the deletion request.

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

id [required]

\n
\n

string

\n

The ID of the created data deletion request.

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

type [required]

\n
\n

string

\n

The type of the request created.

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

meta

\n
\n

object

\n

The metadata of the data deletion response.

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

count_product

\n
\n

object

\n

The total deletion requests created by product.

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

<any-key>

\n
\n

int64

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

count_status

\n
\n

object

\n

The total deletion requests created by status.

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

<any-key>

\n
\n

int64

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

next_page

\n
\n

string

\n

The next page when searching deletion requests created in the current organization.

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

product

\n
\n

string

\n

The product of the deletion request.

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

request_status

\n
\n

string

\n

The status of the executed request.

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

data

\n
\n

[object]

\n

The list of data deletion requests that matches the query.

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

attributes [required]

\n
\n

object

\n

Deletion attribute for data deletion response.

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

created_at [required]

\n
\n

string

\n

Creation time of the deletion request.

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

created_by [required]

\n
\n

string

\n

User who created the deletion request.

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

customer_message

\n
\n

string

\n

A message for the customer regarding the deletion request, if any.

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

displayed_total [required]

\n
\n

int64

\n

Total number of elements to be deleted as displayed to the user.

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

error_category

\n
\n

string

\n

The category of the error for the deletion request, if any.

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

from_time [required]

\n
\n

int64

\n

Start of requested time window, milliseconds since Unix epoch.

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

indexes

\n
\n

[string]

\n

List of indexes for the search. If not provided, the search is performed in all indexes.

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

is_created [required]

\n
\n

boolean

\n

Whether the deletion request is fully created or not. It can take several minutes to fully create a deletion request depending on the target query and timeframe.

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

org_id [required]

\n
\n

int64

\n

Organization ID.

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

product [required]

\n
\n

string

\n

Product name.

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

query [required]

\n
\n

string

\n

Query for creating a data deletion request.

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

starting_at [required]

\n
\n

string

\n

Starting time of the process to delete the requested data.

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

status [required]

\n
\n

string

\n

Status of the deletion request.

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

to_time [required]

\n
\n

int64

\n

End of requested time window, milliseconds since Unix epoch.

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

total_unrestricted [required]

\n
\n

int64

\n

Total number of elements to be deleted. Only the data accessible to the current user that matches the query and timeframe provided will be deleted.

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

updated_at [required]

\n
\n

string

\n

Update time of the deletion request.

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

id [required]

\n
\n

string

\n

The ID of the created data deletion request.

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

type [required]

\n
\n

string

\n

The type of the request created.

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

meta

\n
\n

object

\n

The metadata of the data deletion response.

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

count_product

\n
\n

object

\n

The total deletion requests created by product.

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

<any-key>

\n
\n

int64

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

count_status

\n
\n

object

\n

The total deletion requests created by status.

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

<any-key>

\n
\n

int64

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

next_page

\n
\n

string

\n

The next page when searching deletion requests created in the current organization.

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

product

\n
\n

string

\n

The product of the deletion request.

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

request_status

\n
\n

string

\n

The status of the executed request.

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -156,7 +166,7 @@ "Bad Request" ] }, - "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" }, "403": { "json": { @@ -164,7 +174,7 @@ "Bad Request" ] }, - "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" }, "429": { "json": { @@ -172,7 +182,7 @@ "Bad Request" ] }, - "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" }, "500": { "json": { @@ -180,7 +190,7 @@ "Bad Request" ] }, - "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" } }, "request": { @@ -197,6 +207,9 @@ "attributes": { "created_at": "2024-01-01T00:00:00.000000Z", "created_by": "test.user@datadoghq.com", + "customer_message": "Your deletion request is being processed.", + "displayed_total": 100, + "error_category": "validation_error", "from_time": 1672527600000, "indexes": [ "test-index", @@ -227,7 +240,7 @@ "request_status": "canceled" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The created data deletion request information.

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

attributes [required]

\n
\n

object

\n

Deletion attribute for data deletion response.

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

created_at [required]

\n
\n

string

\n

Creation time of the deletion request.

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

created_by [required]

\n
\n

string

\n

User who created the deletion request.

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

from_time [required]

\n
\n

int64

\n

Start of requested time window, milliseconds since Unix epoch.

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

indexes

\n
\n

[string]

\n

List of indexes for the search. If not provided, the search is performed in all indexes.

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

is_created [required]

\n
\n

boolean

\n

Whether the deletion request is fully created or not. It can take several minutes to fully create a deletion request depending on the target query and timeframe.

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

org_id [required]

\n
\n

int64

\n

Organization ID.

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

product [required]

\n
\n

string

\n

Product name.

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

query [required]

\n
\n

string

\n

Query for creating a data deletion request.

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

starting_at [required]

\n
\n

string

\n

Starting time of the process to delete the requested data.

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

status [required]

\n
\n

string

\n

Status of the deletion request.

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

to_time [required]

\n
\n

int64

\n

End of requested time window, milliseconds since Unix epoch.

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

total_unrestricted [required]

\n
\n

int64

\n

Total number of elements to be deleted. Only the data accessible to the current user that matches the query and timeframe provided will be deleted.

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

updated_at [required]

\n
\n

string

\n

Update time of the deletion request.

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

id [required]

\n
\n

string

\n

The ID of the created data deletion request.

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

type [required]

\n
\n

string

\n

The type of the request created.

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

meta

\n
\n

object

\n

The metadata of the data deletion response.

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

count_product

\n
\n

object

\n

The total deletion requests created by product.

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

<any-key>

\n
\n

int64

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

count_status

\n
\n

object

\n

The total deletion requests created by status.

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

<any-key>

\n
\n

int64

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

next_page

\n
\n

string

\n

The next page when searching deletion requests created in the current organization.

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

product

\n
\n

string

\n

The product of the deletion request.

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

request_status

\n
\n

string

\n

The status of the executed request.

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

data

\n
\n

object

\n

The created data deletion request information.

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

attributes [required]

\n
\n

object

\n

Deletion attribute for data deletion response.

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

created_at [required]

\n
\n

string

\n

Creation time of the deletion request.

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

created_by [required]

\n
\n

string

\n

User who created the deletion request.

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

customer_message

\n
\n

string

\n

A message for the customer regarding the deletion request, if any.

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

displayed_total [required]

\n
\n

int64

\n

Total number of elements to be deleted as displayed to the user.

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

error_category

\n
\n

string

\n

The category of the error for the deletion request, if any.

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

from_time [required]

\n
\n

int64

\n

Start of requested time window, milliseconds since Unix epoch.

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

indexes

\n
\n

[string]

\n

List of indexes for the search. If not provided, the search is performed in all indexes.

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

is_created [required]

\n
\n

boolean

\n

Whether the deletion request is fully created or not. It can take several minutes to fully create a deletion request depending on the target query and timeframe.

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

org_id [required]

\n
\n

int64

\n

Organization ID.

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

product [required]

\n
\n

string

\n

Product name.

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

query [required]

\n
\n

string

\n

Query for creating a data deletion request.

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

starting_at [required]

\n
\n

string

\n

Starting time of the process to delete the requested data.

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

status [required]

\n
\n

string

\n

Status of the deletion request.

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

to_time [required]

\n
\n

int64

\n

End of requested time window, milliseconds since Unix epoch.

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

total_unrestricted [required]

\n
\n

int64

\n

Total number of elements to be deleted. Only the data accessible to the current user that matches the query and timeframe provided will be deleted.

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

updated_at [required]

\n
\n

string

\n

Update time of the deletion request.

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

id [required]

\n
\n

string

\n

The ID of the created data deletion request.

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

type [required]

\n
\n

string

\n

The type of the request created.

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

meta

\n
\n

object

\n

The metadata of the data deletion response.

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

count_product

\n
\n

object

\n

The total deletion requests created by product.

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

<any-key>

\n
\n

int64

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

count_status

\n
\n

object

\n

The total deletion requests created by status.

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

<any-key>

\n
\n

int64

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

next_page

\n
\n

string

\n

The next page when searching deletion requests created in the current organization.

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

product

\n
\n

string

\n

The product of the deletion request.

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

request_status

\n
\n

string

\n

The status of the executed request.

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -235,7 +248,7 @@ "Bad Request" ] }, - "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" }, "403": { "json": { @@ -243,7 +256,7 @@ "Bad Request" ] }, - "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" }, "412": { "json": { @@ -251,7 +264,7 @@ "Bad Request" ] }, - "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" }, "429": { "json": { @@ -259,7 +272,7 @@ "Bad Request" ] }, - "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" }, "500": { "json": { @@ -267,7 +280,7 @@ "Bad Request" ] }, - "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

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

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" } }, "request": { diff --git a/hugo/content/en/api/v2/data-deletion/request.CreateDataDeletionRequest.json b/hugo/content/en/api/v2/data-deletion/request.CreateDataDeletionRequest.json index 7d3c0c8e7e5..250fe3c632c 100644 --- a/hugo/content/en/api/v2/data-deletion/request.CreateDataDeletionRequest.json +++ b/hugo/content/en/api/v2/data-deletion/request.CreateDataDeletionRequest.json @@ -1,6 +1,7 @@ { "data": { "attributes": { + "displayed_total": 100, "from": 1672527600000, "indexes": [ "test-index", diff --git a/hugo/data/api/v2/full_spec.yaml b/hugo/data/api/v2/full_spec.yaml index 2b6dc020f3a..64155175397 100644 --- a/hugo/data/api/v2/full_spec.yaml +++ b/hugo/data/api/v2/full_spec.yaml @@ -1537,6 +1537,13 @@ components: default: created_at example: "-created_at" type: string + ProductName: + description: Name of the product to be deleted. Only `logs` is supported. + in: path + name: product + required: true + schema: + type: string ProjectIDPathParameter: description: Project UUID. example: "e555e290-ed65-49bd-ae18-8acbfcf18db7" @@ -1612,6 +1619,13 @@ components: required: true schema: type: string + RequestId: + description: ID of the deletion request. + in: path + name: id + required: true + schema: + type: string ResourceFilterAccountID: description: Filter resource filters by cloud provider account ID. This parameter is only valid when provider is specified. in: query @@ -15825,6 +15839,14 @@ components: type: string x-enum-varnames: - CAMPAIGN + CancelDataDeletionResponseBody: + description: The response from the cancel data deletion request endpoint. + properties: + data: + $ref: "#/components/schemas/DataDeletionResponseItem" + meta: + $ref: "#/components/schemas/DataDeletionResponseMeta" + type: object Case: description: A case properties: @@ -24318,6 +24340,79 @@ components: required: - data type: object + CreateDataDeletionRequestBody: + description: Object needed to create a data deletion request. + properties: + data: + $ref: "#/components/schemas/CreateDataDeletionRequestBodyData" + required: + - data + type: object + CreateDataDeletionRequestBodyAttributes: + description: Attributes for creating a data deletion request. + properties: + displayed_total: + description: Total number of elements to be deleted as displayed to the user. + example: 100 + format: int64 + minimum: 1 + type: integer + from: + description: Start of requested time window, milliseconds since Unix epoch. + example: 1672527600000 + format: int64 + type: integer + indexes: + description: List of indexes for the search. If not provided, the search is performed in all indexes. + example: ["test-index", "test-index-2"] + items: + description: Individual index. + type: string + type: array + query: + additionalProperties: + type: string + description: Query for creating a data deletion request. + example: {"host": "abc", "service": "xyz"} + type: object + to: + description: End of requested time window, milliseconds since Unix epoch. + example: 1704063600000 + format: int64 + type: integer + required: + - query + - from + - to + - displayed_total + type: object + CreateDataDeletionRequestBodyData: + description: Data needed to create a data deletion request. + properties: + attributes: + $ref: "#/components/schemas/CreateDataDeletionRequestBodyAttributes" + type: + $ref: "#/components/schemas/CreateDataDeletionRequestBodyDataType" + required: + - attributes + - type + type: object + CreateDataDeletionRequestBodyDataType: + description: The deletion request type. + enum: + - create_deletion_req + example: "create_deletion_req" + type: string + x-enum-varnames: + - CREATE_DELETION_REQ + CreateDataDeletionResponseBody: + description: The response from the create data deletion request endpoint. + properties: + data: + $ref: "#/components/schemas/DataDeletionResponseItem" + meta: + $ref: "#/components/schemas/DataDeletionResponseMeta" + type: object CreateDegradationRequest: description: Request object for creating a degradation. example: @@ -30851,6 +30946,144 @@ components: - destination_key - source_keys type: object + DataDeletionResponseItem: + description: The created data deletion request information. + properties: + attributes: + $ref: "#/components/schemas/DataDeletionResponseItemAttributes" + id: + description: The ID of the created data deletion request. + example: "1" + type: string + type: + description: The type of the request created. + example: "deletion_request" + type: string + required: + - id + - type + - attributes + type: object + DataDeletionResponseItemAttributes: + description: Deletion attribute for data deletion response. + properties: + created_at: + description: Creation time of the deletion request. + example: "2024-01-01T00:00:00.000000Z" + type: string + created_by: + description: User who created the deletion request. + example: "test.user@datadoghq.com" + type: string + customer_message: + description: A message for the customer regarding the deletion request, if any. + example: "Your deletion request is being processed." + type: string + displayed_total: + description: Total number of elements to be deleted as displayed to the user. + example: 100 + format: int64 + type: integer + error_category: + description: The category of the error for the deletion request, if any. + example: "validation_error" + type: string + from_time: + description: Start of requested time window, milliseconds since Unix epoch. + example: 1672527600000 + format: int64 + type: integer + indexes: + description: List of indexes for the search. If not provided, the search is performed in all indexes. + example: ["test-index", "test-index-2"] + items: + description: Individual index. + type: string + type: array + is_created: + description: Whether the deletion request is fully created or not. It can take several minutes to fully create a deletion request depending on the target query and timeframe. + example: true + type: boolean + org_id: + description: Organization ID. + example: 321813 + format: int64 + type: integer + product: + description: Product name. + example: "logs" + type: string + query: + description: Query for creating a data deletion request. + example: "service:xyz host:abc" + type: string + starting_at: + description: Starting time of the process to delete the requested data. + example: "2024-01-01T02:00:00.000000Z" + type: string + status: + description: Status of the deletion request. + example: "pending" + type: string + to_time: + description: End of requested time window, milliseconds since Unix epoch. + example: 1704063600000 + format: int64 + type: integer + total_unrestricted: + description: Total number of elements to be deleted. Only the data accessible to the current user that matches the query and timeframe provided will be deleted. + example: 100 + format: int64 + type: integer + updated_at: + description: Update time of the deletion request. + example: "2024-01-01T00:00:00.000000Z" + type: string + required: + - created_at + - created_by + - from_time + - is_created + - org_id + - product + - query + - starting_at + - status + - to_time + - total_unrestricted + - displayed_total + - updated_at + type: object + DataDeletionResponseMeta: + description: The metadata of the data deletion response. + properties: + count_product: + additionalProperties: + format: int64 + type: integer + description: The total deletion requests created by product. + example: {"logs": 8} + type: object + count_status: + additionalProperties: + format: int64 + type: integer + description: The total deletion requests created by status. + example: {"completed": 10, "pending": 5} + type: object + next_page: + description: The next page when searching deletion requests created in the current organization. + example: "cGFnZTI=" + type: string + product: + description: The product of the deletion request. + example: "logs" + type: string + request_status: + description: The status of the executed request. + example: "canceled" + type: string + type: object DataExportConfig: description: AWS Cost and Usage Report data export configuration. properties: @@ -43849,6 +44082,17 @@ components: required: - data type: object + GetDataDeletionsResponseBody: + description: The response from the get data deletion requests endpoint. + properties: + data: + description: The list of data deletion requests that matches the query. + items: + $ref: "#/components/schemas/DataDeletionResponseItem" + type: array + meta: + $ref: "#/components/schemas/DataDeletionResponseMeta" + type: object GetDataObservabilityMonitorRunStatusResponse: description: The response for getting the status of a data observability monitor run. properties: @@ -144477,6 +144721,255 @@ paths: tags: - DDSQL x-menu-order: 2 + /api/v2/deletion/data/{product}: + post: + description: Creates a data deletion request by providing a query and a timeframe targeting the proper data. + operationId: CreateDataDeletionRequest + parameters: + - $ref: "#/components/parameters/ProductName" + requestBody: + content: + application/json: + examples: + default: + value: + data: + attributes: + displayed_total: 100 + from: 1672527600000 + indexes: + - test-index + - test-index-2 + query: + host: abc + service: xyz + to: 1704063600000 + type: create_deletion_req + schema: + $ref: "#/components/schemas/CreateDataDeletionRequestBody" + required: true + responses: + "200": + content: + application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00.000000Z" + created_by: test@example.com + displayed_total: 100 + from_time: 1672527600000 + is_created: true + org_id: 123 + product: logs + query: "service:xyz host:abc" + starting_at: "2024-01-01T02:00:00.000000Z" + status: pending + to_time: 1704063600000 + total_unrestricted: 100 + updated_at: "2024-01-01T00:00:00.000000Z" + id: "1" + type: deletion_request + meta: + product: logs + request_status: pending + schema: + $ref: "#/components/schemas/CreateDataDeletionResponseBody" + description: OK + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "412": + content: + application/json: + schema: + $ref: "#/components/schemas/APIErrorResponse" + description: Precondition failed error + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + "500": + content: + application/json: + schema: + $ref: "#/components/schemas/APIErrorResponse" + description: Internal server error + security: + - apiKeyAuth: [] + appKeyAuth: [] + summary: Creates a data deletion request + tags: + - Data Deletion + x-menu-order: 1 + x-permission: + operator: OR + permissions: + - logs_delete_data + /api/v2/deletion/requests: + get: + description: Gets a list of data deletion requests based on several filter parameters. + operationId: GetDataDeletionRequests + parameters: + - description: |- + The next page of the previous search. If the next_page parameter is included, the rest of the query elements are ignored. + example: "cGFnZTI=" + in: query + name: next_page + required: false + schema: + type: string + - description: Retrieve only the requests related to the given product. + example: "logs" + in: query + name: product + required: false + schema: + type: string + - description: Retrieve only the requests that matches the given query. + example: "service:xyz host:abc" + in: query + name: query + required: false + schema: + type: string + - description: Retrieve only the requests with the given status. + example: "pending" + in: query + name: status + required: false + schema: + type: string + - description: Sets the page size of the search. + example: "50" + in: query + name: page_size + required: false + schema: + default: 50 + format: int64 + maximum: 50 + minimum: 1 + type: integer + responses: + "200": + content: + application/json: + examples: + default: + value: + data: + - attributes: + created_at: "2024-01-01T00:00:00.000000Z" + created_by: test@example.com + displayed_total: 100 + from_time: 1672527600000 + is_created: true + org_id: 123 + product: logs + query: "service:xyz host:abc" + starting_at: "2024-01-01T02:00:00.000000Z" + status: pending + to_time: 1704063600000 + total_unrestricted: 100 + updated_at: "2024-01-01T00:00:00.000000Z" + id: "1" + type: deletion_request + meta: + next_page: "cGFnZTI=" + product: logs + schema: + $ref: "#/components/schemas/GetDataDeletionsResponseBody" + description: OK + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + "500": + content: + application/json: + schema: + $ref: "#/components/schemas/APIErrorResponse" + description: Internal server error + security: + - apiKeyAuth: [] + appKeyAuth: [] + summary: Gets a list of data deletion requests + tags: + - Data Deletion + x-menu-order: 3 + x-permission: + operator: OR + permissions: + - logs_delete_data + /api/v2/deletion/requests/{id}/cancel: + put: + description: Cancels a data deletion request by providing its ID. + operationId: CancelDataDeletionRequest + parameters: + - $ref: "#/components/parameters/RequestId" + responses: + "200": + content: + application/json: + examples: + default: + value: + data: + attributes: + created_at: "2024-01-01T00:00:00.000000Z" + created_by: test@example.com + displayed_total: 100 + from_time: 1672527600000 + is_created: true + org_id: 123 + product: logs + query: "service:xyz host:abc" + starting_at: "2024-01-01T02:00:00.000000Z" + status: canceled + to_time: 1704063600000 + total_unrestricted: 100 + updated_at: "2024-01-01T00:00:00.000000Z" + id: "1" + type: deletion_request + meta: + product: logs + request_status: canceled + schema: + $ref: "#/components/schemas/CancelDataDeletionResponseBody" + description: OK + "400": + $ref: "#/components/responses/BadRequestResponse" + "403": + $ref: "#/components/responses/ForbiddenResponse" + "412": + content: + application/json: + schema: + $ref: "#/components/schemas/APIErrorResponse" + description: Precondition failed error + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + "500": + content: + application/json: + schema: + $ref: "#/components/schemas/APIErrorResponse" + description: Internal server error + security: + - apiKeyAuth: [] + appKeyAuth: [] + summary: Cancels a data deletion request + tags: + - Data Deletion + x-menu-order: 2 + x-permission: + operator: OR + permissions: + - logs_delete_data /api/v2/deployment_gates: get: description: |- @@ -221613,6 +222106,9 @@ tags: [Dashboards documentation](https://docs.datadoghq.com/dashboards/) for more information. name: Dashboards + - description: |- + The Data Deletion API allows the user to target and delete data from the allowed products. It's enabled for Logs and depends on the `logs_delete_data` permission. + name: Data Deletion - description: Manage and run data observability monitors. name: Data Observability - description: |- diff --git a/hugo/data/api/v2/translate_actions.json b/hugo/data/api/v2/translate_actions.json index f9190097f1b..cfc2e6aa6be 100644 --- a/hugo/data/api/v2/translate_actions.json +++ b/hugo/data/api/v2/translate_actions.json @@ -1640,6 +1640,20 @@ "request_description": "", "request_schema_description": "Wrapper for a DDSQL tabular query fetch request." }, + "CreateDataDeletionRequest": { + "description": "Creates a data deletion request by providing a query and a timeframe targeting the proper data.", + "summary": "Creates a data deletion request", + "request_description": "", + "request_schema_description": "Object needed to create a data deletion request." + }, + "GetDataDeletionRequests": { + "description": "Gets a list of data deletion requests based on several filter parameters.", + "summary": "Gets a list of data deletion requests" + }, + "CancelDataDeletionRequest": { + "description": "Cancels a data deletion request by providing its ID.", + "summary": "Cancels a data deletion request" + }, "ListDeploymentGates": { "description": "Returns a paginated list of all deployment gates for the organization.\nUse `page[cursor]` and `page[size]` query parameters to paginate through results.", "summary": "Get all deployment gates" diff --git a/hugo/data/api/v2/translate_tags.json b/hugo/data/api/v2/translate_tags.json index cf5bc03c63a..9438b0cd022 100644 --- a/hugo/data/api/v2/translate_tags.json +++ b/hugo/data/api/v2/translate_tags.json @@ -175,6 +175,10 @@ "name": "Dashboards", "description": "Get usage statistics for the dashboards in your organization, including view\ncounts, last-edit times, widget counts, and quality scores. See the\n[Dashboards documentation](https://docs.datadoghq.com/dashboards/) for more\ninformation." }, + "data-deletion": { + "name": "Data Deletion", + "description": "The Data Deletion API allows the user to target and delete data from the allowed products. It's enabled for Logs and depends on the `logs_delete_data` permission." + }, "data-observability": { "name": "Data Observability", "description": "Manage and run data observability monitors."