Get IP geolocation database configurations

GET /_ingest/ip_location/database/{id}
GET /_ingest/ip_location/database

Auth

Required privileges

Cluster privileges manage

Path parameters

id union string | string[] optional

Comma-separated list of database configuration IDs to retrieve. Wildcard (*) expressions are supported. To get all database configurations, omit this parameter or use *.

Leave it out to use /_ingest/ip_location/database.

Response

application/json

databases object[] required

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

GET /_ingest/ip_location/database/my-database-id

JavaScript Elasticsearch JavaScript Client

const response = await client.ingest.getIpLocationDatabase({
  id: "my-database-id",
});

Python Elasticsearch Python Client

resp = client.ingest.get_ip_location_database(
    id="my-database-id",
)

curl Shell

curl -X GET "$ELASTICSEARCH_URL/_ingest/ip_location/database/my-database-id" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.ingest().getIpLocationDatabase(g -> g
    .id("my-database-id")
);

C# Elasticsearch .NET Client

var response = await client.Ingest
    .GetIpLocationDatabaseAsync(d1 => d1
        .Id(new[] { "my-database-id" })
    );

PHP Elasticsearch PHP Client

$resp = $client->ingest()->getIpLocationDatabase([
    "id" => "my-database-id",
]);

Ruby Elasticsearch Ruby Client

response = client.ingest.get_ip_location_database(
  id: "my-database-id"
)

Response

{
  "databases": [
    {
      "id": "string",
      "version": 0,
      "modified_date_millis": 0,
      "modified_date": 0,
      "database": {
        "name": "string",
        "web": {},
        "local": {
          "type": "string"
        },
        "maxmind": {
          "account_id": "string"
        },
        "ipinfo": {}
      }
    }
  ]
}

Generated from the API spec