API Stability Long-Term

The deleteAction() GraphQL mutation may be used to delete an action in LogScale.

For more information on creating an action, see the Actions documentation page.

Syntax

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

graphql
deleteAction(
     input: DeleteAction!
   ): boolean!

Below is an example of how this mutation field might be used:

Raw
graphql
mutation {
  deleteAction(input:
         {viewName: "humio", 
          id: "LHyIpmjXf6ZaGkt8oaTkVKQwAGsMXLBO" } )
}
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 {
  deleteAction(input:
         {viewName: \"humio\", 
          id: \"LHyIpmjXf6ZaGkt8oaTkVKQwAGsMXLBO\" } )
}"
}
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 {
  deleteAction(input:
         {viewName: \"humio\", 
          id: \"LHyIpmjXf6ZaGkt8oaTkVKQwAGsMXLBO\" } )
}"
}
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 { ^
  deleteAction(input: ^
         {viewName: \"humio\",  ^
          id: \"LHyIpmjXf6ZaGkt8oaTkVKQwAGsMXLBO\" } ) ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  deleteAction(input:
         {viewName: \"humio\", 
          id: \"LHyIpmjXf6ZaGkt8oaTkVKQwAGsMXLBO\" } )
}"
}'
    "$YOUR_LOGSCALE_URL/graphql"
Perl
perl
#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $INGEST_TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $json = '{"query" : "mutation {
  deleteAction(input:
         {viewName: \"humio\", 
          id: \"LHyIpmjXf6ZaGkt8oaTkVKQwAGsMXLBO\" } )
}"
}';
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 {
  deleteAction(input:
         {viewName: \"humio\", 
          id: \"LHyIpmjXf6ZaGkt8oaTkVKQwAGsMXLBO\" } )
}"
}'''

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 {
  deleteAction(input:
         {viewName: \"humio\", 
          id: \"LHyIpmjXf6ZaGkt8oaTkVKQwAGsMXLBO\" } )
}"
}
);


const options = {
  hostname: '$YOUR_LOGSCALE_URL/graphql',
  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": {
    "deleteAction": true
  }
}

Given Datatypes

For the given datatype, DeleteAction, there are a couple of parameters that may be given. They're listed below:

Table: DeleteAction

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Sep 18, 2024
idstringyes Long-TermThe unique identifier of the action.
viewNamestringyes Long-TermThe name of the view of the action.