Overview
Statistics
7
Operations
0
Skills
Governance
Category
Query audit log events, actions, and object types for organizations on the Anypoint Platform. Configure log retention settings.
Servers
-
https://anypoint.mulesoft.com/audit/{version} -
https://{region}.anypoint.mulesoft.com/audit/{version} -
https://{region}.platform.mulesoft.com/audit/{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
Create Organizations By Id Query Mediatypeextension createOrganizationsByIdQueryMediatypeextension
POST
Try it out
Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Request Body application/x-www-form-urlencoded
Searches for log entries. Query parameters are documented in the logQuery schema.
Entries returned will match the entries that were passed in, and are sorted in
ascending timestamp order (oldest to newest).
Entries returned will match the entries that were passed in, and are sorted in
ascending timestamp order (oldest to newest).
Path Parameters
id *:
stringThe id to identify the target resource.
mediaTypeExtension *:
stringThe mediaTypeExtension to identify the target resource.
Query Parameters
cursorPagination:
booleanUse cursor based pagination
default:
FalsedoIncludeTotal:
booleanInclude total value in the response
default:
FalsegetVersionedObjectsInLogs:
booleanGet versioned object from the time of log creation, instead of latest object.
Logs for objects created or updated on or after November 29, 2023 will return versioned object information;
Other logs will show no change in behavior.
Logs for objects created or updated on or after November 29, 2023 will return versioned object information;
Other logs will show no change in behavior.
default:
FalseRequest Body
jsonstartDate *:
anyStarting time, expressed in Unix milliseconds or ISO 8601 date, e.g. '2011-10-10T14:48:00', inclusive of passed-in value.
endDate:
anyEnding time, expressed in Unix milliseconds or ISO 8601 date, e.g. '2011-1-1', inclusive of passed-in value.
userIds:
arrayLimits results to only log entries belonging to the given users
objectIds:
arrayLimits results to only log entries containing at least one of the given object ids
parentIds:
arrayLimits results to only log entries whose objects are children of the given parent ids
platforms:
arrayLimits results to only log entries belonging to the platforms
objectTypes:
arrayLimits results to only log entries for objects of the given types
actions:
arrayLimits results to only log entries describing one of the given set of actions
limit:
integerLimits the number of log entries returned. Note, For regular log query, no more than 200 entries will be returned from this service. For csv query, maximum value is 300000.
min: 1, max: 200
offset:
integerPagination parameter to start returning log entries from this position of matches
default:
0, min: 0failed:
booleanLimits results to only log entries with the given 'failed' status
ascending:
booleanIndicates if the result query should be sorted in ascending or descending timestamp order
default:
TruestartDate *:
anyStarting time, expressed in Unix milliseconds or ISO 8601 date, e.g. '2011-10-10T14:48:00', inclusive of passed-in value.
endDate:
anyEnding time, expressed in Unix milliseconds or ISO 8601 date, e.g. '2011-1-1', inclusive of passed-in value.
userIds:
arrayLimits results to only log entries belonging to the given users
objectIds:
arrayLimits results to only log entries containing at least one of the given object ids
parentIds:
arrayLimits results to only log entries whose objects are children of the given parent ids
platforms:
arrayLimits results to only log entries belonging to the platforms
objectTypes:
arrayLimits results to only log entries for objects of the given types
actions:
arrayLimits results to only log entries describing one of the given set of actions
limit:
integerLimits the number of log entries returned. Note, For regular log query, no more than 200 entries will be returned from this service. For csv query, maximum value is 300000.
min: 1, max: 200
offset:
integerPagination parameter to start returning log entries from this position of matches
default:
0, min: 0failed:
booleanLimits results to only log entries with the given 'failed' status
ascending:
booleanIndicates if the result query should be sorted in ascending or descending timestamp order
default:
TrueResponse
Successful operation.
data *:
arrayLog entry - note that we cannot reference logEntry from here - see https://github.com/raml-org/raml-spec/issues/109. Maximum number of log entries returned is 200 for json query, 300000 for csv query.
total:
numberTotal amount of entries that the query matches. Total will be returned when offset based pagination is used. When cursorPagination is set to true, the total will not be returned by default. To get the total in response, doIncludeTotal should be set to true.
cursor:
stringCursor value in response. The cursor value should be used in the next query to get the next page of query results. Cursor will be returned only when cursorPagination is set to true in query. Cursor value corresponds to the last data entry in the response data set and so even with cursorPagination as true, a cursor will not be returned when the data object is empty.
data *:
arrayLog entry - note that we cannot reference logEntry from here - see https://github.com/raml-org/raml-spec/issues/109. Maximum number of log entries returned is 200 for json query, 300000 for csv query.
total:
numberTotal amount of entries that the query matches. Total will be returned when offset based pagination is used. When cursorPagination is set to true, the total will not be returned by default. To get the total in response, doIncludeTotal should be set to true.
cursor:
stringCursor value in response. The cursor value should be used in the next query to get the next page of query results. Cursor will be returned only when cursorPagination is set to true in query. Cursor value corresponds to the last data entry in the response data set and so even with cursorPagination as true, a cursor will not be returned when the data object is empty.
Examples
application/json
{
"data": [
{}
],
"total": 0.0,
"cursor": "string"
}
text/csv
{
"data": [
{}
],
"total": 0.0,
"cursor": "string"
}
Get Organizations By Id Platforms getOrganizationsByIdPlatforms
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Gets all platforms of an organization
Path Parameters
id *:
stringThe id to identify the target resource.
Response
Successful operation.
data *:
arraytotal *:
numberTotal amount of platforms
Examples
application/json
{
"data": [
{
"name": "api-platform",
"label": "cloudhub"
}
],
"total": 2
}
Get Organizations By Id Objecttypes getOrganizationsByIdObjecttypes
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Gets all objectTypes of an organization
Path Parameters
id *:
stringThe id to identify the target resource.
Response
Successful operation.
data *:
arraytotal *:
numberTotal amount of objects types
Examples
application/json
{
"data": [
{
"name": "api",
"platforms": [
"api-platform",
"cloudhub"
]
},
{
"name": "api version",
"platforms": [
"api-platform"
]
},
{
"name": "contract",
"platforms": [
"coreservices"
]
},
{
"name": "application",
"platforms": [
"coreservices"
]
}
],
"total": 4
}
Get Organizations By Id Objects getOrganizationsByIdObjects
GET
Try it out
Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Query objects by objectTypes, platforms and search text passed as parameters
example: |
/organizations/{id}/objects?objectType=XX&object_type=YY&search=test-application
/organizations/{id}/objects?platform=A-111&platform=B-222&search=test-application
/organizations/{id}/objects?platform=A-111&platform=B-222&object_type=YY
example: |
/organizations/{id}/objects?objectType=XX&object_type=YY&search=test-application
/organizations/{id}/objects?platform=A-111&platform=B-222&search=test-application
/organizations/{id}/objects?platform=A-111&platform=B-222&object_type=YY
Path Parameters
id *:
stringThe id to identify the target resource.
Query Parameters
offset *:
numberPagination parameter to start returning object from this position of matches
objectType *:
arrayObject type name, supports multiple object types
objectId *:
arrayObject Id, supports multiple object ids
platform *:
arrayPlatform name, supports multiple platforms
limit *:
numberLimits the number of objects returned
max: 200
search *:
stringThe string to search for in object names
Response
Successful operation.
data *:
arraytotal *:
numberTotal amount of objects that match the criteria
Examples
application/json
{
"data": [
{
"objectId": "9898",
"objectName": "Test API"
},
{
"objectId": "2342",
"objectName": "v1.0"
},
{
"objectId": "5379",
"objectName": "Test Application"
}
],
"total": 3
}
Get Organizations By Id Actions getOrganizationsByIdActions
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Gets all actions and object types associated with them.
Path Parameters
id *:
stringThe id to identify the target resource.
Response
Successful operation.
data *:
arrayActions Entry Array
total *:
numberTotal amount of actions
Examples
application/json
{
"data": [
{
"name": "create",
"objectTypes": [
"api",
"api version"
]
},
{
"name": "start",
"objectTypes": [
"application"
]
},
{
"name": "delete",
"objectTypes": [
"page",
"policy"
]
},
{
"name": "login",
"objectTypes": [
"user"
]
}
],
"total": 3
}
Get Organizations By Id Retentionsettings getOrganizationsByIdRetentionsettings
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Gets retention setting entries for an organization including the current retention period.
Path Parameters
id *:
stringThe id to identify the target resource.
Response
Successful operation.
data *:
arrayRetention Entry Array
Examples
application/json
{
"data": [
{
"retentionPeriod": 2190,
"effectiveFrom": null
}
]
}
Update Organizations By Id Retentionsettings updateOrganizationsByIdRetentionsettings
PUT
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Sets retention setting for an organization. The organization id should be a root organization id as retention period can not be set for a sub-organization.
Path Parameters
id *:
stringThe id to identify the target resource.
Request Body
jsonretentionPeriod *:
numberNumber of days for retaining logs. Valid range is from 30 to 2190 which represents a maximum of 6 years.
effectiveFrom:
stringThe time from which this retention entry will be effective. This field is optional and default value is 7 days from the time the api is invoked. Similarly, when a custom time is provided, the value should be at least 7 days from the time the api is invoked. Any value earlier than that will be invalid. Format is ISO 8601, in UTC.
Examples
example1
{
"retentionPeriod": 30,
"effectiveFrom": "2022-09-29T21:45:41.609000+00:00"
}
example2
{
"retentionPeriod": 365
}
Response
The entry was recorded successfully.