IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
ApmSystemSettings
editApmSystemSettings
editA structure that defines a curated subset of the APM Server settings.
TIP: To define the complete set of APM Server setting, use ApmSystemSettings
with user_settings_override_
and user_settings_
.
Properties
edit-
debug_enabled
(boolean
) - Optionally enable debug mode for APM servers - defaults false
-
elasticsearch_password
(string
) - Optionally override the account within APM - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only.
-
elasticsearch_url
(string
) - Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)
-
elasticsearch_username
(string
) - Optionally override the account within APM - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only.
-
kibana_url
(string
) - Optionally override the URL to which to send data (for advanced users only, if unspecified the system selects an internal URL)
-
secret_token
(string
) - Optionally override the secret token within APM - defaults to the previously existing secretToken
Example
edit{ "debug_enabled" : true, "elasticsearch_password" : "string", "elasticsearch_url" : "string", "elasticsearch_username" : "string", "kibana_url" : "string", "secret_token" : "string" }