Summary

The createDashboard() mutation creates a new dashboard in a LogScale search domain. Use this mutation to programmatically provision dashboards with widgets, filters, and labels. To create a dashboard from an existing package template, use createDashboardFromPackageTemplate() instead.

API Stability Long-Term

Syntax

graphql
createDashboard(
      input: CreateDashboardInput!
   ): CreateDashboardMutation!

The mutation accepts a single required input argument of type CreateDashboardInput!. The input requires the search domain name and dashboard name. Widgets, filters, and labels are optional. The mutation returns a non-null CreateDashboardMutation! object.

For a new dashboard, request the dashboard.id field to obtain the unique identifier needed by subsequent mutations and queries.

Example

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

Input Parameters

Provide the name of the target search domain and a name for the new dashboard. You can optionally include widgets, filters, and labels at creation time. The following table describes all available fields in the CreateDashboardInput type:

Table: CreateDashboardInput Input Datatype

ParameterTypeRequiredDefaultStabilityAvailabilityDescription
Some input parameters may be required, as indicated in the Required column. For return values, this indicates that you are assured a value if the field is requested for the results. 
Table last updated: Oct 14, 2026 
defaultFilterIdString  Long-Term The unique identifier for the default filter.
descriptionString  Long-Term A description of the dashboard.
filtersFilterInputyes Long-Term A list of filters to use with the dashboard. See FilterInput.
labelsStringyes Long-Term A list of labels to use with the dashboard.
linksLinkInputyes Long-Term A list of links for the dashboard. See LinkInput.
nameStringyes Long-Term The name of the dashboard to create.
parametersParameterInputyes Long-Term A list of parameters to use with the dashboard. See ParameterInput.
searchDomainNameStringyes Long-Term The name of the search domain associated with the dashboard to create.
sectionsSectionInputyes Long-Term A list of sections to use with the dashboard. See SectionInput.
seriesSeriesConfigInputyes    
seriesColorPaletteString     
updateFrequencyDashboardUpdateFrequencyInput  Long-Term The frequency with which to update the dashboard. See DashboardUpdateFrequencyInput.
widgetsWidgetInputyes Long-Term The widgets to include in the dashboard. See WidgetInput.

Returned Values

The mutation returns a CreateDashboardMutation! object that contains the newly created Dashboard type. Request dashboard.id to obtain the unique identifier assigned to the new dashboard. Use this identifier in subsequent mutations and queries that target a specific dashboard.

Table: CreateDashboardMutation Datatype

ParameterTypeRequiredDefaultStabilityAvailabilityDescription
Some input parameters may be required, as indicated in the Required column. For return values, this indicates that you are assured a value if the field is requested for the results. 
Table last updated: Oct 14, 2026 
dashboardDashboardyes Long-Term The dashboard to create. See Dashboard.

The following table describes the fields of the Dashboard sub-type returned by the preceding type.

Table: Dashboard Datatype

ParameterTypeRequiredDefaultStabilityAvailabilityDescription
Some input parameters may be required, as indicated in the Required column. For return values, this indicates that you are assured a value if the field is requested for the results. 
Table last updated: Oct 14, 2026 
allowedActionsAssetActionyes Short-Term The allowed asset actions. See AssetAction Table). This is feature is a preview and may be changed.
createdInfoAssetCommitMetadata  Long-Term Metadata related to the creation of the dashboard. See AssetCommitMetadata.
defaultFilterDashboardFilter  Long-Term The default filter used with the dashboard (see DashboardFilter Table).
defaultSharedTimeEnabledBooleanyes Long-Term Whether the shared time by default is enabled.
defaultSharedTimeEndStringyes Long-Term The default shared ending time.
defaultSharedTimeStartStringyes Long-Term The default shared starting time.
descriptionString  Long-Term A description of the dashboard.
displayNameStringyes Long-Term The display name of the dashboard.
filtersDashboardFilteryes Long-Term The filters used with the dashboard. See DashboardFilter.
idStringyes Long-Term The unique identifier for the dashboard.
isStarredBooleanyes Long-Term Whether the dashboard is marked with a star.
labelsStringyes Long-Term Any labels associated with the dashboard.
modifiedInfoAssetCommitMetadata  Long-Term Metadata related to the latest modification of the dashboard. See AssetCommitMetadata.
nameStringyes Long-Term The name of the dashboard.
packagePackageInstallation  Long-Term The package, if there is one, in which the dashboard is included (see PackageInstallation Table).
packageIdVersionedPackageSpecifier  Long-Term The unique identifiers of the package. VersionedPackageSpecifier is a scalar.
parametersDashboardParameteryes Long-Term List of dashboard parameters (see DashboardParameter Table).
readOnlyTokensDashboardLinkyes Long-Term List of tokens used to access the dashboard without logging in. Useful for wall mounted dashboards or public dashboards. See DashboardLink.
resourceStringyes Short-Term The resource identifier for this dashboard.
searchDomainSearchDomainyes Long-Term The search domain for the dashboard. See SearchDomain.
sectionsSectionyes Long-Term The sections for the dashboard. See Section.
seriesSeriesConfigyes Long-Term The series configuration for the dashboard. See SeriesConfig.
seriesColorPaletteString  Short-Term Stability: 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 The skip time in milliseconds for the dashboard.
updateFrequencyDashboardUpdateFrequencyTypeyes Long-Term The frequency in which dashboard is updated. See DashboardUpdateFrequencyType, and the explanations under the DashboardParameter.
widgetsWidgetyes Long-Term Widgets for the dashboard (see Widget Table).
yamlTemplateYAMLyes Long-Term A yaml formatted string that describes the dashboard. YAML is a scalar. It doesn't contain links or permissions, and is safe to share and use for making copies of a dashboard. This replaced templateYaml starting in LogScale version 1.165.