Skip to main content
GET
List a server's audit log

Authorizations

Authorization
string
header
required

Your API key, sent as a bearer token. Create one in the control panel under API Keys, give it only the permissions the integration needs, and copy it when it is created. It cannot be shown again. Each key is restricted to one owned team. The key determines the team for every request.

Path Parameters

server
string
required

The server UUID

Example:

"ecc6f4f1"

Query Parameters

per_page
integer | null

The maximum number of records to return on one page.

Required range: 1 <= x <= 100
Example:

25

include
string

Related records to include, with multiple values separated by commas.

Example:

"user"

filter[user_id]
string

Filter records by user id.

Example:

"User id"

filter[server_id]
string

Filter records by server id.

Example:

"Server id"

filter[action]
string

Filter records by action.

Example:

"resize_disk"

filter[user.email]
string

Filter records by user.email.

Example:

"gordon.freeman@blackmesa.example.com"

sort
enum<string>[]

The field to sort by, prefixed with - for descending order.

Available options:
created_at,
-created_at,
updated_at,
-updated_at
Example:

Response

One page of results, with the rows under data and the paging figures beside them.

current_page
integer
required

Which page this is, counting from 1.

Example:

1

data
ServerAuditLogData · object[]
required

The rows on this page.

Example:
first_page_url
string
required

A link to the first page.

from
integer | null
required

The position of the first row on this page in the whole result, or null when the page is empty.

last_page
integer
required

How many pages there are.

last_page_url
string
required

A link to the last page.

Pagination links in display order.

next_page_url
string | null
required

A link to the next page, or null on the last one.

path
string
required

The base URL used for pagination.

per_page
integer
required

How many rows a page holds.

Example:

50

prev_page_url
string | null
required

A link to the previous page, or null on the first one.

to
integer | null
required

The position of the last row on this page, or null when the page is empty.

total
integer
required

How many rows there are altogether.