Instance Audit Logs Actions

https://api.losant.com/instance/INSTANCE_ID/audit-logs

Below are the various requests that can be performed against the Instance Audit Logs resource, as well as the expected parameters and the potential responses.

Get

Returns the audit logs for the instance

Method And Url

GET https://api.losant.com/instance/INSTANCE_ID/audit-logs

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Instance, all.Instance.bounded, all.Instance.read, all.User, all.User.bounded, all.User.read, instanceAuditLogs.*, or instanceAuditLogs.get.

Request Path Components

Path Component	Description	Example
INSTANCE_ID	ID associated with the instance	575ec7417ae143cd83dc4a96

Request Query Parameters

Name	Required	Description	Default	Example
sortField	N	Field to sort the results by. Accepted values are: creationDate, responseStatus, actorName	creationDate	`sortField=creationDate`
sortDirection	N	Direction to sort the results by. Accepted values are: asc, desc	desc	`sortDirection=asc`
page	N	Which page of results to return	0	`page=0`
perPage	N	How many items to return per page	100	`perPage=10`
start	N	Start of time range for audit log query		`start=1465790400000`
end	N	End of time range for audit log query		`end=1465790400000`
auditLogFilter	N	Filters for the audit log query. See Instance Audit Log Filter for more details.		`auditLogFilter[primaryTarget][0][type]=Organization&auditLogFilter[primaryTarget][1][type]=ApiToken&auditLogFilter[primaryTarget][1][id]=575ec8687ae143cd83dc4a97&auditLogFilter[actor][0][type]=User&auditLogFilter[actor][0][id]=575ed70c7ae143cd83dc4aa9`

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X GET \
    https://api.losant.com/instance/INSTANCE_ID/audit-logs

Successful Responses

Code	Type	Description
200	Instance Audit Logs	Collection of instance audit logs

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if instance was not found

Schemas

Error

Schema for errors returned by the API

Error Schema

▶
(root){} 3 keys$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 3 keys▶
type:{} 1 key
▶
message:{} 1 key
▶
validationErrors:{} 2 keys

Error Example

▶
(root){} 2 keystype:"NotFound"
message:"Application was not found"

Instance Audit Log Filter

Schema for the filter of an instance audit log query

Instance Audit Log Filter Schema

▶
(root){} 4 keys$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 5 keys▶
primaryTarget:{} 2 keys
▶
secondaryTarget:{} 2 keys
▶
actor:{} 2 keys
▶
request:{} 2 keys
▶
responseCode:{} 2 keys
additionalProperties:false

Instance Audit Log Filter Example

▶
(root){} 2 keys▶
primaryTarget:[] 2 items
▶
actor:[] 1 item