API Stability Long-Term

The cancelRedactEvents() GraphQL mutation is used to cancel a previously submitted redaction. Returns true if the redaction was cancelled; returns false otherwise. Cancellation is best effort. If some events have already been redacted, they aren't restored.

For more information on creating views to redact data, see the Creating a Repository or View documentation page. You may also want to look at General Settings for related information.

Syntax

Below is the syntax for the cancelRedactEvents() mutation field:

graphql
cancelRedactEvents(
      input: CancelRedactEventsInput!
   ): boolean

There is no special returned datatypes for this mutation field. Below is an example of how it might be used:

Raw
graphql
mutation {
  cancelRedactEvents(
    input: {
      repositoryName: "sandbox",
      redactionTaskId: "N8M03lslv8UxWSlCzNmyASN1"
    }
  )
}
Mac OS or Linux (curl)
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  cancelRedactEvents(
    input: {
      repositoryName: \"sandbox\",
      redactionTaskId: \"N8M03lslv8UxWSlCzNmyASN1\"
    }
  )
}"
}
EOF
Mac OS or Linux (curl) One-line
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  cancelRedactEvents(
    input: {
      repositoryName: \"sandbox\",
      redactionTaskId: \"N8M03lslv8UxWSlCzNmyASN1\"
    }
  )
}"
}
EOF
Windows Cmd and curl
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql ^
    -H "Authorization: Bearer $TOKEN" ^
    -H "Content-Type: application/json" ^
    -d @'{"query" : "mutation { ^
  cancelRedactEvents( ^
    input: { ^
      repositoryName: \"sandbox\", ^
      redactionTaskId: \"N8M03lslv8UxWSlCzNmyASN1\" ^
    } ^
  ) ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  cancelRedactEvents(
    input: {
      repositoryName: \"sandbox\",
      redactionTaskId: \"N8M03lslv8UxWSlCzNmyASN1\"
    }
  )
}"
}'
    "$YOUR_LOGSCALE_URL/graphql"
Perl
perl
#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $query = "mutation {
  cancelRedactEvents(
    input: {
      repositoryName: \"sandbox\",
      redactionTaskId: \"N8M03lslv8UxWSlCzNmyASN1\"
    }
  )
}";
$query =~ s/\n/ /g;
my $json = sprintf('{"query" : "%s"}',$query);
my $req = HTTP::Request->new("POST", $uri );

$req->header("Authorization" => "Bearer $TOKEN");
$req->header("Content-Type" => "application/json");

$req->content( $json );

my $lwp = LWP::UserAgent->new;

my $result = $lwp->request( $req );

print $result->{"_content"},"\n";
Python
python
#! /usr/local/bin/python3

import requests

url = '$YOUR_LOGSCALE_URL/graphql'
mydata = r'''{"query" : "mutation {
  cancelRedactEvents(
    input: {
      repositoryName: \"sandbox\",
      redactionTaskId: \"N8M03lslv8UxWSlCzNmyASN1\"
    }
  )
}"
}'''

resp = requests.post(url,
                     data = mydata,
                     headers = {
   "Authorization" : "Bearer $TOKEN",
   "Content-Type" : "application/json"
}
)

print(resp.text)
Node.js
javascript
const https = require('https');

const data = JSON.stringify(
    {"query" : "mutation {
  cancelRedactEvents(
    input: {
      repositoryName: \"sandbox\",
      redactionTaskId: \"N8M03lslv8UxWSlCzNmyASN1\"
    }
  )
}"
}
);


const options = {
  hostname: '$YOUR_LOGSCALE_URL',
  path: 'graphql',
  port: 443,
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Content-Length': data.length,
    Authorization: 'BEARER ' + process.env.TOKEN,
    'User-Agent': 'Node',
  },
};

const req = https.request(options, (res) => {
  let data = '';
  console.log(`statusCode: ${res.statusCode}`);

  res.on('data', (d) => {
    data += d;
  });
  res.on('end', () => {
    console.log(JSON.parse(data).data);
  });
});

req.on('error', (error) => {
  console.error(error);
});

req.write(data);
req.end();
Example Responses
Success (HTTP Response Code 200 OK)
json
{
  "data": {
    "cancelRedactEvents": true
  }
}

Given Datatypes

For CancelRedactEventsInput, there a couple of parameters. Below is a list of them along with a description of each:

Table: CancelRedactEventsInput

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For return datatypes, this indicates that you must specify which fields you want returned in the results.
Table last updated: Sep 17, 2024
redactionTaskIdstringyes Long-TermThe unique identifier of the redaction task.
repositoryNamestringyes Long-TermThe name of the repository associated with the events.