API Stability Long-Term

The copyDashboard() GraphQL mutation may be used to create a clone of a dashboard.

There are several other basic mutations related to dashboards. You can use the createDashboard() to create a new one, and updateDashboard() to update an existing one. The renameDashboard() is used to rename a dashboard and deleteDashboardV3() to delete one. To get a list of dashboards, use the dashboardsPage() query.

For information on creating dashboards, see the Create Dashboards documentation page. You may also want to look at the Dashboards and Dashboards pages for related information.

Syntax

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

The targetSearchDomainName is given a string value with the name of the repository or view to which the dashboard to be copied. For the sourceSearchDomainName, provide the name of the repository or view to which the dashboard is to be copied. This is required. The name is the name the copied dashboard should have.

Example

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

Raw
graphql
mutation {
  copyDashboard(
         id: "ILLF8JldGGP6tVspPuRtifX7ZGiHveGV",
         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: \"ILLF8JldGGP6tVspPuRtifX7ZGiHveGV\",
         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: \"ILLF8JldGGP6tVspPuRtifX7ZGiHveGV\",
         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: \"ILLF8JldGGP6tVspPuRtifX7ZGiHveGV\", ^
         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: \"ILLF8JldGGP6tVspPuRtifX7ZGiHveGV\",
         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: \"ILLF8JldGGP6tVspPuRtifX7ZGiHveGV\",
         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: \"ILLF8JldGGP6tVspPuRtifX7ZGiHveGV\",
         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: \"ILLF8JldGGP6tVspPuRtifX7ZGiHveGV\",
         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": "Zo10gGfXnGaVLe1rOn4jLG0M48BzlBUI",
        "searchDomain": {
          "id": "sandbox_jSl8Iz25KhDiPQzXYE6YDetG",
          "name": "sandbox_jSl8Iz25KhDiPQzXYE6YDetG"
        }
      }
    }
  }
}

Returned Datatype

For the returned datatype, there are several sub-parameters related to the dashboard. At a minimum, you may want to get the unique identifier to use with other mutations and queries. The table below provides a link to sub-parameters you may find useful:

Table: CopyDashboardMutation

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For return datatypes, this indicates that you must specify which fields you want returned in the results.
Table last updated: Mar 25, 2025
dashboardDashboardyes Long-TermThe dashboard to copy. See Dashboard.