openapi: 3.1.0 info: title: New Relic Event Alerts Identifiers 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: Identifiers paths: /applications/{application_id}/deployments.json: get: tags: - Identifiers summary: New Relic Get Applications Deployments description: This API operation retrieves a paginated list of all deployment records associated with a specific application in New Relic. By making a GET request to the endpoint with a valid application ID, users can access historical deployment information including deployment timestamps, descriptions, revisions, changelogs, and the user who created each deployment record. This is useful for tracking application releases, correlating performance changes with deployments, and maintaining a comprehensive deployment history for monitoring and troubleshooting purposes. parameters: - name: application_id in: path description: Application 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: $ref: '#/components/schemas/DeploymentResponse' examples: Getapplicationsiddeployments200Example: summary: Default getApplicationsIdDeployments 200 response x-microcks-default: true value: deployment: changelog: {} description: {} id: {} links: {} revision: {} timestamp: {} user: {} application/xml: schema: $ref: '#/components/schemas/DeploymentResponse' examples: Getapplicationsiddeployments200Example: summary: Default getApplicationsIdDeployments 200 response x-microcks-default: true value: deployment: changelog: {} description: {} id: {} links: {} revision: {} timestamp: {} user: {} x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true GenerateOperationSummariesFromPath: true ChooseTags: true operationId: getApplicationsIdDeployments x-microcks-operation: delay: 0 dispatcher: FALLBACK post: tags: - Identifiers summary: New Relic Post Applications Deployments description: Creates a new deployment marker for a specified application in New Relic by sending a POST request to the /applications/{application_id}/deployments.json endpoint. This operation allows you to record deployment events, which appear as vertical lines on charts in the New Relic UI, helping teams correlate application performance changes with specific deployments. The request requires the application_id path parameter to identify the target application, and typically accepts deployment details in the request body such as revision, changelog, description, and user information. Deployment markers are useful for tracking releases, troubleshooting issues, and analyzing the impact of code changes on application performance metrics. parameters: - name: application_id in: path description: Application ID required: true schema: type: integer example: 100 requestBody: description: Deployment schema content: application/json: schema: $ref: '#/components/schemas/Deployment' examples: PostapplicationsiddeploymentsRequestExample: summary: Default postApplicationsIdDeployments request x-microcks-default: true value: deployment: changelog: example_value description: A sample description. revision: example_value user: example_value application/xml: schema: $ref: '#/components/schemas/Deployment' examples: PostapplicationsiddeploymentsRequestExample: summary: Default postApplicationsIdDeployments request x-microcks-default: true value: deployment: changelog: example_value description: A sample description. revision: example_value user: example_value required: true responses: '200': description: No response was specified content: application/json: schema: $ref: '#/components/schemas/DeploymentResponse' examples: Postapplicationsiddeployments200Example: summary: Default postApplicationsIdDeployments 200 response x-microcks-default: true value: deployment: changelog: {} description: {} id: {} links: {} revision: {} timestamp: {} user: {} application/xml: schema: $ref: '#/components/schemas/DeploymentResponse' examples: Postapplicationsiddeployments200Example: summary: Default postApplicationsIdDeployments 200 response x-microcks-default: true value: deployment: changelog: {} description: {} id: {} links: {} revision: {} timestamp: {} user: {} x-codegen-request-body-name: deployment x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true GenerateOperationSummariesFromPath: true ChooseTags: true operationId: postApplicationsIdDeployments x-microcks-operation: delay: 0 dispatcher: FALLBACK /applications/{application_id}/deployments/{id}.json: delete: tags: - Identifiers summary: New Relic Delete Applications Deployments description: This API operation allows you to delete a specific deployment record from a New Relic application by making a DELETE request to the endpoint /applications/{application_id}/deployments/{id}.json, where {application_id} is the unique identifier of the application and {id} is the specific deployment record you want to remove. This is useful for removing incorrect or outdated deployment markers from your application's deployment history in New Relic, helping maintain accurate tracking of your application's release timeline and deployment events. parameters: - name: application_id in: path description: Application ID required: true schema: type: integer example: 100 - name: id in: path description: Deployment ID required: true schema: type: integer example: 100 responses: '200': description: No response was specified content: application/json: schema: $ref: '#/components/schemas/DeploymentResponse' examples: Deleteapplicationsiddeploymentsid200Example: summary: Default deleteApplicationsIdDeploymentsId 200 response x-microcks-default: true value: deployment: changelog: {} description: {} id: {} links: {} revision: {} timestamp: {} user: {} application/xml: schema: $ref: '#/components/schemas/DeploymentResponse' examples: Deleteapplicationsiddeploymentsid200Example: summary: Default deleteApplicationsIdDeploymentsId 200 response x-microcks-default: true value: deployment: changelog: {} description: {} id: {} links: {} revision: {} timestamp: {} user: {} x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true GenerateOperationSummariesFromPath: true ChooseTags: true operationId: deleteApplicationsIdDeploymentsId x-microcks-operation: delay: 0 dispatcher: FALLBACK /applications/{application_id}/hosts.json: get: tags: - Identifiers summary: New Relic Get Applications Hosts description: This API operation retrieves a paginated list of hosts associated with a specific application in New Relic. By making a GET request to the endpoint with a valid application ID, users can obtain information about all hosts running the specified application, including host details and performance metrics. The response is returned in JSON format and includes host identifiers, names, health status, and other relevant metadata that helps monitor application infrastructure across different servers or containers. parameters: - name: application_id in: path description: Application ID required: true schema: type: integer example: 100 - name: filter[hostname] in: query description: Filter by server hostname schema: type: string example: web01.example.com - name: filter[ids] in: query description: Filter by application host ids style: form explode: false schema: type: array items: type: string example: - '500123' - 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/ApplicationHostResponse' examples: Getapplicationsidhosts200Example: summary: Default getApplicationsIdHosts 200 response x-microcks-default: true value: application_hosts: &id001 - host: example_string application_name: example_string application_summary: {} end_user_summary: {} health_status: active id: 100 language: 100 links: {} application/xml: schema: $ref: '#/components/schemas/ApplicationHostResponse' examples: Getapplicationsidhosts200Example: summary: Default getApplicationsIdHosts 200 response x-microcks-default: true value: application_hosts: *id001 x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true GenerateOperationSummariesFromPath: true ChooseTags: true operationId: getApplicationsIdHosts x-microcks-operation: delay: 0 dispatcher: FALLBACK /applications/{application_id}/hosts/{host_id}/metrics.json: get: tags: - Identifiers summary: New Relic Get Applications Hosts Host Metrics description: This API operation retrieves a list of metric names associated with a specific host within a given application in New Relic's Application Performance Monitoring (APM) system. By providing both an application ID and a host in the endpoint path, users can query the available metrics that New Relic is collecting for that particular host instance. The response returns metric name data in JSON format, which typically includes identifiers and metadata for various performance measurements such as CPU usage, memory consumption, throughput, response times, and other application-specific metrics. This endpoint is particularly useful for developers and operations teams who need to discover what metrics are available before constructing more detailed queries or building monitoring dashboards, allowing them to programmatically explore the monitoring data structure for their infrastructure. parameters: - name: application_id in: path description: Application ID required: true schema: type: integer example: 100 - name: host_id in: path description: Application Host ID required: true schema: type: integer example: 100 - name: name in: query description: Filter metrics by name schema: type: string example: example-resource-01 - name: page in: query description: Pagination index (will be deprecated) schema: type: integer example: 100 - name: cursor in: query description: Cursor for next page (replacing page param) schema: type: string example: example_string 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/MetricListResponse' examples: Getapplicationsidhostshostidmetrics200Example: summary: Default getApplicationsIdHostsHostIdMetrics 200 response x-microcks-default: true value: metrics: &id002 - name: example-resource-01 values: - {} application/xml: schema: $ref: '#/components/schemas/MetricListResponse' examples: Getapplicationsidhostshostidmetrics200Example: summary: Default getApplicationsIdHostsHostIdMetrics 200 response x-microcks-default: true value: metrics: *id002 x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true GenerateOperationSummariesFromPath: true ChooseTags: true operationId: getApplicationsIdHostsHostIdMetrics x-microcks-operation: delay: 0 dispatcher: FALLBACK /applications/{application_id}/hosts/{host_id}/metrics/data.json: get: tags: - Identifiers summary: New Relic Get Applications Hosts Host Metrics Data description: This API operation retrieves metric data for a specific host associated with a particular application in New Relic. By making a GET request to the endpoint with the application and host as path parameters, users can access detailed performance metrics and monitoring data for that specific host instance. The operation returns data in JSON format, which typically includes time-series metric values such as response times, throughput, error rates, and other performance indicators collected by New Relic's monitoring agents. Additional query parameters can be used to filter the metrics by name, specify time ranges, set data summarization options, and control the granularity of the returned data, making it useful for building custom dashboards, generating reports, or integrating New Relic monitoring data into external systems and workflows. parameters: - name: application_id in: path description: Application ID required: true schema: type: integer example: 100 - name: host_id in: path description: Application Host ID required: true schema: type: integer example: 100 - name: names in: query description: Retrieve specific metrics by name required: true style: form explode: false schema: type: array items: type: string example: - example_string - name: values in: query description: Retrieve specific metric values style: form explode: false schema: type: array items: type: string example: - example_string - name: from in: query description: Retrieve metrics after this time schema: type: string format: date-time example: '2026-04-18T14:30:00Z' - name: to in: query description: Retrieve metrics before this time schema: type: string format: date-time example: '2026-04-18T14:30:00Z' - name: period in: query description: Period of timeslices in seconds schema: type: integer example: 100 - name: summarize in: query description: Summarize the data schema: type: boolean example: true - name: raw in: query description: Return unformatted raw values schema: type: boolean example: true responses: '200': description: No response was specified content: application/json: schema: $ref: '#/components/schemas/MetricDataResponse' examples: Getapplicationsidhostshostidmetricsdata200Example: summary: Default getApplicationsIdHostsHostIdMetricsData 200 response x-microcks-default: true value: metric_data: from: {} metrics: {} metrics_found: {} metrics_not_found: {} to: {} application/xml: schema: $ref: '#/components/schemas/MetricDataResponse' examples: Getapplicationsidhostshostidmetricsdata200Example: summary: Default getApplicationsIdHostsHostIdMetricsData 200 response x-microcks-default: true value: metric_data: from: {} metrics: {} metrics_found: {} metrics_not_found: {} to: {} x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true GenerateOperationSummariesFromPath: true ChooseTags: true operationId: getApplicationsIdHostsHostIdMetricsData x-microcks-operation: delay: 0 dispatcher: FALLBACK /applications/{application_id}/hosts/{id}.json: get: tags: - Identifiers summary: New Relic Get Applications Hosts description: This API operation retrieves detailed information about a specific host associated with a particular application in New Relic's APM monitoring system. By providing both an application and a host in the endpoint path, it returns comprehensive data about that host's performance metrics, system specifications, and current status within the context of the specified application. The GET request returns a JSON response containing host-level details such as hostname, health status, response times, throughput, error rates, and other relevant monitoring data that helps developers and operations teams understand how a specific server or container is performing while running the monitored application. parameters: - name: application_id in: path description: Application ID required: true schema: type: integer example: 100 - name: id in: path description: Application host ID required: true schema: type: integer example: 100 responses: '200': description: No response was specified content: application/json: schema: $ref: '#/components/schemas/ApplicationHostResponse' examples: Getapplicationsidhostsid200Example: summary: Default getApplicationsIdHostsId 200 response x-microcks-default: true value: application_hosts: &id003 - host: example_string application_name: example_string application_summary: {} end_user_summary: {} health_status: active id: 100 language: 100 links: {} application/xml: schema: $ref: '#/components/schemas/ApplicationHostResponse' examples: Getapplicationsidhostsid200Example: summary: Default getApplicationsIdHostsId 200 response x-microcks-default: true value: application_hosts: *id003 x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true WriteDescription: true GenerateOperationSummariesFromPath: true ChooseTags: true operationId: getApplicationsIdHostsId x-microcks-operation: delay: 0 dispatcher: FALLBACK /applications/{application_id}/instances.json: get: tags: - Identifiers summary: New Relic Get Applications Instances description: '
This API endpoint returns a paginated list of instances associated with the given application. The time range for summary data is the last 3-4 minutes.
Application instances can be filtered by hostname, or the list of application instance IDs.
See our documentation for a discussion and examples of using filters and summary data output.
' parameters: - name: application_id in: path description: Application ID required: true schema: type: integer example: 100 - name: filter[hostname] in: query description: Filter by server hostname schema: type: string example: web01.example.com - name: filter[ids] in: query description: Filter by application instance ids style: form explode: false schema: type: array items: type: string example: - '500123' - 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/ApplicationInstanceResponse' examples: Getapplicationsidinstances200Example: summary: Default getApplicationsIdInstances 200 response x-microcks-default: true value: application_instance: host: {} application_name: {} application_summary: {} end_user_summary: {} health_status: {} id: {} language: {} links: {} port: {} application/xml: schema: $ref: '#/components/schemas/ApplicationInstanceResponse' examples: Getapplicationsidinstances200Example: summary: Default getApplicationsIdInstances 200 response x-microcks-default: true value: application_instance: host: {} application_name: {} application_summary: {} end_user_summary: {} health_status: {} id: {} language: {} links: {} port: {} x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true GenerateOperationSummariesFromPath: true ChooseTags: true operationId: getApplicationsIdInstances x-microcks-operation: delay: 0 dispatcher: FALLBACK /applications/{application_id}/instances/{id}.json: get: tags: - Identifiers summary: New Relic Get Applications Instances description: "This API endpoint returns a single application instance, identified by ID. The time range for summary data is the last 3-4 minutes.
\n\nSee our documentation for a discussion of\n summary data output.
\n\n" parameters: - name: application_id in: path description: Application ID required: true schema: type: integer example: 100 - name: id in: path description: Application instance ID required: true schema: type: integer example: 100 responses: '200': description: No response was specified content: application/json: schema: $ref: '#/components/schemas/ApplicationInstanceResponse' examples: Getapplicationsidinstancesid200Example: summary: Default getApplicationsIdInstancesId 200 response x-microcks-default: true value: application_instance: host: {} application_name: {} application_summary: {} end_user_summary: {} health_status: {} id: {} language: {} links: {} port: {} application/xml: schema: $ref: '#/components/schemas/ApplicationInstanceResponse' examples: Getapplicationsidinstancesid200Example: summary: Default getApplicationsIdInstancesId 200 response x-microcks-default: true value: application_instance: host: {} application_name: {} application_summary: {} end_user_summary: {} health_status: {} id: {} language: {} links: {} port: {} x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true GenerateOperationSummariesFromPath: true ChooseTags: true operationId: getApplicationsIdInstancesId x-microcks-operation: delay: 0 dispatcher: FALLBACK /applications/{application_id}/instances/{instance_id}/metrics.json: get: tags: - Identifiers summary: New Relic Get Applications Instances Instance Metrics description: 'Return a list of known metrics and their value names for the given resource.
See our documentation for a discussion on output pagination and for examples of requesting and using metric values.
' parameters: - name: application_id in: path description: Application ID required: true schema: type: integer example: 100 - name: instance_id in: path description: Application Instance ID required: true schema: type: integer example: 100 - name: name in: query description: Filter metrics by name schema: type: string example: example-resource-01 - name: page in: query description: Pagination index (will be deprecated) schema: type: integer example: 100 - name: cursor in: query description: Cursor for next page (replacing page param) schema: type: string example: example_string 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/MetricParserResponse' examples: Getapplicationsidinstancesinstanceidmetrics200Example: summary: Default getApplicationsIdInstancesInstanceIdMetrics 200 response x-microcks-default: true value: metric: name: {} values: {} application/xml: schema: $ref: '#/components/schemas/MetricParserResponse' examples: Getapplicationsidinstancesinstanceidmetrics200Example: summary: Default getApplicationsIdInstancesInstanceIdMetrics 200 response x-microcks-default: true value: metric: name: {} values: {} x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true GenerateOperationSummariesFromPath: true ChooseTags: true operationId: getApplicationsIdInstancesInstanceIdMetrics x-microcks-operation: delay: 0 dispatcher: FALLBACK /applications/{application_id}/instances/{instance_id}/metrics/data.json: get: tags: - Identifiers summary: New Relic Get Applications Instances Instance Metrics Data description: 'This API endpoint returns a list of values for each of the requested metrics. The list of available metrics can be returned using the Metric Name API endpoint.
Metric data can be filtered by a number of parameters, including multiple names and values, and by time range. Metric names and values will be matched intelligently in the background.
You can also retrieve a summarized data point across the entire time range selected by using the summarize parameter.
See our documentation for a discussion on output pagination, time range related considerations, and for examples of requesting and using metric values.
' parameters: - name: application_id in: path description: Application ID required: true schema: type: integer example: 100 - name: instance_id in: path description: Application Instance ID required: true schema: type: integer example: 100 - name: names in: query description: Retrieve specific metrics by name required: true style: form explode: false schema: type: array items: type: string example: - example_string - name: values in: query description: Retrieve specific metric values style: form explode: false schema: type: array items: type: string example: - example_string - name: from in: query description: Retrieve metrics after this time schema: type: string format: date-time example: '2026-04-18T14:30:00Z' - name: to in: query description: Retrieve metrics before this time schema: type: string format: date-time example: '2026-04-18T14:30:00Z' - name: period in: query description: Period of timeslices in seconds schema: type: integer example: 100 - name: summarize in: query description: Summarize the data schema: type: boolean example: true - name: raw in: query description: Return unformatted raw values schema: type: boolean example: true responses: '200': description: No response was specified content: application/json: schema: $ref: '#/components/schemas/MetricDataResponse' examples: Getapplicationsidinstancesinstanceidmetricsdata200Example: summary: Default getApplicationsIdInstancesInstanceIdMetricsData 200 response x-microcks-default: true value: metric_data: from: {} metrics: {} metrics_found: {} metrics_not_found: {} to: {} application/xml: schema: $ref: '#/components/schemas/MetricDataResponse' examples: Getapplicationsidinstancesinstanceidmetricsdata200Example: summary: Default getApplicationsIdInstancesInstanceIdMetricsData 200 response x-microcks-default: true value: metric_data: from: {} metrics: {} metrics_found: {} metrics_not_found: {} to: {} x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true GenerateOperationSummariesFromPath: true ChooseTags: true operationId: getApplicationsIdInstancesInstanceIdMetricsData x-microcks-operation: delay: 0 dispatcher: FALLBACK /applications/{application_id}/metrics.json: get: tags: - Identifiers summary: New Relic Get Applications Metrics description: 'Return a list of known metrics and their value names for the given resource.
See our documentation for a discussion on output pagination and for examples of requesting and using metric values.
' parameters: - name: application_id in: path description: Application ID required: true schema: type: integer example: 100 - name: name in: query description: Filter metrics by name schema: type: string example: example-resource-01 - name: page in: query description: Pagination index (will be deprecated) schema: type: integer example: 100 - name: cursor in: query description: Cursor for next page (replacing page param) schema: type: string example: example_string 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/MetricParserResponse' examples: Getapplicationsidmetrics200Example: summary: Default getApplicationsIdMetrics 200 response x-microcks-default: true value: metric: name: {} values: {} application/xml: schema: $ref: '#/components/schemas/MetricParserResponse' examples: Getapplicationsidmetrics200Example: summary: Default getApplicationsIdMetrics 200 response x-microcks-default: true value: metric: name: {} values: {} x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true GenerateOperationSummariesFromPath: true ChooseTags: true operationId: getApplicationsIdMetrics x-microcks-operation: delay: 0 dispatcher: FALLBACK /applications/{application_id}/metrics/data.json: get: tags: - Identifiers summary: New Relic Get Applications Metrics Data description: 'This API endpoint returns a list of values for each of the requested metrics. The list of available metrics can be returned using the Metric Name API endpoint.
Metric data can be filtered by a number of parameters, including multiple names and values, and by time range. Metric names and values will be matched intelligently in the background.
You can also retrieve a summarized data point across the entire time range selected by using the summarize parameter.
See our documentation for a discussion on output pagination, time range related considerations, and for examples of requesting and using metric values.
' parameters: - name: application_id in: path description: Application ID required: true schema: type: integer example: 100 - name: names in: query description: Retrieve specific metrics by name required: true style: form explode: false schema: type: array items: type: string example: - example_string - name: values in: query description: Retrieve specific metric values style: form explode: false schema: type: array items: type: string example: - example_string - name: from in: query description: Retrieve metrics after this time schema: type: string format: date-time example: '2026-04-18T14:30:00Z' - name: to in: query description: Retrieve metrics before this time schema: type: string format: date-time example: '2026-04-18T14:30:00Z' - name: period in: query description: Period of timeslices in seconds schema: type: integer example: 100 - name: summarize in: query description: Summarize the data schema: type: boolean example: true - name: raw in: query description: Return unformatted raw values schema: type: boolean example: true responses: '200': description: No response was specified content: application/json: schema: $ref: '#/components/schemas/MetricDataResponse' examples: Getapplicationsidmetricsdata200Example: summary: Default getApplicationsIdMetricsData 200 response x-microcks-default: true value: metric_data: from: {} metrics: {} metrics_found: {} metrics_not_found: {} to: {} application/xml: schema: $ref: '#/components/schemas/MetricDataResponse' examples: Getapplicationsidmetricsdata200Example: summary: Default getApplicationsIdMetricsData 200 response x-microcks-default: true value: metric_data: from: {} metrics: {} metrics_found: {} metrics_not_found: {} to: {} x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true GenerateOperationSummariesFromPath: true ChooseTags: true operationId: getApplicationsIdMetricsData x-microcks-operation: delay: 0 dispatcher: FALLBACK /applications/{id}.json: get: tags: - Identifiers summary: New Relic Get Applications description: 'This API endpoint returns a single Application, identified by ID. The time range for summary data is the last 3-4 minutes.
See our documentation for a discussion of the summary data output.
' parameters: - name: id in: path description: Application ID required: true schema: type: integer example: 100 responses: '200': description: No response was specified content: application/json: schema: $ref: '#/components/schemas/ApplicationResponse' examples: Getapplicationsid200Example: summary: Default getApplicationsId 200 response x-microcks-default: true value: application: application_summary: {} end_user_summary: {} health_status: {} id: {} language: {} last_reported_at: {} links: {} name: {} reporting: {} settings: {} application/xml: schema: $ref: '#/components/schemas/ApplicationResponse' examples: Getapplicationsid200Example: summary: Default getApplicationsId 200 response x-microcks-default: true value: application: application_summary: {} end_user_summary: {} health_status: {} id: {} language: {} last_reported_at: {} links: {} name: {} reporting: {} settings: {} x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true GenerateOperationSummariesFromPath: true ChooseTags: true operationId: getApplicationsId x-microcks-operation: delay: 0 dispatcher: FALLBACK put: tags: - Identifiers summary: New Relic Put Applications description: 'This API endpoint allows you to update certain parameters of your application.
The input is expected to be in JSON or XML format in the body parameter of the PUT request. The exact schema is defined below. Any extra parameters passed in the body will be ignored.
See our documentation for a discussion and simple example of updating an application.
' parameters: - name: id in: path description: Application ID required: true schema: type: integer example: 100 requestBody: description: Application schema content: application/json: schema: $ref: '#/components/schemas/Application' examples: PutapplicationsidRequestExample: summary: Default putApplicationsId request x-microcks-default: true value: application: name: Example Title application/xml: schema: $ref: '#/components/schemas/Application' examples: PutapplicationsidRequestExample: summary: Default putApplicationsId request x-microcks-default: true value: application: name: Example Title required: true responses: '200': description: No response was specified content: application/json: schema: $ref: '#/components/schemas/ApplicationResponse' examples: Putapplicationsid200Example: summary: Default putApplicationsId 200 response x-microcks-default: true value: application: application_summary: {} end_user_summary: {} health_status: {} id: {} language: {} last_reported_at: {} links: {} name: {} reporting: {} settings: {} application/xml: schema: $ref: '#/components/schemas/ApplicationResponse' examples: Putapplicationsid200Example: summary: Default putApplicationsId 200 response x-microcks-default: true value: application: application_summary: {} end_user_summary: {} health_status: {} id: {} language: {} last_reported_at: {} links: {} name: {} reporting: {} settings: {} x-codegen-request-body-name: application x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true GenerateOperationSummariesFromPath: true ChooseTags: true operationId: putApplicationsId x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: tags: - Identifiers summary: New Relic Delete Applications description: 'This API endpoint deletes an application and all of its reported data.
WARNING: Only applications that have stopped reporting can be deleted. This is an irreversible process which will delete all reported data for this application.
' parameters: - name: id in: path description: Application ID required: true schema: type: integer example: 100 responses: '200': description: No response was specified content: application/json: schema: $ref: '#/components/schemas/ApplicationResponse' examples: Deleteapplicationsid200Example: summary: Default deleteApplicationsId 200 response x-microcks-default: true value: application: application_summary: {} end_user_summary: {} health_status: {} id: {} language: {} last_reported_at: {} links: {} name: {} reporting: {} settings: {} application/xml: schema: $ref: '#/components/schemas/ApplicationResponse' examples: Deleteapplicationsid200Example: summary: Default deleteApplicationsId 200 response x-microcks-default: true value: application: application_summary: {} end_user_summary: {} health_status: {} id: {} language: {} last_reported_at: {} links: {} name: {} reporting: {} settings: {} x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true GenerateOperationSummariesFromPath: true ChooseTags: true operationId: deleteApplicationsId x-microcks-operation: delay: 0 dispatcher: FALLBACK /key_transactions/{id}.json: get: tags: - Identifiers summary: New Relic Get Key Transactions description: 'This endpoint returns a single key transaction, identified by ID. The time range for summary data is the last 10 minutes.
See our documentation for a discussion of summary data output.
' parameters: - name: id in: path description: Key transaction ID required: true schema: type: integer example: 100 responses: '200': description: No response was specified content: application/json: schema: $ref: '#/components/schemas/KeyTransactionResponse' examples: Getkeytransactionsid200Example: summary: Default getKeyTransactionsId 200 response x-microcks-default: true value: key_transaction: application_summary: {} end_user_summary: {} health_status: {} id: {} last_reported_at: {} links: {} name: {} reporting: {} transaction_name: {} application/xml: schema: $ref: '#/components/schemas/KeyTransactionResponse' examples: Getkeytransactionsid200Example: summary: Default getKeyTransactionsId 200 response x-microcks-default: true value: key_transaction: application_summary: {} end_user_summary: {} health_status: {} id: {} last_reported_at: {} links: {} name: {} reporting: {} transaction_name: {} x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true GenerateOperationSummariesFromPath: true ChooseTags: true operationId: getKeyTransactionsId x-microcks-operation: delay: 0 dispatcher: FALLBACK /mobile_applications/{id}.json: get: tags: - Identifiers summary: New Relic Get Mobile Applications description: 'This API endpoint returns a single Mobile Application, identified by ID. The time range for summary data is the last 30 minutes.
' parameters: - name: id in: path description: Mobile Application ID required: true schema: type: integer example: 100 responses: '200': description: No response was specified content: application/json: schema: $ref: '#/components/schemas/MobileApplicationResponse' examples: Getmobileapplicationsid200Example: summary: Default getMobileApplicationsId 200 response x-microcks-default: true value: application: crash_summary: {} health_status: {} id: {} mobile_summary: {} name: {} reporting: {} application/xml: schema: $ref: '#/components/schemas/MobileApplicationResponse' examples: Getmobileapplicationsid200Example: summary: Default getMobileApplicationsId 200 response x-microcks-default: true value: application: crash_summary: {} health_status: {} id: {} mobile_summary: {} name: {} reporting: {} x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true GenerateOperationSummariesFromPath: true ChooseTags: true operationId: getMobileApplicationsId x-microcks-operation: delay: 0 dispatcher: FALLBACK /mobile_applications/{mobile_application_id}/metrics.json: get: tags: - Identifiers summary: New Relic Get Mobile Applications Mobile Application Metrics description: 'Return a list of known metrics and their value names for the given resource.
See our documentation for a discussion on output pagination and for examples of requesting and using metric values.
' parameters: - name: mobile_application_id in: path description: Mobile application ID required: true schema: type: integer example: 100 - name: name in: query description: Filter metrics by name schema: type: string example: example-resource-01 - name: page in: query description: Pagination index (will be deprecated) schema: type: integer example: 100 - name: cursor in: query description: Cursor for next page (replacing page param) schema: type: string example: example_string 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/MetricParserResponse' examples: Getmobileapplicationsmobileapplicationidmetrics200Example: summary: Default getMobileApplicationsMobileApplicationIdMetrics 200 response x-microcks-default: true value: metric: name: {} values: {} application/xml: schema: $ref: '#/components/schemas/MetricParserResponse' examples: Getmobileapplicationsmobileapplicationidmetrics200Example: summary: Default getMobileApplicationsMobileApplicationIdMetrics 200 response x-microcks-default: true value: metric: name: {} values: {} x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true GenerateOperationSummariesFromPath: true ChooseTags: true operationId: getMobileApplicationsMobileApplicationIdMetrics x-microcks-operation: delay: 0 dispatcher: FALLBACK /mobile_applications/{mobile_application_id}/metrics/data.json: get: tags: - Identifiers summary: New Relic Get Mobile Applications Mobile Application Metrics Data description: 'This API endpoint returns a list of values for each of the requested metrics. The list of available metrics can be returned using the Metric Name API endpoint.
Metric data can be filtered by a number of parameters, including multiple names and values, and by time range. Metric names and values will be matched intelligently in the background.
You can also retrieve a summarized data point across the entire time range selected by using the summarize parameter.
See our documentation for a discussion on output pagination, time range related considerations, and for examples of requesting and using metric values.
' parameters: - name: mobile_application_id in: path description: Mobile application ID required: true schema: type: integer example: 100 - name: names in: query description: Retrieve specific metrics by name required: true style: form explode: false schema: type: array items: type: string example: - example_string - name: values in: query description: Retrieve specific metric values style: form explode: false schema: type: array items: type: string example: - example_string - name: from in: query description: Retrieve metrics after this time schema: type: string format: date-time example: '2026-04-18T14:30:00Z' - name: to in: query description: Retrieve metrics before this time schema: type: string format: date-time example: '2026-04-18T14:30:00Z' - name: period in: query description: Period of timeslices in seconds schema: type: integer example: 100 - name: summarize in: query description: Summarize the data schema: type: boolean example: true - name: raw in: query description: Return unformatted raw values schema: type: boolean example: true responses: '200': description: No response was specified content: application/json: schema: $ref: '#/components/schemas/MetricDataResponse' examples: Getmobileapplicationsmobileapplicationidmetricsdata200Example: summary: Default getMobileApplicationsMobileApplicationIdMetricsData 200 response x-microcks-default: true value: metric_data: from: {} metrics: {} metrics_found: {} metrics_not_found: {} to: {} application/xml: schema: $ref: '#/components/schemas/MetricDataResponse' examples: Getmobileapplicationsmobileapplicationidmetricsdata200Example: summary: Default getMobileApplicationsMobileApplicationIdMetricsData 200 response x-microcks-default: true value: metric_data: from: {} metrics: {} metrics_found: {} metrics_not_found: {} to: {} x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true GenerateOperationSummariesFromPath: true ChooseTags: true operationId: getMobileApplicationsMobileApplicationIdMetricsData x-microcks-operation: delay: 0 dispatcher: FALLBACK /alerts_channels/{channel_id}.json: delete: tags: - Identifiers summary: New Relic Delete Alerts Channels Channel 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 notification channels.
Note: User notification channels cannot be deleted.
Note: Admin User’s API Key is required.
See our documentation for a discussion on deleting notification channels.
' parameters: - name: channel_id in: path 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: Deletealertschannelschannelid200Example: summary: Default deleteAlertsChannelsChannelId 200 response x-microcks-default: true value: channel: configuration: {} id: {} links: {} name: {} type: {} application/xml: schema: $ref: '#/components/schemas/ChannelResponse' examples: Deletealertschannelschannelid200Example: summary: Default deleteAlertsChannelsChannelId 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: deleteAlertsChannelsChannelId x-microcks-operation: delay: 0 dispatcher: FALLBACK /alerts_conditions/policies/{policy_id}.json: post: tags: - Identifiers summary: New Relic Post Alerts Conditions Policies description: "🔥🔥 New users should use these docs about managing alerts via NerdGraph.\n\nThis API endpoint allows you to create APM Application and Key Transaction, Browser and Mobile application metric conditions for your alert policies.
\n\nConditions for web transaction percentiles, or conditions targeting labels (dynamic targeting), are not available.
\n\nNote: Admin User’s API Key is required.
\n\nSee our documentation for a discussion on creating conditions for policies.\n
All fields are required except for “runbook_urlâ€\x9D, “enabledâ€\x9D (defaults to false), “user_definedâ€\x9D.
\n\ntype: apm_app_metric, apm_kt_metric, servers_metric, browser_metric, mobile_metric.
\n\nname: A title for your condition.
\n\nenabled: The status of your condition (optional).
\n\nentities: An array of instances associated with your condition.
\n\nmetric: 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\ncondition_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.
\n\nrunbook_url: Runbook URL to display in notifications (optional).
\n\nterms[duration] (in minutes): 5, 10, 15, 30, 60, 120.
\n\nterms[operator]: above, below, equal.
\n\nterms[priority]: critical, warning.
\n\nterms[threshold]: Must be 0 or greater.
\n\nterms[time_function]: all, any.
\n\nuser_defined[metric]: A custom metric to be evaluated.
\n\nuser_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_conditions/{condition_id}.json: put: tags: - Identifiers summary: New Relic Put Alerts Conditions description: '🔥🔥 New users should use these docs about managing alerts via NerdGraph.This API endpoint allows you to update 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 Alerts Conditions > Create for an explanation of the field values or the online documentation on updating conditions for policies.
' parameters: - name: condition_id in: path description: Alerts condition to update required: true schema: type: integer example: 100 requestBody: description: Condition schema content: application/json: schema: $ref: '#/components/schemas/Condition' examples: PutalertsconditionsconditionidRequestExample: summary: Default putAlertsConditionsConditionId 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: PutalertsconditionsconditionidRequestExample: summary: Default putAlertsConditionsConditionId 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: Putalertsconditionsconditionid200Example: summary: Default putAlertsConditionsConditionId 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: Putalertsconditionsconditionid200Example: summary: Default putAlertsConditionsConditionId 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: putAlertsConditionsConditionId x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: tags: - Identifiers summary: New Relic Delete Alerts Conditions description: '🔥🔥 New users should use these docs about managing alerts via NerdGraph.This API endpoint allows you to delete 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 deleting conditions.
' parameters: - name: condition_id in: path description: Alerts condition ID required: true schema: type: integer example: 100 responses: '200': description: No response was specified content: application/json: schema: $ref: '#/components/schemas/ConditionResponse' examples: Deletealertsconditionsconditionid200Example: summary: Default deleteAlertsConditionsConditionId 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: Deletealertsconditionsconditionid200Example: summary: Default deleteAlertsConditionsConditionId 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-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true GenerateOperationSummariesFromPath: true ChooseTags: true operationId: deleteAlertsConditionsConditionId x-microcks-operation: delay: 0 dispatcher: FALLBACK /alerts_entity_conditions/{entity_id}.json: get: tags: - Identifiers summary: New Relic Get Alerts Entity Conditions Entity description: '🔥🔥 New users should use NRQL Alert Conditions, refer to these docs about managing alerts via NerdGraph.This API endpoint allows you to list the Alerts conditions an entity is part of.
Entity type options (Synthetics is not yet supported):
BrowserApplication
Application
MobileApplication
Server
KeyTransaction
'
parameters:
- name: entity_id
in: path
description: Entity ID
required: true
schema:
type: integer
example: 100
- name: entity_type
in: query
description: Entity Type
required: true
schema:
type: string
example: standard
responses:
'200':
description: No response was specified
content:
application/json:
schema:
$ref: '#/components/schemas/ConditionResponse'
examples:
Getalertsentityconditionsentityid200Example:
summary: Default getAlertsEntityConditionsEntityId 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:
Getalertsentityconditionsentityid200Example:
summary: Default getAlertsEntityConditionsEntityId 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-api-evangelist-processing:
PascalCaseOperationSummaries: true
CaselCaseOperationIds: true
GenerateOperationSummariesFromPath: true
ChooseTags: true
operationId: getAlertsEntityConditionsEntityId
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
put:
tags:
- Identifiers
summary: New Relic Put Alerts Entity Conditions Entity
description: "🔥🔥 New users should use NRQL Alert Conditions, refer to these docs about managing alerts via NerdGraph.\n\nThis API endpoint allows you to add an entity to a specified Alerts condition.
\n\nNote: Admin User’s API Key is required.\n
\n Entity type options (Synthetics is not yet supported):
BrowserApplication\n\nApplication\n\nMobileApplication\n\nServer\n\nKeyTransaction\n\n"
parameters:
- name: entity_id
in: path
description: Entity to add
required: true
schema:
type: integer
example: 100
- name: entity_type
in: query
description: Entity Type
required: true
schema:
type: string
example: standard
- name: condition_id
in: query
description: Alerts condition ID
required: true
schema:
type: integer
example: 100
responses:
'200':
description: No response was specified
content:
application/json:
schema:
$ref: '#/components/schemas/ConditionResponse'
examples:
Putalertsentityconditionsentityid200Example:
summary: Default putAlertsEntityConditionsEntityId 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:
Putalertsentityconditionsentityid200Example:
summary: Default putAlertsEntityConditionsEntityId 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-api-evangelist-processing:
PascalCaseOperationSummaries: true
CaselCaseOperationIds: true
GenerateOperationSummariesFromPath: true
ChooseTags: true
operationId: putAlertsEntityConditionsEntityId
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
delete:
tags:
- Identifiers
summary: New Relic Delete Alerts Entity Conditions Entity
description: '🔥🔥 New users should use NRQL Alert Conditions, refer to these docs about managing alerts via NerdGraph.
This API endpoint allows you to disassociate an entity with a specified Alerts condition.
Note: Admin User’s API Key is required.
Entity type options (Synthetics is not yet supported):
BrowserApplication
Application
MobileApplication
Server
KeyTransaction
'
parameters:
- name: entity_id
in: path
description: Entity to remove
required: true
schema:
type: integer
example: 100
- name: entity_type
in: query
description: Entity Type
required: true
schema:
type: string
example: standard
- name: condition_id
in: query
description: Alerts condition ID
required: true
schema:
type: integer
example: 100
responses:
'200':
description: No response was specified
content:
application/json:
schema:
$ref: '#/components/schemas/ConditionResponse'
examples:
Deletealertsentityconditionsentityid200Example:
summary: Default deleteAlertsEntityConditionsEntityId 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:
Deletealertsentityconditionsentityid200Example:
summary: Default deleteAlertsEntityConditionsEntityId 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-api-evangelist-processing:
PascalCaseOperationSummaries: true
CaselCaseOperationIds: true
GenerateOperationSummariesFromPath: true
ChooseTags: true
operationId: deleteAlertsEntityConditionsEntityId
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/alerts_external_service_conditions/policies/{policy_id}.json:
post:
tags:
- Identifiers
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\nThis API endpoint allows you to create external service conditions for your alert policies.
\n\nNote: Admin User’s API Key is required.
\n\nSee our documentation for a discussion on creating conditions for external services.
\n\nAll fields are required except for “runbook_urlâ€\x9D, “enabledâ€\x9D (defaults to false).
\n\ntype: apm_external_service, mobile_external_service.
\n\nname: A title for your condition.
\n\nenabled: The status of your condition (optional).
\n\nentities: An array of instance IDs associated with your condition.
\n\nexternal_service_url: The URL of the external service. Must not include protocol (“example.comâ€\x9D, not “https://example.comâ€\x9D)
\n\nmetric: 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\nrunbook_url: Runbook URL to display in notifications (optional).
\n\nterms[duration] (in minutes): 5, 10, 15, 30, 60, 120.
\n\nterms[operator]: above, below, equal.
\n\nterms[priority]: critical, warning.
\n\nterms[threshold]: Must be 0 or greater.
\n\nterms[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_external_service_conditions/{condition_id}.json: put: tags: - Identifiers summary: New Relic Put Alerts External Service Conditions description: '🔥🔥 New users should use NRQL Alert Conditions, refer to these docs about managing alerts via NerdGraph.This API endpoint allows you to update external service conditions for your alert policies.
Note: Admin User’s API Key is required.
See Alerts External Service Conditions > Create for an explanation of the field values used in this command or the online documentation on updating conditions for external services.
' parameters: - name: condition_id in: path description: Alerts condition to update required: true schema: type: integer example: 100 requestBody: description: Condition schema content: application/json: schema: $ref: '#/components/schemas/ExternalServiceCondition' examples: PutalertsexternalserviceconditionsconditionidRequestExample: summary: Default putAlertsExternalServiceConditionsConditionId 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: PutalertsexternalserviceconditionsconditionidRequestExample: summary: Default putAlertsExternalServiceConditionsConditionId 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: Putalertsexternalserviceconditionsconditionid200Example: summary: Default putAlertsExternalServiceConditionsConditionId 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: Putalertsexternalserviceconditionsconditionid200Example: summary: Default putAlertsExternalServiceConditionsConditionId 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: putAlertsExternalServiceConditionsConditionId x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: tags: - Identifiers summary: New Relic Delete Alerts External Service Conditions description: '🔥🔥 New users should use NRQL Alert Conditions, refer to these docs about managing alerts via NerdGraph.This API endpoint allows you to delete external service conditions associated with your alert policy.
Note: Admin User’s API Key is required.
See our documentation for a discussion on deleting External services conditions.
' parameters: - name: condition_id in: path description: Alerts condition ID required: true schema: type: integer example: 100 responses: '200': description: No response was specified content: application/json: schema: $ref: '#/components/schemas/ExternalServiceConditionResponse' examples: Deletealertsexternalserviceconditionsconditionid200Example: summary: Default deleteAlertsExternalServiceConditionsConditionId 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: Deletealertsexternalserviceconditionsconditionid200Example: summary: Default deleteAlertsExternalServiceConditionsConditionId 200 response x-microcks-default: true value: external_service_condition: enabled: {} entities: {} external_service_url: {} id: {} metric: {} name: {} runbook_url: {} terms: {} type: {} x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true GenerateOperationSummariesFromPath: true ChooseTags: true operationId: deleteAlertsExternalServiceConditionsConditionId x-microcks-operation: delay: 0 dispatcher: FALLBACK /alerts_location_failure_conditions/policies/{policy_id}.json: get: tags: - Identifiers 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: - Identifiers 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_location_failure_conditions/{condition_id}.json: put: tags: - Identifiers summary: New Relic Put Alerts Location Failure Conditions 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 update the alerts location failure conditions for your Alerts policy.
' parameters: - name: condition_id in: path description: Alerts condition to update required: true schema: type: integer example: 100 requestBody: description: Condition schema content: application/json: schema: $ref: '#/components/schemas/Condition' examples: PutalertslocationfailureconditionsconditionidRequestExample: summary: Default putAlertsLocationFailureConditionsConditionId 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: PutalertslocationfailureconditionsconditionidRequestExample: summary: Default putAlertsLocationFailureConditionsConditionId 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: Putalertslocationfailureconditionsconditionid200Example: summary: Default putAlertsLocationFailureConditionsConditionId 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: Putalertslocationfailureconditionsconditionid200Example: summary: Default putAlertsLocationFailureConditionsConditionId 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: putAlertsLocationFailureConditionsConditionId x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: tags: - Identifiers summary: New Relic Delete Alerts Location Failure Conditions 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 Delete the alerts location failure conditions for your Alerts policy.
' parameters: - name: condition_id in: path description: Alerts condition ID required: true schema: type: integer example: 100 responses: '200': description: No response was specified content: application/json: schema: $ref: '#/components/schemas/ConditionResponse' examples: Deletealertslocationfailureconditionsconditionid200Example: summary: Default deleteAlertsLocationFailureConditionsConditionId 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: Deletealertslocationfailureconditionsconditionid200Example: summary: Default deleteAlertsLocationFailureConditionsConditionId 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: deleteAlertsLocationFailureConditionsConditionId x-microcks-operation: delay: 0 dispatcher: FALLBACK /alerts_nrql_conditions/policies/{policy_id}.json: post: tags: - Identifiers 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_nrql_conditions/{condition_id}.json: put: tags: - Identifiers summary: New Relic Put Alerts Nrql Conditions description: '🔥🔥 New users should use these docs about managing alerts via NerdGraph. ' parameters: - name: condition_id in: path description: Alerts condition to update required: true schema: type: integer example: 100 requestBody: description: Condition schema content: application/json: schema: $ref: '#/components/schemas/NrqlCondition' examples: PutalertsnrqlconditionsconditionidRequestExample: summary: Default putAlertsNrqlConditionsConditionId 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: PutalertsnrqlconditionsconditionidRequestExample: summary: Default putAlertsNrqlConditionsConditionId 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: Putalertsnrqlconditionsconditionid200Example: summary: Default putAlertsNrqlConditionsConditionId 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: Putalertsnrqlconditionsconditionid200Example: summary: Default putAlertsNrqlConditionsConditionId 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: putAlertsNrqlConditionsConditionId x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: tags: - Identifiers summary: New Relic Delete Alerts Nrql Conditions description: '🔥🔥 New users should use these docs about managing alerts via NerdGraph. ' parameters: - name: condition_id in: path description: Alerts condition ID required: true schema: type: integer example: 100 responses: '200': description: No response was specified content: application/json: schema: $ref: '#/components/schemas/NrqlConditionResponse' examples: Deletealertsnrqlconditionsconditionid200Example: summary: Default deleteAlertsNrqlConditionsConditionId 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: Deletealertsnrqlconditionsconditionid200Example: summary: Default deleteAlertsNrqlConditionsConditionId 200 response x-microcks-default: true value: nrql_condition: enabled: {} expected_groups: {} id: {} ignore_overlap: {} name: {} nrql: {} runbook_url: {} terms: {} type: {} value_function: {} x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true GenerateOperationSummariesFromPath: true ChooseTags: true operationId: deleteAlertsNrqlConditionsConditionId x-microcks-operation: delay: 0 dispatcher: FALLBACK /alerts_policies/{policy_id}.json: put: tags: - Identifiers 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: - Identifiers 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_synthetics_conditions/policies/{policy_id}.json: post: tags: - Identifiers 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\nThis API endpoint allows you to create Synthetics conditions for your alert policies.
\n\nNote: Admin User’s API Key is required.
\n\nSee our documentation for a discussion on creating Synthetic conditions.
\n\nAll fields are required except for “runbook_urlâ€\x9D, “enabledâ€\x9D (defaults to false).
\n\nname: A title for your condition.
\n\nmonitor_id: The GUID of the Synthetics monitor to alert on.
\n\nrunbook_url: Runbook URL to display in notifications (optional).
\n\nenabled: 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 /alerts_synthetics_conditions/{condition_id}.json: put: tags: - Identifiers summary: New Relic Put Alerts Synthetics Conditions description: '🔥🔥 New users should use NRQL Alert Conditions, refer to these docs about managing alerts via NerdGraph.This API endpoint allows you to update Synthetics conditions for your alert policies.
Note: Admin User’s API Key is required.
See our documentation for a discussion on updating Synthetic conditions.
See Alerts Synthetics Conditions > Create for an explanation of the field values used in this command.
' parameters: - name: condition_id in: path description: Alerts condition to update required: true schema: type: integer example: 100 requestBody: description: Condition schema content: application/json: schema: $ref: '#/components/schemas/SyntheticsCondition' examples: PutalertssyntheticsconditionsconditionidRequestExample: summary: Default putAlertsSyntheticsConditionsConditionId 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: PutalertssyntheticsconditionsconditionidRequestExample: summary: Default putAlertsSyntheticsConditionsConditionId 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: Putalertssyntheticsconditionsconditionid200Example: summary: Default putAlertsSyntheticsConditionsConditionId 200 response x-microcks-default: true value: synthetics_condition: enabled: {} id: {} monitor_id: {} name: {} runbook_url: {} application/xml: schema: $ref: '#/components/schemas/SyntheticsConditionResponse' examples: Putalertssyntheticsconditionsconditionid200Example: summary: Default putAlertsSyntheticsConditionsConditionId 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: putAlertsSyntheticsConditionsConditionId x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: tags: - Identifiers summary: New Relic Delete Alerts Synthetics Conditions description: '🔥🔥 New users should use NRQL Alert Conditions, refer to these docs about managing alerts via NerdGraph.This API endpoint allows you to delete Synthetics conditions associated with your alert policy.
Note: Admin User’s API Key is required.
See our documentation for a discussion on deleting Synthetic conditions.
' parameters: - name: condition_id in: path description: Alerts condition ID required: true schema: type: integer example: 100 responses: '200': description: No response was specified content: application/json: schema: $ref: '#/components/schemas/SyntheticsConditionResponse' examples: Deletealertssyntheticsconditionsconditionid200Example: summary: Default deleteAlertsSyntheticsConditionsConditionId 200 response x-microcks-default: true value: synthetics_condition: enabled: {} id: {} monitor_id: {} name: {} runbook_url: {} application/xml: schema: $ref: '#/components/schemas/SyntheticsConditionResponse' examples: Deletealertssyntheticsconditionsconditionid200Example: summary: Default deleteAlertsSyntheticsConditionsConditionId 200 response x-microcks-default: true value: synthetics_condition: enabled: {} id: {} monitor_id: {} name: {} runbook_url: {} x-api-evangelist-processing: PascalCaseOperationSummaries: true CaselCaseOperationIds: true GenerateOperationSummariesFromPath: true ChooseTags: true operationId: deleteAlertsSyntheticsConditionsConditionId x-microcks-operation: delay: 0 dispatcher: FALLBACK components: schemas: MetricListResponse: type: object properties: metrics: type: array items: $ref: '#/components/schemas/MetricParserResponseType' example: - name: example-resource-01 values: - {} ApplicationResponseType: type: object properties: application_summary: $ref: '#/components/schemas/AppSummaryResponse' end_user_summary: $ref: '#/components/schemas/EndUserSummaryResponse' health_status: type: string example: active id: type: integer example: 100 language: type: string example: example_string last_reported_at: type: string format: date-time example: '2026-04-18T14:30:00Z' links: $ref: '#/components/schemas/ApplicationLinksResponse' name: type: string example: example-resource-01 reporting: type: boolean example: true settings: $ref: '#/components/schemas/AppSettingsResponse' 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 ApplicationBody: type: object properties: name: type: string example: example-resource-01 settings: $ref: '#/components/schemas/AppSettingsBody' NrqlConditionResponse: type: object properties: nrql_condition: $ref: '#/components/schemas/NrqlConditionResponseType' KeyTransactionResponseType: type: object properties: application_summary: $ref: '#/components/schemas/AppSummaryResponse' end_user_summary: $ref: '#/components/schemas/EndUserSummaryResponse' health_status: type: string example: active id: type: integer example: 100 last_reported_at: type: string format: date-time example: '2026-04-18T14:30:00Z' links: $ref: '#/components/schemas/KeyTransactionLinksResponse' name: type: string example: example-resource-01 reporting: type: boolean example: true transaction_name: type: string example: example_string AppSettingsResponse: type: object properties: app_apdex_threshold: type: number format: float example: 42.5 enable_real_user_monitoring: type: boolean example: true end_user_apdex_threshold: type: number format: float example: 42.5 use_server_side_config: type: boolean example: true EndUserSummaryDataResponse: type: object properties: apdex_score: type: number format: float example: 87.5 response_time: type: number format: float example: 42.5 throughput: type: number format: float example: 42.5 NrqlBody: type: object properties: query: type: string example: example_string since_value: type: string example: example_string ApplicationInstanceResponseType: type: object properties: host: type: string example: example_string application_name: type: string example: example_string application_summary: $ref: '#/components/schemas/AppSummaryDataResponse' end_user_summary: $ref: '#/components/schemas/EndUserSummaryDataResponse' health_status: type: string example: active id: type: integer example: 100 language: type: integer example: 100 links: $ref: '#/components/schemas/ApplicationInstanceLinksResponse' port: type: integer example: 8080 DeploymentLinksResponse: type: object properties: application: type: integer example: 100 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 PolicyResponse: type: object properties: policy: $ref: '#/components/schemas/PolicyResponseType' 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 Application: type: object properties: application: $ref: '#/components/schemas/ApplicationBody' MetricParserResponseType: type: object properties: name: type: string example: example-resource-01 values: type: array items: type: string example: - example_string 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 AppSettingsBody: type: object properties: app_apdex_threshold: type: number format: float example: 42.5 enable_real_user_monitoring: type: boolean example: true end_user_apdex_threshold: type: number format: float example: 42.5 MobileSummaryDataResponse: type: object properties: active_users: type: integer example: 100 calls_per_session: type: number format: float example: 42.5 failed_call_rate: type: number format: float example: 12.3 interaction_time: type: number format: float example: 42.5 launch_count: type: integer example: 42 remote_error_rate: type: number format: float example: 12.3 response_time: type: number format: float example: 42.5 throughput: type: number format: float example: 42.5 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 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 AppSummaryResponse: type: object properties: apdex_score: type: number format: float example: 87.5 apdex_target: type: number format: float example: 42.5 concurrent_instance_count: type: integer example: 42 error_rate: type: number format: float example: 12.3 host_count: type: integer example: 42 instance_count: type: integer example: 42 response_time: type: number format: float example: 42.5 throughput: type: number format: float example: 42.5 MetricResponse: type: object properties: name: type: string example: example-resource-01 timeslices: type: array items: $ref: '#/components/schemas/TimesliceResponse' example: - from: '2026-04-18T14:30:00Z' to: '2026-04-18T14:30:00Z' values: {} 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 ApplicationInstanceResponse: type: object properties: application_instance: $ref: '#/components/schemas/ApplicationInstanceResponseType' DeploymentBody: type: object properties: changelog: type: string example: example_string description: type: string example: example_string revision: type: string example: example_string user: type: string example: example_string DeploymentResponse: type: object properties: deployment: $ref: '#/components/schemas/DeploymentResponseType' ChannelResponse: type: object properties: channel: $ref: '#/components/schemas/ChannelResponseType' ExternalServiceConditionResponse: type: object properties: external_service_condition: $ref: '#/components/schemas/ExternalServiceConditionResponseType' NrqlResponse: type: object properties: query: type: string example: example_string since_value: type: string example: example_string Condition: type: object properties: condition: $ref: '#/components/schemas/ConditionBody' NrqlCondition: type: object properties: nrql_condition: $ref: '#/components/schemas/NrqlConditionBody' ApplicationHostResponse: type: object properties: application_hosts: type: array items: $ref: '#/components/schemas/ApplicationHostResponseType' example: - host: example_string application_name: example_string application_summary: {} end_user_summary: {} health_status: active id: 100 language: 100 links: {} MetricParserResponse: type: object properties: metric: $ref: '#/components/schemas/MetricParserResponseType' SyntheticsConditionResponse: type: object properties: synthetics_condition: $ref: '#/components/schemas/SyntheticsConditionResponseType' MobileApplicationResponse: type: object properties: application: $ref: '#/components/schemas/MobileApplicationResponseType' TimesliceResponse: type: object properties: from: type: string format: date-time example: '2026-04-18T14:30:00Z' to: type: string format: date-time example: '2026-04-18T14:30:00Z' values: type: object properties: {} example: {} MetricDataResponseType: type: object properties: from: type: string format: date-time example: '2026-04-18T14:30:00Z' metrics: type: array items: $ref: '#/components/schemas/MetricResponse' example: - name: example-resource-01 timeslices: - {} metrics_found: type: string example: example_string metrics_not_found: type: string example: example_string to: type: string format: date-time example: '2026-04-18T14:30:00Z' KeyTransactionLinksResponse: type: object properties: application: type: integer description: Application from which this key transaction originated example: 100 UserDefinedConditionBody: type: object properties: metric: type: string example: example_string value_function: type: string example: example_string ApplicationHostResponseType: type: object properties: host: type: string example: example_string application_name: type: string example: example_string application_summary: $ref: '#/components/schemas/AppSummaryDataResponse' end_user_summary: $ref: '#/components/schemas/EndUserSummaryDataResponse' health_status: type: string example: active id: type: integer example: 100 language: type: integer example: 100 links: $ref: '#/components/schemas/ApplicationHostLinksResponse' ExternalServiceCondition: type: object properties: external_service_condition: $ref: '#/components/schemas/ExternalServiceConditionBody' ChannelLinksResponse: type: object properties: policy_ids: type: array items: type: integer example: - 100 ApplicationResponse: type: object properties: application: $ref: '#/components/schemas/ApplicationResponseType' MobileApplicationResponseType: type: object properties: crash_summary: $ref: '#/components/schemas/CrashSummaryResponse' health_status: type: string example: active id: type: integer example: 100 mobile_summary: $ref: '#/components/schemas/MobileSummaryDataResponse' name: type: string example: example-resource-01 reporting: type: boolean example: true 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 KeyTransactionResponse: type: object properties: key_transaction: $ref: '#/components/schemas/KeyTransactionResponseType' Deployment: type: object properties: deployment: $ref: '#/components/schemas/DeploymentBody' ApplicationLinksResponse: type: object properties: servers: type: array items: type: integer example: - 100 application_hosts: type: array items: type: integer example: - 100 application_instances: type: array items: type: integer example: - 100 ApplicationHostLinksResponse: type: object properties: application: type: integer example: 100 application_instances: type: array items: type: integer example: - 100 server: type: integer example: 100 Policy: type: object properties: policy: $ref: '#/components/schemas/PolicyBody' EndUserSummaryResponse: type: object properties: apdex_score: type: number format: float example: 87.5 apdex_target: type: number format: float example: 42.5 response_time: type: number format: float example: 42.5 throughput: type: number format: float example: 42.5 ApplicationInstanceLinksResponse: type: object properties: application: type: integer example: 100 application_host: type: integer example: 100 server: type: integer example: 100 CrashSummaryResponse: type: object properties: crash_count: type: integer example: 42 crash_rate: type: number format: float example: 12.3 supports_crash_data: type: boolean example: true unresolved_crash_count: type: integer example: 42 UserDefinedConditionResponse: type: object properties: metric: type: string example: example_string value_function: type: string example: example_string DeploymentResponseType: type: object properties: changelog: type: string example: example_string description: type: string example: example_string id: type: integer example: 100 links: $ref: '#/components/schemas/DeploymentLinksResponse' revision: type: string example: example_string timestamp: type: string format: date-time example: '2026-04-18T14:30:00Z' user: 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 AppSummaryDataResponse: type: object properties: apdex_score: type: number format: float example: 87.5 error_rate: type: number format: float example: 12.3 instance_count: type: integer example: 42 response_time: type: number format: float example: 42.5 throughput: type: number format: float example: 42.5 MetricDataResponse: type: object properties: metric_data: $ref: '#/components/schemas/MetricDataResponseType' 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/