The response from the cancel data deletion request endpoint.
Expand All
Field
Type
Description
data
object
The created data deletion request information.
attributes [required]
object
Deletion attribute for data deletion response.
created_at [required]
string
Creation time of the deletion request.
created_by [required]
string
User who created the deletion request.
customer_message
string
A message for the customer regarding the deletion request, if any.
displayed_total [required]
int64
Total number of elements to be deleted as displayed to the user.
error_category
string
The category of the error for the deletion request, if any.
from_time [required]
int64
Start of requested time window, milliseconds since Unix epoch.
indexes
[string]
List of indexes for the search. If not provided, the search is performed in all indexes.
is_created [required]
boolean
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.
org_id [required]
int64
Organization ID.
product [required]
string
Product name.
query [required]
string
Query for creating a data deletion request.
starting_at [required]
string
Starting time of the process to delete the requested data.
status [required]
string
Status of the deletion request.
to_time [required]
int64
End of requested time window, milliseconds since Unix epoch.
total_unrestricted [required]
int64
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.
updated_at [required]
string
Update time of the deletion request.
id [required]
string
The ID of the created data deletion request.
type [required]
string
The type of the request created.
meta
object
The metadata of the data deletion response.
count_product
object
The total deletion requests created by product.
<any-key>
int64
count_status
object
The total deletion requests created by status.
<any-key>
int64
next_page
string
The next page when searching deletion requests created in the current organization.
product
string
The product of the deletion request.
request_status
string
The status of the executed request.
{"data":{"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","test-index-2"],"is_created":true,"org_id":321813,"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":{"count_product":{"<any-key>":"integer"},"count_status":{"<any-key>":"integer"},"next_page":"cGFnZTI=","product":"logs","request_status":"canceled"}}
"""
Cancels a data deletion request returns "OK" response
"""fromosimportenvironfromdatadog_api_clientimportApiClient,Configurationfromdatadog_api_client.v2.api.data_deletion_apiimportDataDeletionApi# there is a valid "deletion_request" in the systemDELETION_REQUEST_DATA_ID=environ["DELETION_REQUEST_DATA_ID"]configuration=Configuration()withApiClient(configuration)asapi_client:api_instance=DataDeletionApi(api_client)response=api_instance.cancel_data_deletion_request(id=DELETION_REQUEST_DATA_ID,)print(response)
# Cancels a data deletion request returns "OK" responserequire"datadog_api_client"api_instance=DatadogAPIClient::V2::DataDeletionAPI.new# there is a valid "deletion_request" in the systemDELETION_REQUEST_DATA_ID=ENV["DELETION_REQUEST_DATA_ID"]papi_instance.cancel_data_deletion_request(DELETION_REQUEST_DATA_ID)
// Cancels a data deletion request returns "OK" responsepackagemainimport("context""encoding/json""fmt""os""github.com/DataDog/datadog-api-client-go/v2/api/datadog""github.com/DataDog/datadog-api-client-go/v2/api/datadogV2")funcmain(){// there is a valid "deletion_request" in the systemDeletionRequestDataID:=os.Getenv("DELETION_REQUEST_DATA_ID")ctx:=datadog.NewDefaultContext(context.Background())configuration:=datadog.NewConfiguration()apiClient:=datadog.NewAPIClient(configuration)api:=datadogV2.NewDataDeletionApi(apiClient)resp,r,err:=api.CancelDataDeletionRequest(ctx,DeletionRequestDataID)iferr!=nil{fmt.Fprintf(os.Stderr,"Error when calling `DataDeletionApi.CancelDataDeletionRequest`: %v\n",err)fmt.Fprintf(os.Stderr,"Full HTTP response: %v\n",r)}responseContent,_:=json.MarshalIndent(resp,""," ")fmt.Fprintf(os.Stdout,"Response from `DataDeletionApi.CancelDataDeletionRequest`:\n%s\n",responseContent)}
// Cancels a data deletion request returns "OK" responseimportcom.datadog.api.client.ApiClient;importcom.datadog.api.client.ApiException;importcom.datadog.api.client.v2.api.DataDeletionApi;importcom.datadog.api.client.v2.model.CancelDataDeletionResponseBody;publicclassExample{publicstaticvoidmain(String[]args){ApiClientdefaultClient=ApiClient.getDefaultApiClient();DataDeletionApiapiInstance=newDataDeletionApi(defaultClient);// there is a valid "deletion_request" in the systemStringDELETION_REQUEST_DATA_ID=System.getenv("DELETION_REQUEST_DATA_ID");try{CancelDataDeletionResponseBodyresult=apiInstance.cancelDataDeletionRequest(DELETION_REQUEST_DATA_ID);System.out.println(result);}catch(ApiExceptione){System.err.println("Exception when calling DataDeletionApi#cancelDataDeletionRequest");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace();}}}
// Cancels a data deletion request returns "OK" response
usedatadog_api_client::datadog;usedatadog_api_client::datadogV2::api_data_deletion::DataDeletionAPI;#[tokio::main]asyncfnmain(){// there is a valid "deletion_request" in the system
letdeletion_request_data_id=std::env::var("DELETION_REQUEST_DATA_ID").unwrap();letconfiguration=datadog::Configuration::new();letapi=DataDeletionAPI::with_config(configuration);letresp=api.cancel_data_deletion_request(deletion_request_data_id.clone()).await;ifletOk(value)=resp{println!("{:#?}",value);}else{println!("{:#?}",resp.unwrap_err());}}
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com"DD_API_KEY="<DD_API_KEY>"DD_APP_KEY="<DD_APP_KEY>"cargo run
/**
* Cancels a data deletion request returns "OK" response
*/import{client,v2}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();constapiInstance=newv2.DataDeletionApi(configuration);// there is a valid "deletion_request" in the system
constDELETION_REQUEST_DATA_ID=process.env.DELETION_REQUEST_DATA_IDasstring;constparams: v2.DataDeletionApiCancelDataDeletionRequestRequest={id: DELETION_REQUEST_DATA_ID,};apiInstance.cancelDataDeletionRequest(params).then((data: v2.CancelDataDeletionResponseBody)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));