Create
POST {{baseUrl}}/alerts_conditions/policies/{{policy_id}}.json
This API endpoint allows you to create APM Application and Key Transaction, Browser and Mobile application metric conditions for your alert policies.
Conditions for web transaction percentiles, or conditions targeting labels (dynamic targeting), are not available.
Note: Admin User’s API Key is required.
See our documentation for a discussion on creating conditions for policies.
All fields are required except for “runbook_url”, “enabled” (defaults to false), “user_defined”.
type: apm_app_metric, apm_kt_metric, servers_metric, browser_metric, mobile_metric.
name: A title for your condition.
enabled: The status of your condition (optional).
entities: An array of instance IDs associated with your condition.
metric: The metric field accepts parameters based on the condition type selected as follows:
When apm_app_metric: apdex, error_percentage, response_time_web, response_time_background, throughput_web, throughput_background, user_defined.
When apm_kt_metric: apdex, error_percentage, error_count, response_time, throughput.
When servers_metric: cpu_percentage, disk_io_percentage, memory_percentage, fullest_disk_percentage, load_average_one_minute, user_defined.
When browser_metric: end_user_apdex, total_page_load, page_rendering, web_application, network, dom_processing, request_queuing, ajax_response_time, page_views_with_js_errors, page_view_throughput, ajax_throughput, user_defined.
When mobile_metric: database, images, json, network, view_loading, network_error_percentage, status_error_percentage, mobile_crash_rate, user_defined.
condition_scope: Set to either instance to target a Java application instance or application for a Java app.
violation_close_timer (in hours): 1, 2, 4, 8, 12, 24. Duration after which instance-based (including JVM health metric) violations will automatically close.
runbook_url: Runbook URL to display in notifications (optional).
terms[duration] (in minutes): 5, 10, 15, 30, 60, 120.
terms[operator]: above, below, equal.
terms[priority]: critical, warning.
terms[threshold]: Must be 0 or greater.
terms[time_function]: all, any.
user_defined[metric]: A custom metric to be evaluated.
user_defined[value_function]: average, min, max, total, sample_size.
Request Body
{"condition"=>{"condition_scope"=>"<string>", "enabled"=>"<boolean>", "entities"=>["<integer>", "<integer>"], "gc_metric"=>"<string>", "metric"=>"<string>", "name"=>"<string>", "terms"=>[{"duration"=>"eu Lorem labore Ut tempor", "operator"=>"sint dolor", "priority"=>"in officia eiusmod", "threshold"=>"nulla in", "time_function"=>"cupidatat deserunt culpa commodo"}, {"duration"=>"et magna esse qui", "operator"=>"et cupidatat nostrud Duis", "priority"=>"sit ut", "threshold"=>"consectetur tempo", "time_function"=>"id"}], "type"=>"<string>", "user_defined"=>{"metric"=>"<string>", "value_function"=>"<string>"}, "violation_close_timer"=>"<integer>"}}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string |
RESPONSES
status: OK
{"condition":{"condition_scope":"in est do non","enabled":true,"entities":[19580470,1460630],"gc_metric":"commodo amet consectetur l","id":-19586835,"metric":"eiusmod non deserunt ullamco laboris","name":"labore adipisicing ad dolore est","runbook_url":"dolore ea sint aute","terms":[{"duration":"quis d","operator":"laboris nulla non dolore","priority":"commodo sed consequat officia sint","threshold":"dolore occaecat tempor et","time_function":"ipsum minim"},{"duration":"laboris enim","operator":"Duis in","priority":"reprehenderit sed sunt minim","threshold":"pariatur occaecat","time_function":"dolore in aliquip"}],"type":"dolore aliquip au","user_defined":{"metric":"commodo eiusmod et mollit","value_function":"velit sunt do nostrud"},"violation_close_timer":94563319}}