This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.
« Engines API Multi search API »
Elastic Docs › ›API Reference

Log settings API

edit

Log settings API

edit

API reference for log settings.

Authentication

edit

Use a private admin key to access this API.

Read log settings

edit

Get log settings.

GET <ENTERPRISE_SEARCH_BASE_URL>/api/as/v1/log_settings
# 200 OK

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

Update log settings

edit

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>
  }
}

or

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
  }
}

Remove log settings

edit

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
  }
}
« Engines API Multi search API »