Skip to content
Starlight OpenAPI

Retrieve a list of API Requests that have been made.

GET
/activity

Authorizations

Parameters

Query Parameters

limit
integer
default: 50 
10

How many API Events should be retrieved in a single request.

offset
integer
50

How far into the collection of API Events should the response start

Responses

200

OK

Array<object>

Represents a request that was made to the API. Including what Token was used and what resource was accessed.

object
action
string
Allowed values: READ CREATE UPDATE DELETE
actor
object
account
string
id
string format: uuid
jti
string
requestIp
string
userAgent
string
requestId

The unique id used to identify a single request.

string format: uuid
resource
object
item
object
id
string
/^[\da-z]{26}$/
itemVersion
integer
type
string
Allowed values: ITEM VAULT
vault
object
id
string
/^[\da-z]{26}$/
result
string
Allowed values: SUCCESS DENY
timestamp

The time at which the request was processed by the server.

string format: date-time

Headers

Content-Range
string
1-50/1134

An decription of what part of the collection has been returned as well as the total size.

401

Invalid or missing token

object
message

A message detailing the error

string
status

HTTP Status Code

integer
Example
{
  "message": "Invalid token signature",
  "status": 401
}