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

Summary

An interaction is a configured link that LogScale displays alongside matching events or query results. Interactions come in three subtypes โ€” custom link, dashboard link, and search link โ€” each created and updated by its own mutation. The deleteInteractionV2() mutation permanently removes an interaction and its configuration from a repository. It returns true on success, false if the specified interaction does not exist, and null with an entry in the GraphQL errors array if the deletion fails for another reason.

Syntax

graphql
deleteInteractionV2(
      input: DeleteInteractionInput!
   ): Boolean

The input argument is required and takes a DeleteInteractionInput object. Provide the repository path and the unique id of the interaction to delete. Use the expandable query in the Related section to retrieve both values. See the Input Parameters section for field details.

The mutation returns a nullable Boolean. See the Returned Values section for how to interpret each possible result.

Example

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

Input Parameters

Provide the repository path and the unique identifier of the interaction to delete. Both fields are required. Use the expandable query in the Related section to retrieve these values.

Returned Values

The mutation returns a nullable Boolean. Each possible value has a distinct meaning:

  • true โ€” The interaction was permanently deleted.

  • false โ€” No interaction with the given id was found in the repository at path.

  • null (with an entry in the GraphQL errors array) โ€” The deletion failed for another reason, such as insufficient permissions or an invalid repository path.