Anypoint Monitoring Archive API

1.0.0

Overview

Statistics
10 Operations
0 Skills
Monitoring Category
List and retrieve archived Anypoint Monitoring metrics and logs organized by organization, environment, and runtime entity.

Servers

  • https://monitoring.anypoint.mulesoft.com/monitoring/archive/api/{version}

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 Organizations getOrganizations

GET

Try it out

Custom Query Parameters
Custom Headers
Returns a list of organization identifiers for the organizations that have archived data. If this path contains no
data, then an empty list is returned.

Response

json
Successful operation.
resources *: array
Examples
application/json
{ "resources": [ { "id": "6A02A43C-0B7A-4AF6-A777-D4455989F627" }, { "id": "E9BE2F2C-4EEC-408F-9CB0-16686980A63B" } ] }

Get Organizations By Organization Environments getOrganizationsByOrganizationEnvironments

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Returns a list of environment identifiers for the environments that have archived data. If this path contains no
data, then an empty list is returned.

Path Parameters

Response

json
Successful operation.
resources *: array
Examples
application/json
{ "resources": [ { "id": "19f3df44-4953-4b5c-bf8f-45a937b6c1c9" }, { "id": "5e72883d-198b-49b5-ab39-0e62f98dce01" } ] }

Get Organizations By Organization Environments By Environment getOrganizationsByOrganizationEnvironmentsByEnvironment

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Returns a list of entity type identifiers for the entity types that have archived data. If this path contains no
data, then an empty list is returned.

Path Parameters

environment *: string

Response

json
Successful operation.
resources *: array
Examples
application/json
{ "resources": [ { "id": "apis" } ] }

Get Organizations By Organization Environments By Environment By Entitytype getOrganizationsByOrganizationEnvironmentsByEnvironmentByEntitytype

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Returns a list of entity identifiers for the entities that have archived data. If this path contains no
data, then an empty list is returned.

Path Parameters

environment *: string
entityType *: string
The entityType to identify the target resource.

Response

json
The returned list of entity identifiers is for the provided entity type.
resources *: array
Examples
application/json
{ "resources": [ { "id": "125435" }, { "id": "212544" } ] }

Get Organizations By Organization Environments By Environment By Entitytype By Entityid getOrganizationsByOrganizationEnvironmentsByEnvironmentByEntitytypeByEntityid

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Returns a list of file type identifiers for the file types that have archived data. If this path contains no
data, then an empty list is returned.

Path Parameters

environment *: string
entityType *: string
The entityType to identify the target resource.
entityID *: string

Response

json
The returned list of available file types for this entity.
resources *: array
Examples
application/json
{ "resources": [ { "id": { "id": "string", "type": "string" } } ] }

Get Organizations By Organization Environments By Environment By Entitytype By Entityid By Filetype getOrganizationsByOrganizationEnvironmentsByEnvironmentByEntitytypeByEntityidByFiletype

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Returns a list of year identifiers for the years that have archived data. If this path contains no
data, then an empty list is returned.

Path Parameters

fileType *: string
The fileType to identify the target resource.
entityType *: string
The entityType to identify the target resource.
environment *: string
entityID *: string

Response

json
Successful operation.
resources *: array
Examples
application/json
{ "resources": [ { "id": 2019 }, { "id": 2020 } ] }

Get Organizations By Organization Environments By Environment By Entitytype By Entityid By Filetype By Year getOrganizationsByOrganizationEnvironmentsByEnvironmentByEntitytypeByEntityidByFiletypeByYear

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Returns a list of month identifiers for the months that have archived data. If this path contains no
data, then an empty list is returned.

Path Parameters

year *: integer
fileType *: string
The fileType to identify the target resource.
entityType *: string
The entityType to identify the target resource.
environment *: string
entityID *: string

Response

json
Successful operation.
resources *: array
Examples
application/json
{ "resources": [ { "id": "03" }, { "id": "04" }, { "id": "11" } ] }

Get Organizations By Organization Environments By Environment By Entitytype By Entityid By Filetype By Year By Month getOrganizationsByOrganizationEnvironmentsByEnvironmentByEntitytypeByEntityidByFiletypeByYearByMonth

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Returns a list of day identifiers for the days that have archived data. If this path contains no
data, then an empty list is returned.

Path Parameters

year *: integer
fileType *: string
The fileType to identify the target resource.
entityType *: string
The entityType to identify the target resource.
environment *: string
entityID *: string
month *: string

Response

json
Successful operation.
resources *: array
Examples
application/json
{ "resources": [ { "id": "29" }, { "id": "30" }, { "id": "31" } ] }

Get Organizations By Organization Environments By Environment By Entitytype By Entityid By Filetype By Year By Month By Dayofmonth getOrganizationsByOrganizationEnvironmentsByEnvironmentByEntitytypeByEntityidByFiletypeByYearByMonthByDayofmonth

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Returns a list of data files under this node with each file containing archived metric data.

Path Parameters

dayOfMonth *: string
year *: integer
fileType *: string
The fileType to identify the target resource.
entityType *: string
The entityType to identify the target resource.
environment *: string
entityID *: string
month *: string

Response

json
Successful operation.
resources *: array
Examples
application/json
{ "resources": [ { "id": "5cbaf563-d91a-4970-8169-b7f90044a4f1.2020-03-05T21.26.part0.txt", "time": "2020-03-05T21:26:55+00:00", "size": 1934 }, { "id": "239cae2a-70bc-4738-b444-bfbd71404330.2020-03-05T22.26.part1.txt", "time": "2020-03-05T22:26:26+00:00", "size": 20312 } ] }

Get Organizations By Organization Environments By Environment By Entitytype By Entityid By Filetype By Year By Month By Dayofmonth By Filename getOrganizationsByOrganizationEnvironmentsByEnvironmentByEntitytypeByEntityidByFiletypeByYearByMonthByDayofmonthByFilename

GET

Try it out

Path Parameters
Custom Query Parameters
Custom Headers
Retrieve the contents of the given data file. A data file contains either metric data.

Path Parameters

dayOfMonth *: string
year *: integer
fileName *: string
The fileName to identify the target resource.
fileType *: string
The fileType to identify the target resource.
entityType *: string
The entityType to identify the target resource.
environment *: string
entityID *: string
month *: string

Response

Successful operation.