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

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

Syntax

Below is the syntax for the copyDashboard() mutation field:

graphql
copyDashboard(
      id: string!
      targetSearchDomainName: string
      sourceSearchDomainName: string!
      name: 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.

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 $INGEST_TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $json = '{"query" : "mutation {
  copyDashboard(
         id: \"ILLF8JldGGP6tVspPuRtifX7ZGiHveGV\",
         sourceSearchDomainName: \"humio\", 
         targetSearchDomainName: \"sandbox\",
         name: \"hosters\" ) 
  { dashboard {name, id, searchDomain { id, name } } }
}"
}';
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/graphql',
  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 Datatypes

The returned datatype CopyDashboardMutation has its own parameter:

Table: CopyDashboardMutation

ParameterTypeRequiredDefaultDescription
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Sep 24, 2024
DashboardDashboardyes The dashboard to copy. See Dashboard.