Summary

This mutation is deprecated. Use deleteDashboardV3() instead, which supports batching operations. LogScale will remove deleteDashboard() at the earliest in version 1.261.

Syntax

graphql
deleteDashboard(
      input: DeleteDashboardInput!
   ): DeleteDashboardMutation!

The mutation takes a required input argument of type DeleteDashboardInput! containing the unique identifier of the dashboard to delete. The mutation returns a non-null DeleteDashboardMutation object containing details about the deleted dashboard.

Hide Query Example

Show Dashboard Identifiers Query

Example

Raw
graphql
mutation {
  deleteDashboard(input:
        { id: "abc123" } )
  { 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: \"abc123\" } )
  { 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: \"abc123\" } )
  { 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: \"abc123\" } ) ^
  { 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: \"abc123\" } )
  { 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: \"abc123\" } )
  { 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: \"abc123\" } )
  { 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: \"abc123\" } )
  { dashboard {id} }
}"
}
);


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

Input Parameters

Provide a DeleteDashboardInput object containing the unique identifier of the dashboard to delete. To find the dashboard identifier, select Show Dashboard Identifiers Query in the Syntax section. Deletion is permanent and cannot be undone.

Table: DeleteDashboardInput Input Datatype

ParameterTypeRequiredDefaultStabilityAvailabilityDescription
idStringyes    

Returned Values

The mutation returns a DeleteDashboardMutation object with a dashboard field containing the deleted dashboard. Query dashboard.id to confirm which dashboard was deleted.

Table: DeleteDashboardMutation Datatype

ParameterTypeRequiredDefaultStabilityAvailabilityDescription
dashboardDashboardyes Long-Term  

The dashboard field references a Dashboard sub-datatype that provides additional fields for the deleted dashboard:

Table: Dashboard Datatype

ParameterTypeRequiredDefaultStabilityAvailabilityDescription
allowedActionsAssetActionyes Short-Term Allowed asset actions
createdInfoAssetCommitMetadata  Long-Term Metadata related to the creation of the dashboard
defaultFilterDashboardFilter  Long-Term  
defaultSharedTimeEnabledBooleanyes Long-Term  
defaultSharedTimeEndStringyes Long-Term  
defaultSharedTimeStartStringyes Long-Term  
descriptionString  Long-Term  
displayNameStringyes Long-Term  
filtersDashboardFilteryes Long-Term  
idStringyes Long-Term  
isStarredBooleanyes Long-Term  
labelsStringyes Long-Term  
modifiedInfoAssetCommitMetadata  Long-Term Metadata related to the latest modification of the dashboard
nameStringyes Long-Term  
packagePackageInstallation  Long-Term  
packageIdVersionedPackageSpecifier  Long-Term  
parametersDashboardParameteryes Long-Term  
readOnlyTokensDashboardLinkyes Long-Term  
resourceStringyes Short-Term The resource identifier for this dashboard.
searchDomainSearchDomainyes Long-Term  
sectionsSectionyes Long-Term  
seriesSeriesConfigyes Long-Term  
seriesColorPaletteString  Short-Term  
templateYamlStringyes  deprecated in 1.225A YAML formatted string that describes the dashboard. It does not contain links or permissions, and is safe to share and use for making copies of a dashboard.
timeJumpSizeInMsInt  Long-Term  
updateFrequencyDashboardUpdateFrequencyTypeyes Long-Term  
widgetsWidgetyes Long-Term  
yamlTemplateYAMLyes Long-Term A YAML formatted string that describes the dashboard. It does not contain links or permissions, and is safe to share and use for making copies of a dashboard.