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

Summary

The deleteDashboardV3() mutation permanently removes a dashboard from a LogScale view. Provide both the dashboard ID and the view name to target the correct dashboard. This is the current supported version; use it in place of the deprecated deleteDashboardV2().

Syntax

graphql
deleteDashboardV3(
      input: DeleteDashboard!
   ): Boolean

The input argument accepts a required DeleteDashboard object containing the dashboard ID and the view name. Providing both values ensures the correct dashboard is deleted when multiple dashboards share the same name across different views. Select Show Dashboards Query in the preceding Related section to retrieve these values. See the Input Parameters section for the full field reference for DeleteDashboard.

This mutation returns Boolean. A value of true indicates the dashboard was deleted successfully. A value of false indicates the dashboard was not found.

Example

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

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


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

Input Parameters

Provide the unique identifier of the dashboard to delete and the name of its associated view. Select Show Dashboards Query in the preceding Related section for an example of how to retrieve these values. The table below describes the DeleteDashboard input type fields.