Summary

The updateDashboard() mutation updates an existing dashboard in LogScale. Use it to modify dashboard properties such as name, labels, widgets, sections, and filters. To create a new dashboard, use createDashboard() instead.

Syntax

graphql
updateDashboard(
      input: UpdateDashboardInput!
   ): UpdateDashboardMutation!

The mutation accepts a single required argument, input, of type UpdateDashboardInput!. The input requires the dashboard id. Specify any combination of optional fields to update. Omitting an optional field leaves the current value unchanged. The mutation returns a non-null UpdateDashboardMutation! object containing the updated Dashboard.

To retrieve a dashboard identifier, use the dashboardsPage() query below.

Hide Query Example

Show Dashboard Identifiers Query

Input parameters

The input argument requires the dashboard id. All other fields are optional and update only the properties you supply.

Table: UpdateDashboardInput Input Datatype

ParameterTypeRequiredDefaultStabilityAvailabilityDescription
defaultFilterIdString     
defaultSharedTimeEnabledBoolean     
defaultSharedTimeEndString     
defaultSharedTimeStartString     
descriptionString     
filtersFilterInputyes    
idStringyes    
labelsStringyes    
linksLinkInputyes    
nameString     
parametersParameterInputyes    
sectionsSectionInputyes    
seriesSeriesConfigInputyes    
seriesColorPaletteString     
timeJumpSizeInMsInt     
updateFrequencyDashboardUpdateFrequencyInput     
widgetsWidgetInputyes    

Example

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

Returned values

The mutation returns an UpdateDashboardMutation! object containing a non-null dashboard field. Query id, name, and description on the returned dashboard to confirm the update was applied. The full Dashboard type is available to inspect any other updated properties.

Table: UpdateDashboardMutation Datatype

ParameterTypeRequiredDefaultStabilityAvailabilityDescription
dashboardDashboardyes Long-Term  

The UpdateDashboardMutation! type references the Dashboard type for full dashboard details.