openapi: 3.1.0 info: title: New Relic Event Alerts Policies API description: The New Relic Event API allows you to send custom event data to the New Relic platform via HTTP POST. Custom events submitted through this API can be queried and visualized using NRQL, making it suitable for tracking arbitrary business or application events. Each event is a JSON object with an eventType and any number of additional attribute key-value pairs. version: '1' contact: name: New Relic Support url: https://support.newrelic.com/ termsOfService: https://newrelic.com/termsandconditions/terms x-last-validated: '2026-04-18' servers: - url: https://insights-collector.newrelic.com description: US Production - url: https://insights-collector.eu01.nr-data.net description: EU Production security: - apiKey: [] tags: - name: Policies paths: /alerts_conditions/policies/{policy_id}.json: post: tags: - Policies summary: New Relic Post Alerts Conditions Policies description: "🔥🔥 New users should use these docs about managing alerts via NerdGraph.\n\n

This API endpoint allows you to create APM Application and Key Transaction, Browser and Mobile application metric conditions for your alert policies.

\n\n

Conditions for web transaction percentiles, or conditions targeting labels (dynamic targeting), are not available.

\n\n

Note: Admin User’s API Key is required.

\n\n

See our documentation for a discussion on creating conditions for policies.\n

\n\n

All fields are required except for “runbook_urlâ€\x9D, “enabledâ€\x9D (defaults to false), “user_definedâ€\x9D.

\n\n

type: apm_app_metric, apm_kt_metric, servers_metric, browser_metric, mobile_metric.

\n\n

name: A title for your condition.

\n\n

enabled: The status of your condition (optional).

\n\n

entities: An array of instances associated with your condition.

\n\n

metric: The metric field accepts parameters based on the condition type selected as follows:

\n\n

  When apm_app_metric: apdex, error_percentage, response_time_web, response_time_background, throughput_web, throughput_background, user_defined.

\n\n

  When apm_kt_metric: apdex, error_percentage, error_count, response_time, throughput.

\n\n

  When servers_metric: cpu_percentage, disk_io_percentage, memory_percentage, fullest_disk_percentage, load_average_one_minute, user_defined.

\n\n

  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.

\n\n

  When mobile_metric: database, images, json, network, view_loading, network_error_percentage, status_error_percentage, mobile_crash_rate, user_defined.

\n\n

condition_scope: Set to either instance to target a Java application instance or application for a Java app.

\n\n

violation_close_timer (in hours): 1, 2, 4, 8, 12, 24. Duration after which instance-based (including JVM health metric) violations will automatically close.

\n\n

runbook_url: Runbook URL to display in notifications (optional).

\n\n

terms[duration] (in minutes): 5, 10, 15, 30, 60, 120.

\n\n

terms[operator]: above, below, equal.

\n\n

terms[priority]: critical, warning.

\n\n

terms[threshold]: Must be 0 or greater.

\n\n

terms[time_function]: all, any.

\n\n

user_defined[metric]: A custom metric to be evaluated.

\n\n

user_defined[value_function]: average, min, max, total, sample_size.

