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
List organizations with archived data 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.
data, then an empty list is returned.
Response
Successful operation.
resources *:
arrayExamples
application/json
{
"resources": [
{
"id": "6A02A43C-0B7A-4AF6-A777-D4455989F627"
},
{
"id": "E9BE2F2C-4EEC-408F-9CB0-16686980A63B"
}
]
}
List archived environments for organization listOrgEnvironments
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.
data, then an empty list is returned.
Path Parameters
organization *:
stringThe organization to identify the target resource.
Response
Successful operation.
resources *:
arrayExamples
application/json
{
"resources": [
{
"id": "19f3df44-4953-4b5c-bf8f-45a937b6c1c9"
},
{
"id": "5e72883d-198b-49b5-ab39-0e62f98dce01"
}
]
}
List archived entity types in environment listEntityTypes
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.
data, then an empty list is returned.
Path Parameters
organization *:
stringThe organization to identify the target resource.
environment *:
stringThe environment to identify the target resource.
Related Operations:
Response
Successful operation.
resources *:
arrayExamples
application/json
{
"resources": [
{
"id": "apis"
}
]
}
List archived entities by entity type listEntitiesByType
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.
data, then an empty list is returned.
Path Parameters
organization *:
stringThe organization to identify the target resource.
environment *:
stringThe environment to identify the target resource.
Related Operations:
entityType *:
stringThe entityType to identify the target resource.
Response
The returned list of entity identifiers is for the provided entity type.
resources *:
arrayExamples
application/json
{
"resources": [
{
"id": "125435"
},
{
"id": "212544"
}
]
}
List archived file types for entity listEntityFileTypes
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.
data, then an empty list is returned.
Path Parameters
organization *:
stringThe organization to identify the target resource.
environment *:
stringThe environment to identify the target resource.
Related Operations:
entityType *:
stringThe entityType to identify the target resource.
entityID *:
stringThe entityID to identify the target resource.
Related Operations:
Response
The returned list of available file types for this entity.
resources *:
arrayExamples
application/json
{
"resources": [
{
"id": {
"id": "string",
"type": "string"
}
}
]
}
List archive years for entity file type listArchiveYears
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.
data, then an empty list is returned.
Path Parameters
organization *:
stringThe organization to identify the target resource.
fileType *:
stringThe fileType to identify the target resource.
entityType *:
stringThe entityType to identify the target resource.
environment *:
stringThe environment to identify the target resource.
Related Operations:
entityID *:
stringThe entityID to identify the target resource.
Related Operations:
Response
Successful operation.
resources *:
arrayExamples
application/json
{
"resources": [
{
"id": 2019
},
{
"id": 2020
}
]
}
List archive months for year listArchiveMonths
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.
data, then an empty list is returned.
Path Parameters
organization *:
stringThe organization to identify the target resource.
year *:
integerThe year to identify the target resource.
min: 2000, max: 9999
fileType *:
stringThe fileType to identify the target resource.
entityType *:
stringThe entityType to identify the target resource.
environment *:
stringThe environment to identify the target resource.
Related Operations:
entityID *:
stringThe entityID to identify the target resource.
Related Operations:
Response
Successful operation.
resources *:
arrayExamples
application/json
{
"resources": [
{
"id": "03"
},
{
"id": "04"
},
{
"id": "11"
}
]
}
List archive days for month listArchiveDays
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.
data, then an empty list is returned.
Path Parameters
organization *:
stringThe organization to identify the target resource.
year *:
integerThe year to identify the target resource.
min: 2000, max: 9999
fileType *:
stringThe fileType to identify the target resource.
entityType *:
stringThe entityType to identify the target resource.
environment *:
stringThe environment to identify the target resource.
Related Operations:
entityID *:
stringThe entityID to identify the target resource.
Related Operations:
month *:
stringThe month to identify the target resource.
minLength: 2, maxLength: 2, pattern:
^[0-1][0-9]$Response
Successful operation.
resources *:
arrayExamples
application/json
{
"resources": [
{
"id": "29"
},
{
"id": "30"
},
{
"id": "31"
}
]
}
List archive data files for day listArchiveDataFiles
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
organization *:
stringThe organization to identify the target resource.
dayOfMonth *:
stringThe dayOfMonth to identify the target resource.
minLength: 2, maxLength: 2, pattern:
^[0-3][0-9]$year *:
integerThe year to identify the target resource.
min: 2000, max: 9999
fileType *:
stringThe fileType to identify the target resource.
entityType *:
stringThe entityType to identify the target resource.
environment *:
stringThe environment to identify the target resource.
Related Operations:
entityID *:
stringThe entityID to identify the target resource.
Related Operations:
month *:
stringThe month to identify the target resource.
minLength: 2, maxLength: 2, pattern:
^[0-1][0-9]$Response
Successful operation.
resources *:
arrayExamples
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 archive data file contents getArchiveDataFile
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
organization *:
stringThe organization to identify the target resource.
dayOfMonth *:
stringThe dayOfMonth to identify the target resource.
minLength: 2, maxLength: 2, pattern:
^[0-3][0-9]$year *:
integerThe year to identify the target resource.
min: 2000, max: 9999
fileName *:
stringThe fileName to identify the target resource.
fileType *:
stringThe fileType to identify the target resource.
entityType *:
stringThe entityType to identify the target resource.
environment *:
stringThe environment to identify the target resource.
Related Operations:
entityID *:
stringThe entityID to identify the target resource.
Related Operations:
month *:
stringThe month to identify the target resource.
minLength: 2, maxLength: 2, pattern:
^[0-1][0-9]$Response
Successful operation.