New Relic REST API v2

openapi: 3.0.1
info:
  title: New Relic
  version: v2
  description: >-
    New Relic offers a variety of APIs and SDKs you can use to: Send data to New
    Relic. Retrieve data from New Relic. View and configure settings.
  x-last-validated: '2026-04-18'
servers:
- url: https://api.newrelic.com/v2/
  description: US Production
- url: https://api.eu.newrelic.com/v2/
  description: EU Production
- url: https://staging-api.newrelic.com/v2/
  description: Staging
security:
- APIKeyHeader: []
paths:
  /applications.json:
    get:
      tags:
      - Applications
      - Get
      summary: New Relic Get Applications
      description: >-
        This GET endpoint retrieves a paginated list of all applications
        associated with your New Relic account. It returns application data in
        JSON format, including details such as application name, ID, health
        status, and response time metrics. You can use optional query parameters
        to filter results by application name or IDs, and control pagination
        through page and per_page parameters. The response includes summary
        information for each application, making it useful for monitoring
        multiple applications, building dashboards, or integrating New Relic
        data into external systems. Authentication requires an API key passed in
        the request headers.
      parameters:
      - name: filter[name]
        in: query
        description: Filter by application name
        schema:
          type: string
        example: example_string
      - name: filter[host]
        in: query
        description: Filter by application host
        schema:
          type: string
        example: example_string
      - name: filter[ids]
        in: query
        description: Filter by application ids
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
        example:
        - '500123'
      - name: filter[language]
        in: query
        description: Filter by application language
        schema:
          type: string
        example: example_string
      - name: exclude_links
        in: query
        description: Exclude links section from the response
        schema:
          type: boolean
        example: true
      - 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/ApplicationResponse'
              examples:
                Getapplications200Example:
                  summary: Default getApplications 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:
                Getapplications200Example:
                  summary: Default getApplications 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
        WriteDescription: true
        GenerateOperationSummariesFromPath: true
        ChooseTags: true
      operationId: getApplications
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /applications/{application_id}/deployments.json:
    get:
      tags:
      - Applications
      - Deployments
      - Get
      - 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:
      - Applications
      - Deployments
      - Identifiers
      - Post
      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:
      - Applications
      - Delete
      - Deployments
      - 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:
      - Applications
      - Get
      - Hosts
      - 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:
      - Applications
      - Get
      - Hosts
      - Identifiers
      - Metrics
      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:
      - Applications
      - Data
      - Get
      - Hosts
      - Identifiers
      - Metrics
      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:
      - Applications
      - Get
      - Hosts
      - 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: *id001
            application/xml:
              schema:
                $ref: '#/components/schemas/ApplicationHostResponse'
              examples:
                Getapplicationsidhostsid200Example:
                  summary: Default getApplicationsIdHostsId 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: getApplicationsIdHostsId
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /applications/{application_id}/instances.json:
    get:
      tags:
      - Applications
      - Get
      - Identifiers
      - Instances
      summary: New Relic Get Applications Instances
      description: >+
        <p>This API endpoint returns a <a
        href="https://docs.newrelic.com/docs/apis/rest-api-v2/requirements/pagination-api-output"
        target="_blank">

        paginated</a> list of instances associated with the given application.
        The time range for summary data is the last 3-4 minutes.</p>


        <p>Application instances can be filtered by hostname, or the list of
        application instance IDs.</p>


        <p>See our documentation for a discussion and examples of

        using <a
        href="https://docs.newrelic.com/docs/apis/rest-api-v2/application-examples-v2/list-application-specific-server-host-instance-ids"
        target="_blank"> filters </a>

        and <a
        href="https://docs.newrelic.com/docs/apis/rest-api-v2/application-examples-v2/summary-data-examples-v2"
        target="_blank">summary data output</a>.</p>

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

# --- truncated at 32 KB (248 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/new-relic/refs/heads/main/openapi/new-relic-openapi.yml