API Stability Long-Term

The installPackageFromRegistryV2() GraphQL mutation field is used to install a package in a specific view in LogScale.

For more information on packages, see the Package Management documentation page.

Syntax

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

graphql
installPackageFromRegistryV2(
     InstallPackageFromRegistryInput: InstallPackageFromRegistryInput!
   ): InstallPackageFromRegistryResult!

Example

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

Raw
graphql
mutation {
  installPackageFromRegistryV2 (
    InstallPackageFromRegistryInput: {
        viewName: "humio",
        packageId: "crowdstrike/logscale-slack@1.0.0",
        queryOwnershipType: User }
  )
  { package {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 {
  installPackageFromRegistryV2 (
    InstallPackageFromRegistryInput: {
        viewName: \"humio\",
        packageId: \"crowdstrike/logscale-slack@1.0.0\",
        queryOwnershipType: User }
  )
  { package {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 {
  installPackageFromRegistryV2 (
    InstallPackageFromRegistryInput: {
        viewName: \"humio\",
        packageId: \"crowdstrike/logscale-slack@1.0.0\",
        queryOwnershipType: User }
  )
  { package {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 { ^
  installPackageFromRegistryV2 ( ^
    InstallPackageFromRegistryInput: { ^
        viewName: \"humio\", ^
        packageId: \"crowdstrike/logscale-slack@1.0.0\", ^
        queryOwnershipType: User } ^
  ) ^
  { package {id} } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  installPackageFromRegistryV2 (
    InstallPackageFromRegistryInput: {
        viewName: \"humio\",
        packageId: \"crowdstrike/logscale-slack@1.0.0\",
        queryOwnershipType: User }
  )
  { package {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 {
  installPackageFromRegistryV2 (
    InstallPackageFromRegistryInput: {
        viewName: \"humio\",
        packageId: \"crowdstrike/logscale-slack@1.0.0\",
        queryOwnershipType: User }
  )
  { package {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 {
  installPackageFromRegistryV2 (
    InstallPackageFromRegistryInput: {
        viewName: \"humio\",
        packageId: \"crowdstrike/logscale-slack@1.0.0\",
        queryOwnershipType: User }
  )
  { package {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 {
  installPackageFromRegistryV2 (
    InstallPackageFromRegistryInput: {
        viewName: \"humio\",
        packageId: \"crowdstrike/logscale-slack@1.0.0\",
        queryOwnershipType: User }
  )
  { package {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": {
    "installPackageFromRegistryV2": {
      "package": {
         "id": "crowdstrike/logscale-slack@1.0.0"
      }
    }
  }
}

Given Datatype

For the input datatype, you'll need to provide the name of the view, and the unique identifier of the package, including the version number. Below is a list of the parameters and a link to some sub-parameters:

Table: InstallPackageFromRegistryInput

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 28, 2025
queryOwnershipTypeQueryOwnershipTypeyesUserLong-TermThe query ownership type. See QueryOwnershipType.
packageIdVersionedPackageSpecifieryes Long-TermThe unique identifier of the package. VersionedPackageSpecifier. is a scalar value.
viewNameRepoOrViewNameyes Long-TermThe name of the view. RepoOrViewName. is a scalar value.

Returned Datatype

This returned datatype, through sub-parameters, provides plenty information on the package used, such as templates for its alerts, aggregate alerts, filter alerts, and actions. The table below has a link to the table containing these and other sub-parameters:

Table: InstallPackageFromRegistryResult

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: Sep 25, 2024
packagePackage2yes Long-TermThe package from which to install. See Package2.