Create or update an IP geolocation database configuration

PUT /_ingest/ip_location/database/{id}

Auth

Required privileges

Cluster privileges manage

Path parameters

id string required: The database configuration identifier.

Query parameters

master_timeout union oneOf · default: 30s: The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. A value of -1 indicates that the request should never time out.; Values: -1 0
timeout union oneOf · default: 30s: The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata. If no response is received before the timeout expires, the cluster metadata update still applies but the response indicates that it was not completely acknowledged. A value of -1 indicates that the request should never time out.; Values: -1 0

Request body

name string required: The provider-assigned name of the IP geolocation database to download.
maxmind object
ipinfo object

Response

application/json

acknowledged boolean required: For a successful response, this value is always true. On failure, an exception is returned instead.

View as Markdown

Examples

Request Console 1 / 8 languages

An example body for a PUT _ingest/ip_location/database/my-database-1 request.

Console Kibana Dev Tools

PUT _ingest/ip_location/database/my-database-1
{
  "name": "GeoIP2-Domain",
  "maxmind": {
    "account_id": "1234567"
  }
}

JavaScript Elasticsearch JavaScript Client

const response = await client.ingest.putIpLocationDatabase({
  id: "my-database-1",
  configuration: {
    name: "GeoIP2-Domain",
    maxmind: {
      account_id: "1234567",
    },
  },
});

Python Elasticsearch Python Client

resp = client.ingest.put_ip_location_database(
    id="my-database-1",
    configuration={
        "name": "GeoIP2-Domain",
        "maxmind": {
            "account_id": "1234567"
        }
    },
)

curl Shell

curl -X PUT "$ELASTICSEARCH_URL/_ingest/ip_location/database/my-database-1" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "GeoIP2-Domain",
    "maxmind": {
      "account_id": "1234567"
    }
  }'

Java Elasticsearch Java Client

client.ingest().putIpLocationDatabase(p -> p
    .id("my-database-1")
    .configuration(c -> c
        .maxmind(m -> m
            .accountId("1234567")
        )
        .name("GeoIP2-Domain")
    )
);

C# Elasticsearch .NET Client

var response = await client.Ingest
    .PutIpLocationDatabaseAsync(id: "my-database-1", d1 => d1
        .Configuration(d2 => d2
            .Name("GeoIP2-Domain")
            .Maxmind(d3 => d3
                .AccountId("1234567")
            )
        )
    );

PHP Elasticsearch PHP Client

$resp = $client->ingest()->putIpLocationDatabase([
    "id" => "my-database-1",
    "body" => [
        "name" => "GeoIP2-Domain",
        "maxmind" => [
            "account_id" => "1234567",
        ],
    ],
]);

Ruby Elasticsearch Ruby Client

response = client.ingest.put_ip_location_database(
  id: "my-database-1",
  body: {
    "name": "GeoIP2-Domain",
    "maxmind": {
      "account_id": "1234567"
    }
  }
)

Response

{
  "acknowledged": false
}

Generated from the API spec