Summary

Sometimes you may want to create a new dashboard that will have many of the same widgets and other settings as an existing one. Rather than start from scratch, it can be easier to make a copy and then modify the new one. For this, you can use the copyDashboard() GraphQL mutation.

API Stability Long-Term

Syntax

graphql
copyDashboard(
      id: string!,
      name: string!,
      sourceSearchDomainName: string!,
      targetSearchDomainName: string
   ): CopyDashboardMutation!

For the input, you'll have to give the unique identifier of the dashboard to copy (click on Show Query link above). You'll also need to give the name of the new dashboard, as well as the source and destination repository or view. See the Input Parameters section for more details.

For the results, there are several sub-parameters related to the dashboard. Besides confirmation of success, you may want the unique identifier of the new dashboard to use with other mutations. See the Returned Values section for more choices.

Example

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

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 {
  copyDashboard(
         id: \"abc123\",
         sourceSearchDomainName: \"humio\", 
         targetSearchDomainName: \"sandbox\",
         name: \"hosters\" ) 
  { dashboard {name, id, searchDomain { id, name } } }
}"
}
);


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": {
    "copyDashboard": {
      "dashboard": {
        "name": "hosters",
        "id": "def456",
        "searchDomain": {
          "id": "sandbox_jSl8Iz25KhDiPQzXYE6YDetG",
          "name": "sandbox_jSl8Iz25KhDiPQzXYE6YDetG"
        }
      }
    }
  }
}

Input Parameters

For the input, you'll have to give the unique identifier of the dashboard to copy. To see an example of how to get identifiers, click on Show Query link above the Syntax section.

You'll also have to provide the name of the new dashboard. This must be unique if copied into same repository or view. You will have to specify at least the name of the repository or view where the dashboard to copy is located, if not also the destination.

Table: Input Parameters & Datatypes

Parameter Type Required Default Description
This table contains all input parameters for this mutation.
id string yes   The unique identifier of the dashboard to copy.
name string yes   The name of the new dashboard to create.
sourceSearchDomainName string yes   The name of the repository or view where the dashboard to copy is located.
targetSearchDomainName string     The name of the repository or view where to put the new dashboard. If not specified, the source location will be used — provided a different, new name is given.

Returned Values

For the returned datatype, there is one choice. You can see it in the table below. It uses a core datatype. For your convenience, the table for that sub-datatype is included in the second below.

Table: CopyDashboardMutation Datatype

ParameterTypeRequiredDefaultStabilityDescription
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: Mar 25, 2025
dashboardDashboardyes Long-TermThe dashboard to copy. See Dashboard.

Table: Dashboard Datatype

ParameterTypeRequiredDefaultStabilityDescription
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: Aug 19, 2025
allowedActions[AssetAction]yes Short-TermThe allowed asset actions. See AssetAction Table). This is feature is a preview and may be changed.
createdInfoAssetCommitMetadata  Long-TermMetadata related to the creation of the dashboard. See AssetCommitMetadata.
defaultFilterDashboardFilter  Long-TermThe default filter used with the dashboard (see DashboardFilter Table).
defaultSharedTimeEnabledbooleanyes Long-TermWhether the shared time by default is enabled.
defaultSharedTimeEndstringyes Long-TermThe default shared ending time.
defaultSharedTimeStartstringyes Long-TermThe default shared starting time.
descriptionstring  Long-TermA description of the dashboard.
displayNamestringyes Long-TermThe display name of the dashboard.
filters[DashboardFilter]yes Long-TermThe filters used with the dashboard. See DashboardFilter.
idstringyes Long-TermThe unique identifier for the dashboard.
isStarredbooleanyes Long-TermWhether the dashboard is marked with a star.
labels[string]yes Long-TermAny labels associated with the dashboard.
modifiedInfoAssetCommitMetadata  Long-TermMetadata related to the latest modification of the dashboard. See AssetCommitMetadata.
namestringyes Long-TermThe name of the dashboard.
packagePackageInstallationyes Long-TermThe package, if there is one, in which the dashboard is included (see PackageInstallation Table).
packageIdVersionedPackageSpecifieryes Long-TermThe unique identifiers of the package. VersionedPackageSpecifier is a scalar.
parameters[DashboardParameter]yes Long-TermList of dashboard parameters (see DashboardParameter Table).
readOnlyTokens[DashboardLink]yes Long-TermList of tokens used to access the dashboard without logging in. Useful for wall mounted dashboards or public dashboards. See DashboardLink.
resourcestringyes Short-TermThe resource identifier for this dashboard.
searchDomainSearchDomainyes Long-TermThe search domain for the dashboard. See SearchDomain.
sections[Section]yes Long-TermThe sections for the dashboard. See Section.
series[SeriesConfig]yes Long-TermThe series configuration for the dashboard. See SeriesConfig.
templateYamlstringyes DeprecatedA yaml formatted string that describes the dashboard. This field has been replaced with yamlTemplate. It will be removed at the earliest in version 1.225.
timeJumpSizeInMsinteger  Long-TermThe skip time in milliseconds for the dashboard.
updateFrequencyDashboardUpdateFrequencyTypeyes Long-TermThe frequency in which dashboard is updated. See DashboardUpdateFrequencyType, and the explanations under the DashboardParameter.
widgets[Widget]yes Long-TermWidgets for the dashboard (see Widget Table).
yamlTemplateYAMLyes Long-TermA 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.