API Stability Deprecated

The deleteDashboard() GraphQL mutation may be used to delete a dashboard in LogScale. However, since this does not properly support batching operations, it's deprecated and will be removed by version 1.261. Use instead deleteDashboardV3.

For more information on dashboards, see the Dashboards documentation page.

Syntax

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

graphql
deleteDashboard(
     input: DeleteDashboardInput!
   ): DeleteDashboardMutation!

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

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

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 {
  deleteDashboard(input:
        { id: \"r85CDJn6cfMIVeCPfXHEriM1CB93SD5O\" } )
  { dashboard {id} }
}"
}
);


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": {
    "deleteDashboard": {
      "dashboard": {
        "id": "r85CDJn6cfMIVeCPfXHEriM1CB93SD5O"
      }
    }
  }
}

Given Datatypes

For the given datatype, DeleteDashboardInput, there's only one parameter that may be given. It's described below:

Table: DeleteDashboardInput

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 dashboard.

Returned Datatypes

The returned datatype DeleteDashboardMutation also has only one parameter. However, that one parameter has several sub-parameters from which to choose. Click on the link below to the one parameter to see the table of sub-parameters:

Table: DeleteDashboardMutation

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 24, 2024
dashboardDashboardyes Long-TermThe dashboard to delete. See Dashboard.