› ›

Log settings API

API reference for log settings.

Use a private admin key to access this API.

Get log settings.

GET <ENTERPRISE_SEARCH_BASE_URL>/api/as/v1/log_settings

# 200 OK

{
  "api": {
    "enabled": true
  },
  "analytics": {
    "enabled": true
  }
}

Put or patch log settings to set custom values.

PUT <ENTERPRISE_SEARCH_BASE_URL>/api/as/v1/log_settings
{
  "api": {
    "enabled": <value>
  },
  "analytics": {
    "enabled": <value>
  }
}

PATCH <ENTERPRISE_SEARCH_BASE_URL>/api/as/v1/log_settings
{
  "api": {
    "enabled": <value>
  },
  "analytics": {
    "enabled": <value>
  }
}

Example: Disable API logging

PUT <ENTERPRISE_SEARCH_BASE_URL>/api/as/v1/log_settings
{
  "api": {
    "enabled": false
  }
}

# 200 OK

{
  "api": {
    "enabled": false
  },
  "analytics": {
    "enabled": true
  }
}

Delete all log settings, restoring default behavior.

DELETE <ENTERPRISE_SEARCH_BASE_URL>/api/as/v1/log_settings

# 200 OK

{
  "api": {
    "enabled": true
  },
  "analytics": {
    "enabled": true
  }
}