Create or update a GeoIP database configuration

PUT /_ingest/geoip/database/{id}

Auth

Refer to the create or update IP geolocation database configuration API.

Required privileges

Cluster privileges manage

Path parameters

id string required: ID of the database configuration to create or update.

Query parameters

master_timeout union oneOf · default: 30s: 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.; Values: -1 0
timeout union oneOf · default: 30s: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.; Values: -1 0

Request body

name string required: The provider-assigned name of the IP geolocation database to download.
maxmind object required: The configuration necessary to identify which IP geolocation provider to use to download the database, as well as any provider-specific configuration necessary for such downloading. At present, the only supported provider is maxmind, and the maxmind provider requires that an account_id (string) is configured.

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 / 2 languages

Console Kibana Dev Tools

PUT /_ingest/geoip/database/ID
{
  "name": "string",
  "maxmind": {
    "account_id": "string"
  }
}

Generated from the API spec

curl Shell

curl -X PUT "${ELASTICSEARCH_URL}/_ingest/geoip/database/${ID}" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "maxmind": {
      "account_id": "string"
    }
  }'

Generated from the API spec

Response

{
  "acknowledged": false
}

Generated from the API spec