\n\n" parameters: - name: policy_id in: path description: Alerts policy required: true schema: type: integer example: 100 requestBody: description: Condition schema content: application/json: schema: $ref: '#/components/schemas/Condition' examples: PostalertsconditionspoliciespolicyidRequestExample: summary: Default postAlertsConditionsPoliciesPolicyId request x-microcks-default: true value: condition: condition_scope: example_value enabled: true entities: - {} gc_metric: example_value metric: example_value name: Example Title terms: - {} type: example_value violation_close_timer: 10 application/xml: schema: $ref: '#/components/schemas/Condition' examples: PostalertsconditionspoliciespolicyidRequestExample: summary: Default postAlertsConditionsPoliciesPolicyId request x-microcks-default: true value: condition: condition_scope: example_value enabled: true entities: - {} gc_metric: example_value metric: example_value name: Example Title terms: - {} type: example_value violation_close_timer: 10 required: true responses: '200': description: No response was specified content: application/json: schema: $ref: '#/components/schemas/ConditionResponse' examples: Postalertsconditionspoliciespolicyid200Example: summary: Default postAlertsConditionsPoliciesPolicyId 200 response x-microcks-default: true value: condition: condition_scope: {} enabled: {} entities: {} gc_metric: {} id: {} metric: {} name: {} runbook_url: {} terms: {} type: {} user_defined: {} violation_close_timer: {} application/xml: schema: $ref: '#/components/schemas/ConditionResponse' examples: Postalertsconditionspoliciespolicyid200Example: summary: Default postAlertsConditionsPoliciesPolicyId 200 response x-microcks-default: true value: condition: condition_scope: {} enabled: {} entities: {} gc_metric: {} id: {} metric: {} name: {} runbook_url: {} terms: {} type: {} user_defined: {} violation_close_timer: {} x-codegen-request-body-name: condition x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true GenerateOperationSummariesFromPath: true ChooseTags: true operationId: postAlertsConditionsPoliciesPolicyId x-microcks-operation: delay: 0 dispatcher: FALLBACK /alerts_external_service_conditions/policies/{policy_id}.json: post: tags: - Policies summary: New Relic Post Alerts External Service Conditions Policies description: "🔥🔥 New users should use NRQL Alert Conditions, refer to these docs about managing alerts via NerdGraph.\n\n

This API endpoint allows you to create external service conditions for your alert policies.

\n\n

Note: Admin User’s API Key is required.

\n\n

See our documentation for a discussion on creating conditions for external services.

\n\n

All fields are required except for “runbook_urlâ€\x9D, “enabledâ€\x9D (defaults to false).

\n\n

type: apm_external_service, mobile_external_service.

\n\n

name: A title for your condition.

\n\n

enabled: The status of your condition (optional).

\n\n

entities: An array of instance IDs associated with your condition.

\n\n

