Create or update an IP geolocation database configuration

PUT /_ingest/ip_location/database/{id}

Required authorization

Authentication

Api key

Authorization: <value>

Elasticsearch APIs support key-based authentication. You must create an API key and use the encoded value in the request header. For example:

		curl -X GET "${ES_URL}/_cat/indices?v=true" \
  -H "Authorization: ApiKey ${API_KEY}"

To get API keys, use the /_security/api_key APIs.

Basic

Authorization: Basic <credentials>

Bearer

Authorization: Bearer <token>

Elasticsearch APIs support the use of bearer tokens in the Authorization HTTP header to authenticate with the API. For examples, refer to Token-based authentication services

Path parameters

Query parameters

Request body

Response

application/json

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

No example

Required authorization

Authentication

Path parameters

Query parameters

Request body { }

Response

Request body