API Reference

Get audit log

get
https://api.controlup.com/v1/organizations//audit-log

Returns your organization’s audit log. By default, events from the last 24 hours are returned, sorted from newest to oldest. All events are reported in UTC.

Required permission: View Audit Log

Path Params
uuid
required
^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}$

ID of your ControlUp organization. You can find your organization ID on the API Key Management page in the DEX platform.

Query Params
int32
≥ 1
Defaults to 1

The page of results to return.
The first page is page number 1.

int32
≥ 1
Defaults to 10

The number of results returned per page.

string
enum
Defaults to time

Sorts results according to the specified field.

string
enum
Defaults to desc

The sort order (ascending / descending) of the field specified by the _sortBy parameter.

Allowed:
string

A search filter that is applied to all fields.
Only results that contain the specified string are returned.

string
^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\.\d{3})?Z$

Return events starting from the specified date and time in ISO string format (UTC).
If you don’t provide a value, then the default is 24 hours in the past from the time of the request.

string
^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\.\d{3})?Z$

Return events up to the specified date and time in ISO string format (UTC).

string
enum
Defaults to json

The format of returned results.

Allowed:
activity
array of strings

A search filter on the activity field.

activity
description
array of strings

A search filter on the description field.

description
type
array of objects

A search filter on the type field.

type
Allowed:
source
array of strings

A search filter on the source field.

source
module
array of objects

A search filter on the module field.

module
Allowed:
ip
array of strings

A search filter on the ip field.

ip
status
array of objects

A search filter on the status field.

status
Allowed:
origin
array of objects

A search filter on the origin field.

origin
Allowed:
Responses

Updated about 2 months ago

Did this page help you?
Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago

Did this page help you?