ARM Monitoring Query API

1.0.0

Overview

Statistics
8 Operations
0 Skills
Monitoring Category
Query application metrics and performance data for Mule applications managed through Anypoint Runtime Manager. Filter by application, time range, and environment.

Servers

  • https://anypoint.mulesoft.com/monitoring/query/api/v{version}/organizations/{organizationId}/environments/{envId}
  • https://{region}.anypoint.mulesoft.com/monitoring/query/api/v{version}/organizations/{organizationId}/environments/{envId}
  • https://{region}.platform.mulesoft.com/monitoring/query/api/v{version}/organizations/{organizationId}/environments/{envId}

Authentication & Security

  • bearerAuth http

    Bearer token authentication. Login endpoint: https://anypoint.mulesoft.com/accounts/api/login

  • clientAuth oauth2

    OAuth2 client credentials. Token endpoint: https://anypoint.mulesoft.com/accounts/api/v2/oauth2/token

Get__applications get__applications

GET

Try it out

Query Parameters
Custom Query Parameters
Custom Headers
Returns a list of application metrics with aggregated values.

Query Parameters

id *: integer
detailed: boolean

Response

*/*
from *: string(date-time)
to *: string(date-time)
period *: number
applications *: array

Post__applications post__applications

POST

Try it out

Query Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Returns a list of application metrics with aggregated values corresponding with the provided ids.

Query Parameters

detailed: boolean

Request Body

json
ids *: array

Response

*/*
from *: string(date-time)
to *: string(date-time)
period *: number
applications *: array

Get__applications_{id} get__applications_{id}

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Returns a list of application metrics with the aggregated values.

Path Parameters

id *: string

Query Parameters

detailed: boolean

Response

*/*
from *: string(date-time)
to *: string(date-time)
period *: number
applications *: array

Get__applications_{id}_flows get__applications_{id}_flows

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Returns a list of flow metrics with aggregated values.

Path Parameters

id *: string

Query Parameters

id *: integer
detailed: boolean

Response

*/*
from *: string(date-time)
to *: string(date-time)
period *: number
flows *: array

Post__applications_{id}_flows post__applications_{id}_flows

POST

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Returns a list of flow metrics with aggregated values corresponding with the provided ids.

Path Parameters

id *: string

Query Parameters

detailed: boolean

Request Body

json
ids *: array

Response

*/*
from *: string(date-time)
to *: string(date-time)
period *: number
flows *: array

Get__targets get__targets

GET

Try it out

Query Parameters
Custom Query Parameters
Custom Headers
Returns a list of target metrics with aggregated values.

Query Parameters

id *: integer
detailed: boolean

Response

*/*
from *: string(date-time)
to *: string(date-time)
period *: number
targets *: array

Post__targets post__targets

POST

Try it out

Query Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Returns a list of target metrics with aggregated values corresponding with the provided ids.

Query Parameters

detailed: boolean

Request Body

json
ids *: array

Response

*/*
from *: string(date-time)
to *: string(date-time)
period *: number
targets *: array

Get__targets_{id} get__targets_{id}

GET

Try it out

Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Returns a list of target metrics with the aggregated values.

Path Parameters

id *: string

Query Parameters

detailed: boolean

Response

*/*
from *: string(date-time)
to *: string(date-time)
period *: number
targets *: array