external_service_url: The URL of the external service. Must not include protocol (“example.comâ€\x9D, not “https://example.comâ€\x9D)

\n\n

metric: The metric field accepts parameters based on the condition type selected as follows:

\n\n

  When apm_external_service: response_time_average, response_time_minimum, response_time_maximum, throughput.

\n\n

  When mobile_external_service: response_time_average, response_time_minimum, response_time_maximum, throughput, network_failure_percentage, http_status_error_percentage.

\n\n

runbook_url: Runbook URL to display in notifications (optional).

\n\n

terms[duration] (in minutes): 5, 10, 15, 30, 60, 120.

\n\n

terms[operator]: above, below, equal.

\n\n

terms[priority]: critical, warning.

\n\n

terms[threshold]: Must be 0 or greater.

\n\n

terms[time_function]: all, any.

\n\n" parameters: - name: policy_id in: path description: Alerts policy ID required: true schema: type: integer example: 100 requestBody: description: Condition schema content: application/json: schema: $ref: '#/components/schemas/ExternalServiceCondition' examples: PostalertsexternalserviceconditionspoliciespolicyidRequestExample: summary: Default postAlertsExternalServiceConditionsPoliciesPolicyId request x-microcks-default: true value: external_service_condition: enabled: true entities: - {} external_service_url: https://www.example.com metric: example_value name: Example Title runbook_url: https://www.example.com terms: - {} type: example_value application/xml: schema: $ref: '#/components/schemas/ExternalServiceCondition' examples: PostalertsexternalserviceconditionspoliciespolicyidRequestExample: summary: Default postAlertsExternalServiceConditionsPoliciesPolicyId request x-microcks-default: true value: external_service_condition: enabled: true entities: - {} external_service_url: https://www.example.com metric: example_value name: Example Title runbook_url: https://www.example.com terms: - {} type: example_value required: true responses: '200': description: No response was specified content: application/json: schema: $ref: '#/components/schemas/ExternalServiceConditionResponse' examples: Postalertsexternalserviceconditionspoliciespolicyid200Example: summary: Default postAlertsExternalServiceConditionsPoliciesPolicyId 200 response x-microcks-default: true value: external_service_condition: enabled: {} entities: {} external_service_url: {} id: {} metric: {} name: {} runbook_url: {} terms: {} type: {} application/xml: schema: $ref: '#/components/schemas/ExternalServiceConditionResponse' examples: Postalertsexternalserviceconditionspoliciespolicyid200Example: summary: Default postAlertsExternalServiceConditionsPoliciesPolicyId 200 response x-microcks-default: true value: external_service_condition: enabled: {} entities: {} external_service_url: {} id: {} metric: {} name: {} runbook_url: {} terms: {} type: {} x-codegen-request-body-name: external_service_condition x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true GenerateOperationSummariesFromPath: true ChooseTags: true operationId: postAlertsExternalServiceConditionsPoliciesPolicyId x-microcks-operation: delay: 0 dispatcher: FALLBACK /alerts_location_failure_conditions/policies/{policy_id}.json: get: tags: - Policies summary: New Relic Get Alerts Location Failure Conditions Policies description: '🔥 This endpoint will be deprecated after 2024/01 🔥 New users should use these docs about managing alerts via NerdGraph.

This API endpoint allows you to list the alerts location failure conditions for your Alerts policy.

' parameters: - name: policy_id in: path description: Alerts policy ID required: true schema: type: integer example: 100 - name: page in: query description: Pagination index schema: type: integer example: 100 responses: '200': description: No response was specified headers: link: description: 'Links to related resources, in the format defined by [RFC 5988](https://tools.ietf.org/html/rfc5988#section-5). This will include a link with relation type `next` to the next page and `last` to the last page, unless this page is itself the last page. ' schema: type: array items: type: string content: application/json: schema: type: array items: $ref: '#/components/schemas/ConditionResponse' examples: Getalertslocationfailureconditionspoliciespolicyid200Example: summary: Default getAlertsLocationFailureConditionsPoliciesPolicyId 200 response x-microcks-default: true value: - condition: {} application/xml: schema: type: array items: $ref: '#/components/schemas/ConditionResponse' examples: Getalertslocationfailureconditionspoliciespolicyid200Example: summary: Default getAlertsLocationFailureConditionsPoliciesPolicyId 200 response x-microcks-default: true value: - condition: {} x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true GenerateOperationSummariesFromPath: true ChooseTags: true operationId: getAlertsLocationFailureConditionsPoliciesPolicyId x-microcks-operation: delay: 0 dispatcher: FALLBACK post: tags: - Policies summary: New Relic Post Alerts Location Failure Conditions Policies description: '🔥 This endpoint will be deprecated after 2024/01 🔥 New users should use these docs about managing alerts via NerdGraph.

This API endpoint allows you to create the alerts location failure conditions for your Alerts policy.

' parameters: - name: policy_id in: path description: Alerts policy failure condition required: true schema: type: integer example: 100 - name: location_failure_condition in: path description: Alerts policy ID required: true schema: type: integer example: 100 requestBody: description: Condition schema content: application/json: schema: $ref: '#/components/schemas/ConditionResponse' examples: PostalertslocationfailureconditionspoliciespolicyidRequestExample: summary: Default postAlertsLocationFailureConditionsPoliciesPolicyId request x-microcks-default: true value: condition: condition_scope: example_value enabled: true entities: - {} gc_metric: example_value id: abc123 metric: example_value name: Example Title runbook_url: https://www.example.com terms: - {} type: example_value violation_close_timer: 10 application/xml: schema: $ref: '#/components/schemas/ConditionResponse' examples: PostalertslocationfailureconditionspoliciespolicyidRequestExample: summary: Default postAlertsLocationFailureConditionsPoliciesPolicyId request x-microcks-default: true value: condition: condition_scope: example_value enabled: true entities: - {} gc_metric: example_value id: abc123 metric: example_value name: Example Title runbook_url: https://www.example.com terms: - {} type: example_value violation_close_timer: 10 required: true responses: '200': description: No response was specified content: application/json: schema: $ref: '#/components/schemas/ConditionResponse' examples: Postalertslocationfailureconditionspoliciespolicyid200Example: summary: Default postAlertsLocationFailureConditionsPoliciesPolicyId 200 response x-microcks-default: true value: condition: condition_scope: {} enabled: {} entities: {} gc_metric: {} id: {} metric: {} name: {} runbook_url: {} terms: {} type: {} user_defined: {} violation_close_timer: {} application/xml: schema: $ref: '#/components/schemas/ConditionResponse' examples: Postalertslocationfailureconditionspoliciespolicyid200Example: summary: Default postAlertsLocationFailureConditionsPoliciesPolicyId 200 response x-microcks-default: true value: condition: condition_scope: {} enabled: {} entities: {} gc_metric: {} id: {} metric: {} name: {} runbook_url: {} terms: {} type: {} user_defined: {} violation_close_timer: {} x-codegen-request-body-name: condition x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true GenerateOperationSummariesFromPath: true ChooseTags: true operationId: postAlertsLocationFailureConditionsPoliciesPolicyId x-microcks-operation: delay: 0 dispatcher: FALLBACK /alerts_nrql_conditions/policies/{policy_id}.json: post: tags: - Policies summary: New Relic Post Alerts Nrql Conditions Policies description: '🔥🔥 New users should use these docs about managing alerts via NerdGraph. ' parameters: - name: policy_id in: path description: Alerts policy ID required: true schema: type: integer example: 100 requestBody: description: Condition schema content: application/json: schema: $ref: '#/components/schemas/NrqlCondition' examples: PostalertsnrqlconditionspoliciespolicyidRequestExample: summary: Default postAlertsNrqlConditionsPoliciesPolicyId request x-microcks-default: true value: nrql_condition: enabled: true expected_groups: 10 ignore_overlap: true name: Example Title runbook_url: https://www.example.com terms: - {} value_function: example_value application/xml: schema: $ref: '#/components/schemas/NrqlCondition' examples: PostalertsnrqlconditionspoliciespolicyidRequestExample: summary: Default postAlertsNrqlConditionsPoliciesPolicyId request x-microcks-default: true value: nrql_condition: enabled: true expected_groups: 10 ignore_overlap: true name: Example Title runbook_url: https://www.example.com terms: - {} value_function: example_value required: true responses: '200': description: No response was specified content: application/json: schema: $ref: '#/components/schemas/NrqlConditionResponse' examples: Postalertsnrqlconditionspoliciespolicyid200Example: summary: Default postAlertsNrqlConditionsPoliciesPolicyId 200 response x-microcks-default: true value: nrql_condition: enabled: {} expected_groups: {} id: {} ignore_overlap: {} name: {} nrql: {} runbook_url: {} terms: {} type: {} value_function: {} application/xml: schema: $ref: '#/components/schemas/NrqlConditionResponse' examples: Postalertsnrqlconditionspoliciespolicyid200Example: summary: Default postAlertsNrqlConditionsPoliciesPolicyId 200 response x-microcks-default: true value: nrql_condition: enabled: {} expected_groups: {} id: {} ignore_overlap: {} name: {} nrql: {} runbook_url: {} terms: {} type: {} value_function: {} x-codegen-request-body-name: nrql_condition x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true GenerateOperationSummariesFromPath: true ChooseTags: true operationId: postAlertsNrqlConditionsPoliciesPolicyId x-microcks-operation: delay: 0 dispatcher: FALLBACK /alerts_policies.json: get: tags: - Policies summary: New Relic Get Alerts Policies description: '🔥🔥 New users should use these docs about managing alerts via NerdGraph.

This API endpoint works with new Alerts on alerts.newrelic.com.

This API endpoint returns a list of the alert policies associated with your New Relic account.

See our documentation for a discussion on output pagination.

' parameters: - name: filter[name] in: query description: Name (must be exact match) schema: type: string example: example_string - name: page in: query description: Pagination index schema: type: integer example: 100 responses: '200': description: No response was specified headers: link: description: 'Links to related resources, in the format defined by [RFC 5988](https://tools.ietf.org/html/rfc5988#section-5). This will include a link with relation type `next` to the next page and `last` to the last page, unless this page is itself the last page. ' schema: type: array items: type: string content: application/json: schema: $ref: '#/components/schemas/PolicyResponse' examples: Getalertspolicies200Example: summary: Default getAlertsPolicies 200 response x-microcks-default: true value: policy: created_at: {} id: {} incident_preference: {} name: {} updated_at: {} application/xml: schema: $ref: '#/components/schemas/PolicyResponse' examples: Getalertspolicies200Example: summary: Default getAlertsPolicies 200 response x-microcks-default: true value: policy: created_at: {} id: {} incident_preference: {} name: {} updated_at: {} x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true GenerateOperationSummariesFromPath: true ChooseTags: true operationId: getAlertsPolicies x-microcks-operation: delay: 0 dispatcher: FALLBACK post: tags: - Policies summary: New Relic Post Alerts Policies description: "🔥🔥 New users should use these docs about managing alerts via NerdGraph.\n\n

This API endpoint works with new Alerts on alerts.newrelic.com.

\n\n

This Alerts API endpoint creates a policy associated with your New Relic account.

\n\n

Note: Admin User’s API Key is required.

\n\n

Rollup stategy options:

\n\n\n\n

See our documentation for a discussion on using the REST API for\ncreating new policies.

\n\n" requestBody: description: Policy Schema content: application/json: schema: $ref: '#/components/schemas/Policy' examples: PostalertspoliciesRequestExample: summary: Default postAlertsPolicies request x-microcks-default: true value: policy: incident_preference: example_value name: Example Title application/xml: schema: $ref: '#/components/schemas/Policy' examples: PostalertspoliciesRequestExample: summary: Default postAlertsPolicies request x-microcks-default: true value: policy: incident_preference: example_value name: Example Title required: true responses: '200': description: No response was specified content: application/json: schema: $ref: '#/components/schemas/PolicyResponse' examples: Postalertspolicies200Example: summary: Default postAlertsPolicies 200 response x-microcks-default: true value: policy: created_at: {} id: {} incident_preference: {} name: {} updated_at: {} application/xml: schema: $ref: '#/components/schemas/PolicyResponse' examples: Postalertspolicies200Example: summary: Default postAlertsPolicies 200 response x-microcks-default: true value: policy: created_at: {} id: {} incident_preference: {} name: {} updated_at: {} x-codegen-request-body-name: policy x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true GenerateOperationSummariesFromPath: true ChooseTags: true operationId: postAlertsPolicies x-microcks-operation: delay: 0 dispatcher: FALLBACK /alerts_policies/{policy_id}.json: put: tags: - Policies summary: New Relic Put Alerts Policies description: '🔥🔥 New users should use these docs about managing alerts via NerdGraph.

This API endpoint updates Alerts policies associated with your New Relic account.

Note: Admin User’s API Key is required.

See our documentation for a discussion on using the REST API for updating policies.

' parameters: - name: policy_id in: path description: Policy ID required: true schema: type: integer example: 100 requestBody: description: Policy Schema content: application/json: schema: $ref: '#/components/schemas/Policy' examples: PutalertspoliciespolicyidRequestExample: summary: Default putAlertsPoliciesPolicyId request x-microcks-default: true value: policy: incident_preference: example_value name: Example Title application/xml: schema: $ref: '#/components/schemas/Policy' examples: PutalertspoliciespolicyidRequestExample: summary: Default putAlertsPoliciesPolicyId request x-microcks-default: true value: policy: incident_preference: example_value name: Example Title required: true responses: '200': description: No response was specified content: application/json: schema: $ref: '#/components/schemas/PolicyResponse' examples: Putalertspoliciespolicyid200Example: summary: Default putAlertsPoliciesPolicyId 200 response x-microcks-default: true value: policy: created_at: {} id: {} incident_preference: {} name: {} updated_at: {} application/xml: schema: $ref: '#/components/schemas/PolicyResponse' examples: Putalertspoliciespolicyid200Example: summary: Default putAlertsPoliciesPolicyId 200 response x-microcks-default: true value: policy: created_at: {} id: {} incident_preference: {} name: {} updated_at: {} x-codegen-request-body-name: policy x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true GenerateOperationSummariesFromPath: true ChooseTags: true operationId: putAlertsPoliciesPolicyId x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: tags: - Policies summary: New Relic Delete Alerts Policies description: '🔥🔥 New users should use these docs about managing alerts via NerdGraph.

This API endpoint deletes Alerts policies associated with your New Relic account.

Note: Admin User’s API Key is required.

See our documentation for a discussion on using the REST API for deleting policies.

' parameters: - name: policy_id in: path description: Policy ID required: true schema: type: integer example: 100 responses: '200': description: No response was specified content: application/json: schema: $ref: '#/components/schemas/PolicyResponse' examples: Deletealertspoliciespolicyid200Example: summary: Default deleteAlertsPoliciesPolicyId 200 response x-microcks-default: true value: policy: created_at: {} id: {} incident_preference: {} name: {} updated_at: {} application/xml: schema: $ref: '#/components/schemas/PolicyResponse' examples: Deletealertspoliciespolicyid200Example: summary: Default deleteAlertsPoliciesPolicyId 200 response x-microcks-default: true value: policy: created_at: {} id: {} incident_preference: {} name: {} updated_at: {} x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true GenerateOperationSummariesFromPath: true ChooseTags: true operationId: deleteAlertsPoliciesPolicyId x-microcks-operation: delay: 0 dispatcher: FALLBACK /alerts_policy_channels.json: put: tags: - Policies summary: New Relic Put Alerts Policy Channels description: '🔥 This endpoint will be deprecated after 2024/01 🔥 New users should use these docs about managing alerts via NerdGraph.

This API endpoint updates policy/channel associations.

Note: Admin User’s API Key is required.

See our documentation for a discussion on updating notification channels with policies.

' parameters: - name: policy_id in: query description: Policy ID required: true schema: type: integer example: 100 - name: channel_ids in: query description: Channel IDs required: true style: form explode: false schema: type: array items: type: string example: - '500123' responses: '200': description: No response was specified content: application/json: schema: $ref: '#/components/schemas/PolicyChannelsResponse' examples: Putalertspolicychannels200Example: summary: Default putAlertsPolicyChannels 200 response x-microcks-default: true value: policy: channel_ids: {} id: {} application/xml: schema: $ref: '#/components/schemas/PolicyChannelsResponse' examples: Putalertspolicychannels200Example: summary: Default putAlertsPolicyChannels 200 response x-microcks-default: true value: policy: channel_ids: {} id: {} x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true GenerateOperationSummariesFromPath: true ChooseTags: true operationId: putAlertsPolicyChannels x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: tags: - Policies summary: New Relic Delete Alerts Policy Channels description: '🔥 This endpoint will be deprecated after 2024/01 🔥 New users should use these docs about managing alerts via NerdGraph.

This API endpoint deletes Alerts policy/channel associations.

Note: Admin User’s API Key is required.

See our documentation for a discussion on deleting notification channels with policies.

' parameters: - name: policy_id in: query description: Policy ID required: true schema: type: integer example: 100 - name: channel_id in: query description: Channel ID required: true schema: type: integer example: 100 responses: '200': description: No response was specified content: application/json: schema: $ref: '#/components/schemas/ChannelResponse' examples: Deletealertspolicychannels200Example: summary: Default deleteAlertsPolicyChannels 200 response x-microcks-default: true value: channel: configuration: {} id: {} links: {} name: {} type: {} application/xml: schema: $ref: '#/components/schemas/ChannelResponse' examples: Deletealertspolicychannels200Example: summary: Default deleteAlertsPolicyChannels 200 response x-microcks-default: true value: channel: configuration: {} id: {} links: {} name: {} type: {} x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true GenerateOperationSummariesFromPath: true ChooseTags: true operationId: deleteAlertsPolicyChannels x-microcks-operation: delay: 0 dispatcher: FALLBACK /alerts_synthetics_conditions/policies/{policy_id}.json: post: tags: - Policies summary: New Relic Post Alerts Synthetics Conditions Policies description: "🔥🔥 New users should use NRQL Alert Conditions, refer to these docs about managing alerts via NerdGraph.\n\n
\n\n

This API endpoint allows you to create Synthetics conditions for your alert policies.

\n\n

Note: Admin User’s API Key is required.

\n\n

See our documentation for a discussion on creating Synthetic conditions.

\n\n

All fields are required except for “runbook_urlâ€\x9D, “enabledâ€\x9D (defaults to false).

\n\n

name: A title for your condition.

\n\n

monitor_id: The GUID of the Synthetics monitor to alert on.

\n\n

runbook_url: Runbook URL to display in notifications (optional).

\n\n

enabled: The status of your condition (optional).

\n" parameters: - name: policy_id in: path description: Alerts policy ID required: true schema: type: integer example: 100 requestBody: description: Condition schema content: application/json: schema: $ref: '#/components/schemas/SyntheticsCondition' examples: PostalertssyntheticsconditionspoliciespolicyidRequestExample: summary: Default postAlertsSyntheticsConditionsPoliciesPolicyId request x-microcks-default: true value: synthetics_condition: enabled: true monitor_id: '500123' name: Example Title runbook_url: https://www.example.com application/xml: schema: $ref: '#/components/schemas/SyntheticsCondition' examples: PostalertssyntheticsconditionspoliciespolicyidRequestExample: summary: Default postAlertsSyntheticsConditionsPoliciesPolicyId request x-microcks-default: true value: synthetics_condition: enabled: true monitor_id: '500123' name: Example Title runbook_url: https://www.example.com required: true responses: '200': description: No response was specified content: application/json: schema: $ref: '#/components/schemas/SyntheticsConditionResponse' examples: Postalertssyntheticsconditionspoliciespolicyid200Example: summary: Default postAlertsSyntheticsConditionsPoliciesPolicyId 200 response x-microcks-default: true value: synthetics_condition: enabled: {} id: {} monitor_id: {} name: {} runbook_url: {} application/xml: schema: $ref: '#/components/schemas/SyntheticsConditionResponse' examples: Postalertssyntheticsconditionspoliciespolicyid200Example: summary: Default postAlertsSyntheticsConditionsPoliciesPolicyId 200 response x-microcks-default: true value: synthetics_condition: enabled: {} id: {} monitor_id: {} name: {} runbook_url: {} x-codegen-request-body-name: synthetics_condition x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true GenerateOperationSummariesFromPath: true ChooseTags: true operationId: postAlertsSyntheticsConditionsPoliciesPolicyId x-microcks-operation: delay: 0 dispatcher: FALLBACK components: schemas: SyntheticsCondition: type: object properties: synthetics_condition: $ref: '#/components/schemas/SyntheticsConditionBody' NrqlConditionBody: type: object properties: enabled: type: boolean example: true expected_groups: type: integer example: 100 ignore_overlap: type: boolean example: true name: type: string example: example-resource-01 nrql: $ref: '#/components/schemas/NrqlBody' runbook_url: type: string example: https://portal.example.com/path/abc123 terms: type: array items: $ref: '#/components/schemas/IJKTermsType' example: - duration: example_string operator: example_string priority: example_string threshold: example_string time_function: example_string value_function: type: string example: example_string PolicyChannelsResponseType: type: object properties: channel_ids: type: array items: type: integer example: - 100 id: type: integer example: 100 NrqlConditionResponse: type: object properties: nrql_condition: $ref: '#/components/schemas/NrqlConditionResponseType' PolicyChannelsResponse: type: object properties: policy: $ref: '#/components/schemas/PolicyChannelsResponseType' NrqlBody: type: object properties: query: type: string example: example_string since_value: type: string example: example_string PolicyResponse: type: object properties: policy: $ref: '#/components/schemas/PolicyResponseType' ChannelResponseType: type: object properties: configuration: type: object properties: {} example: {} id: type: integer example: 100 links: $ref: '#/components/schemas/ChannelLinksResponse' name: type: string example: example-resource-01 type: type: string example: standard SyntheticsConditionResponseType: type: object properties: enabled: type: boolean example: true id: type: integer example: 100 monitor_id: type: string example: '500123' name: type: string example: example-resource-01 runbook_url: type: string example: https://portal.example.com/path/abc123 ExternalServiceConditionResponseType: type: object properties: enabled: type: boolean example: true entities: type: array items: type: integer example: - 100 external_service_url: type: string example: https://portal.example.com/path/abc123 id: type: integer example: 100 metric: type: string example: example_string name: type: string example: example-resource-01 runbook_url: type: string example: https://portal.example.com/path/abc123 terms: type: array items: $ref: '#/components/schemas/IJKTermsType' example: - duration: example_string operator: example_string priority: example_string threshold: example_string time_function: example_string type: type: string example: standard ConditionResponse: type: object properties: condition: $ref: '#/components/schemas/ConditionResponseType' IJKTermsType: type: object properties: duration: type: string example: example_string operator: type: string example: example_string priority: type: string example: example_string threshold: type: string example: example_string time_function: type: string example: example_string SyntheticsConditionBody: type: object properties: enabled: type: boolean example: true monitor_id: type: string example: '500123' name: type: string example: example-resource-01 runbook_url: type: string example: https://portal.example.com/path/abc123 ConditionBody: type: object properties: condition_scope: type: string example: example_string enabled: type: boolean example: true entities: type: array items: type: integer example: - 100 gc_metric: type: string example: example_string metric: type: string example: example_string name: type: string example: example-resource-01 terms: type: array items: $ref: '#/components/schemas/IJKTermsType' example: - duration: example_string operator: example_string priority: example_string threshold: example_string time_function: example_string type: type: string example: standard user_defined: $ref: '#/components/schemas/UserDefinedConditionBody' violation_close_timer: type: integer example: 1718153645993 ExternalServiceConditionResponse: type: object properties: external_service_condition: $ref: '#/components/schemas/ExternalServiceConditionResponseType' ExternalServiceConditionBody: type: object properties: enabled: type: boolean example: true entities: type: array items: type: integer example: - 100 external_service_url: type: string example: https://portal.example.com/path/abc123 metric: type: string example: example_string name: type: string example: example-resource-01 runbook_url: type: string example: https://portal.example.com/path/abc123 terms: type: array items: $ref: '#/components/schemas/IJKTermsType' example: - duration: example_string operator: example_string priority: example_string threshold: example_string time_function: example_string type: type: string example: standard PolicyBody: type: object properties: incident_preference: type: string example: '500123' name: type: string example: example-resource-01 NrqlResponse: type: object properties: query: type: string example: example_string since_value: type: string example: example_string ChannelResponse: type: object properties: channel: $ref: '#/components/schemas/ChannelResponseType' Condition: type: object properties: condition: $ref: '#/components/schemas/ConditionBody' NrqlCondition: type: object properties: nrql_condition: $ref: '#/components/schemas/NrqlConditionBody' SyntheticsConditionResponse: type: object properties: synthetics_condition: $ref: '#/components/schemas/SyntheticsConditionResponseType' UserDefinedConditionBody: type: object properties: metric: type: string example: example_string value_function: type: string example: example_string ExternalServiceCondition: type: object properties: external_service_condition: $ref: '#/components/schemas/ExternalServiceConditionBody' ChannelLinksResponse: type: object properties: policy_ids: type: array items: type: integer example: - 100 PolicyResponseType: type: object properties: created_at: type: integer example: 100 id: type: integer example: 100 incident_preference: type: string example: '500123' name: type: string example: example-resource-01 updated_at: type: integer example: 100 NrqlConditionResponseType: type: object properties: enabled: type: boolean example: true expected_groups: type: integer example: 100 id: type: integer example: 100 ignore_overlap: type: boolean example: true name: type: string example: example-resource-01 nrql: $ref: '#/components/schemas/NrqlResponse' runbook_url: type: string example: https://portal.example.com/path/abc123 terms: type: array items: $ref: '#/components/schemas/IJKTermsType' example: - duration: example_string operator: example_string priority: example_string threshold: example_string time_function: example_string type: type: string example: standard value_function: type: string example: example_string Policy: type: object properties: policy: $ref: '#/components/schemas/PolicyBody' UserDefinedConditionResponse: type: object properties: metric: type: string example: example_string value_function: type: string example: example_string ConditionResponseType: type: object properties: condition_scope: type: string example: example_string enabled: type: boolean example: true entities: type: array items: type: integer example: - 100 gc_metric: type: string example: example_string id: type: integer example: 100 metric: type: string example: example_string name: type: string example: example-resource-01 runbook_url: type: string example: https://portal.example.com/path/abc123 terms: type: array items: $ref: '#/components/schemas/IJKTermsType' example: - duration: example_string operator: example_string priority: example_string threshold: example_string time_function: example_string type: type: string example: standard user_defined: $ref: '#/components/schemas/UserDefinedConditionResponse' violation_close_timer: type: integer example: 1718153645993 securitySchemes: apiKey: type: apiKey in: header name: Api-Key description: New Relic License Key or Ingest API Key externalDocs: description: New Relic Event API Documentation url: https://docs.newrelic.com/docs/data-apis/ingest-apis/event-api/introduction-event-api/