installedPackage()

API Stability	`Long-Term`

The installedPackage() GraphQL query provides details for a specific package installed on a specific view.

For more information on packages, see the Packages documentation page.

Syntax

Below is the syntax for the installedPackage() query field:

graphql

installedPackage(
     packageId: VersionedPackageSpecifier!, 
     viewName: string!
   ): PackageInstallation

For the VersionedPackageSpecifier, you'll have to know the package name and it's version. Below is an example of how this might be given:

Show:

graphql

query {
  installedPackage(packageId: "humio/insights@0.0.14", viewName: "humio") 
  {
    installedBy{username,timestamp}, 
    updatedBy{username, timestamp},
    availableUpdate, source
  }
}

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "query {
  installedPackage(packageId: \"humio/insights@0.0.14\", viewName: \"humio\") 
  {
    installedBy{username,timestamp}, 
    updatedBy{username, timestamp},
    availableUpdate, source
  }
}"
}
EOF

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "query {
  installedPackage(packageId: \"humio/insights@0.0.14\", viewName: \"humio\") 
  {
    installedBy{username,timestamp}, 
    updatedBy{username, timestamp},
    availableUpdate, source
  }
}"
}
EOF

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql ^
    -H "Authorization: Bearer $TOKEN" ^
    -H "Content-Type: application/json" ^
    -d @'{"query" : "query { ^
  installedPackage(packageId: \"humio/insights@0.0.14\", viewName: \"humio\")  ^
  { ^
    installedBy{username,timestamp},  ^
    updatedBy{username, timestamp}, ^
    availableUpdate, source ^
  } ^
}" ^
} '

powershell

curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "query {
  installedPackage(packageId: \"humio/insights@0.0.14\", viewName: \"humio\") 
  {
    installedBy{username,timestamp}, 
    updatedBy{username, timestamp},
    availableUpdate, source
  }
}"
}'
    "$YOUR_LOGSCALE_URL/graphql"

perl

#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $INGEST_TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $json = '{"query" : "query {
  installedPackage(packageId: \"humio/insights@0.0.14\", viewName: \"humio\") 
  {
    installedBy{username,timestamp}, 
    updatedBy{username, timestamp},
    availableUpdate, source
  }
}"
}';
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

#! /usr/local/bin/python3

import requests

url = '$YOUR_LOGSCALE_URL/graphql'
mydata = r'''{"query" : "query {
  installedPackage(packageId: \"humio/insights@0.0.14\", viewName: \"humio\") 
  {
    installedBy{username,timestamp}, 
    updatedBy{username, timestamp},
    availableUpdate, source
  }
}"
}'''

resp = requests.post(url,
                     data = mydata,
                     headers = {
   "Authorization" : "Bearer $TOKEN",
   "Content-Type" : "application/json"
}
)

print(resp.text)

javascript

const https = require('https');

const data = JSON.stringify(
    {"query" : "query {
  installedPackage(packageId: \"humio/insights@0.0.14\", viewName: \"humio\") 
  {
    installedBy{username,timestamp}, 
    updatedBy{username, timestamp},
    availableUpdate, source
  }
}"
}
);


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

Show:

json

{
  "data": {
    "installedPackage": {
      "installedBy": {
        "username": "System",
        "timestamp": "2024-10-10T11:09:56.280Z"
      },
      "updatedBy": {
        "username": "System",
        "timestamp": "2024-10-10T11:09:56.280Z"
      },
      "availableUpdate": null,
      "source": "HumioHub"
    }
  }
}

There are many parameters and sub-parameters for the PackageInstallation. They're listed in the table in the next section here.

Given & Returned Datatypes

The given datatype, VersionedPackageSpecifier is a scalar. The returned datatype PackageInstallation has its own parameters. Below is a list of them along with their datatypes and a description of each:

Table: PackageInstallation

Parameter	Type	Required	Stability	Description
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 27, 2024
`availableUpdate`	`PackageVersion`		`Long-Term`	Version of package available for updating. `PackageVersion` is a scalar.
`id`	`VersionedPackageSpecifier`	yes	`Long-Term`	The identifier for the package and version. `VersionedPackageSpecifier` is a scalar.
`installedBy`	`UserAndTimestamp`	yes	`Long-Term`	The user identifier and time stamp for installation. See `UserAndTimestamp`.
`package`	`Package2`	yes	`Long-Term`	Designate a LogScale package. See `Package2`.
`source`	`PackageInstallationSourceType`	yes	`Long-Term`	Finds updates on a package. Looks also for updates installed manually. See `PackageInstallationSourceType`.
`updatedBy`	`UserAndTimestamp`	yes	`Long-Term`	The user and time stamp for the user that updated the package. See `UserAndTimestamp`.

GraphQL Queries

GraphQL API Stability

GraphQL Mutations

GraphQL Datatypes