๐ŸŽฏAPI Stability
Long-TermThis API is stable and will remain supported across versions with minimal breaking changes.

Summary

The removeFromBlocklist() mutation removes a block entry from the query blocklist. Removing an entry restores execution of queries that match the blocked pattern. Each block entry has a unique ID. Retrieve the ID with the blockedQueries() query before calling this mutation.

Syntax

graphql
removeFromBlocklist(
      input: RemoveFromBlocklistInput!
   ): Boolean!

The mutation accepts a single required input argument of type RemoveFromBlocklistInput. The input requires the unique ID of the block entry to remove. Retrieve this ID from the blockedQueries() query. The mutation returns a non-null Boolean. A value of true indicates that the entry was removed successfully.

Example

Raw
graphql
mutation {
  removeFromBlocklist(input: 
    {id: "abc123"}
  )
}
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 {
  removeFromBlocklist(input: 
    {id: \"abc123\"}
  )
}"
}
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 {
  removeFromBlocklist(input: 
    {id: \"abc123\"}
  )
}"
}
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 { ^
  removeFromBlocklist(input:  ^
    {id: \"abc123\"} ^
  ) ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  removeFromBlocklist(input: 
    {id: \"abc123\"}
  )
}"
}'
    "$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 {
  removeFromBlocklist(input: 
    {id: \"abc123\"}
  )
}";
$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 {
  removeFromBlocklist(input: 
    {id: \"abc123\"}
  )
}"
}'''

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 {
  removeFromBlocklist(input: 
    {id: \"abc123\"}
  )
}"
}
);


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": {
    "removeFromBlocklist": true
  }
}

Input Parameters

The RemoveFromBlocklistInput type requires a single id field identifying the block entry to remove. Retrieve the ID from the blockedQueries() query. The following table lists all available fields:

Table: RemoveFromBlocklistInput Input Datatype

ParameterTypeRequiredDefaultStabilityAvailabilityDescription
idStringyesย Long-Termย The unique identifier of the blocklist entry to remove.

Returned Values

The mutation returns true when the block entry is removed successfully. Queries that previously matched the blocked pattern resume executing immediately after removal. A value of false indicates that the entry was not removed.