OrgsLogs

listOrgAuditLogs

GET
/api/v1/orgs/{org_id}/logs/search

Get a list of change logs for the current Org

Authorization

Authorization<token>

Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header.

Format: Authorization: Token {apitoken}

Notes:

  • An API token generated for a specific admin has the same privileges as that admin
  • An API token is automatically removed if it is not used for more than 90 days
  • SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed.

In: header

Path Parameters

org_id*string
Formatuuid

Query Parameters

site_id?string

Filter results by site identifier. Accepts multiple comma-separated values.

admin_name?string

Filter results by one or more administrator names or email addresses. Supports comma-separated values

message?string

Filter results by one or more message text values. Supports comma-separated values

sort?string

Field used to sort results; a leading - indicates descending order. enum: -timestamp, admin_id, site_id, timestamp

Value in

  • "-timestamp"
  • "admin_id"
  • "site_id"
  • "timestamp"
start?string

Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as -1d or -1w

end?string

Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as -1d, -2h, or now

duration?string

Time range duration for the query, using relative units such as 10m, 7d, or 2w

Default"1d"
limit?integer

Maximum number of results to return per page

Range0 <= value
Default100
page?integer

Select the page number to return when using page-based pagination; starts at 1

Range1 <= value
Default1

Response Body

curl -X GET "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/logs/search"
{  "end": 1428954000,  "limit": 100,  "results": [    {      "admin_id": "72bfa2bd-e58a-4670-9d20-a1468f7a6f58",      "admin_name": "test@mistsys.com",      "id": "c6f9347b-b0a4-4a23-b927-fa9249f2ffb2",      "message": "TEST AUDIT",      "org_id": "2818e386-8dec-2562-9ede-5b8a0fbbdc71",      "site_id": "4ac1dcf4-9d8b-7211-65c4-057819f0862b",      "timestamp": 1431382121    }  ],  "start": 1428939600,  "total": 135}