API Stability Long-Term

The ipDatabaseInfo() GraphQL query returns information about the IP location database used by the LogScale instance.

Related to IPs, there's the ipFilters() query field for getting a list of IP filters in the system. There are three related mutation fields: createIPFilter() for creating an IP filter; updateIPFilter() for changing one; and deleteIPFilter() for deleting an IP filter.

For general information on IP filters, see the IP Filter reference page.

Syntax

graphql
ipDatabaseInfo: IpDatabaseInfo!

There is no input for this query. For the results, you can request the absolute file path to the database, the type of database, and an md5 hash. See the Return Datatype section further down this page for more.

Example

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

Raw
graphql
query {
  ipDatabaseInfo {dbFilePath, updateStrategy,
  metadata{type, buildDate, description, dbFileMd5} }
}
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" : "query {
  ipDatabaseInfo {dbFilePath, updateStrategy,
  metadata{type, buildDate, description, dbFileMd5} }
}"
}
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" : "query {
  ipDatabaseInfo {dbFilePath, updateStrategy,
  metadata{type, buildDate, description, dbFileMd5} }
}"
}
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" : "query { ^
  ipDatabaseInfo {dbFilePath, updateStrategy, ^
  metadata{type, buildDate, description, dbFileMd5} } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "query {
  ipDatabaseInfo {dbFilePath, updateStrategy,
  metadata{type, buildDate, description, dbFileMd5} }
}"
}'
    "$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 = "query {
  ipDatabaseInfo {dbFilePath, updateStrategy,
  metadata{type, buildDate, description, dbFileMd5} }
}";
$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" : "query {
  ipDatabaseInfo {dbFilePath, updateStrategy,
  metadata{type, buildDate, description, dbFileMd5} }
}"
}'''

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" : "query {
  ipDatabaseInfo {dbFilePath, updateStrategy,
  metadata{type, buildDate, description, dbFileMd5} }
}"
}
);


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": {
    "ipDatabaseInfo": {
      "dbFilePath": "/data/humio-data/IpLocationDb.mmdb",
      "updateStrategy": "Automatic updates using ipdb.humio.com",
      "metadata": {
        "type": "GeoLite2-City",
        "buildDate": "2025-10-22T13:14:51Z",
        "description": "GeoLite2City database",
        "dbFileMd5": "485c545b0bb70fe27c733b21b1c69852"
      }
    }
  }
}

Returned Datatype

With the returned datatype, you can get the absolute file path to the file containing the database. Through a special datatype, you can get meta data, which includes the type of database and an md5 hash, if there is one. To see these meta parameters, click on the datatype for it in the table below.

Table: IpDatabaseInfo

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
dbFilePathstringyes Long-TermThe absolute file path of the file containing the IP database used by LogScale.
metadataIpDatabaseMetadata  Long-TermMetadata about the IP Database used by LogScale. See IpDatabaseMetadata.
updateStrategystringyes Long-TermThe update strategy used for the IP Database.