Audit logs

The organization's record of who changed what, one entry per committed write to this API.

Introduction

The audit log is the organization's record of who changed what. Only writes are recorded, and each committed write records one entry with the credential that made it, the environment it was scoped to, and the fields it changed. Only a write that changed something records an entry.

actor is the credential as it was named when the write ran, so a key renamed or deleted since still reads the way it did then. source is console for an org-scoped token and api for an API key. detail holds the change itself, each field as {"from": …, "to": …}, and a secret write records that its value changed without the value.

A denied entry is a secret write refused with 403 because the organization's tenancy is not active, with the refusal under refusal. It is written after the refusal is answered, so it is best effort, and it stops once the organization's deletion or purge has begun.

Entries are kept until the organization is purged, and deleting an app keeps its entries.

List audit logs

GETapi.serverless.runware.ai/v1/audit-logs

Returns the organization's audit log, newest first. Each committed write records one entry, attributed to the credential that made it: an org-scoped token is the console and an API key is every other client. A write that changes nothing records no entry. A secret write refused with 403 because the organization's tenancy is not active records an entry with status denied on a best-effort basis: it is written after the refusal is answered, and is not written once the organization's deletion or purge has begun. Invocations, task polls and reads record nothing. Entries are kept until the organization is purged; deleting an app keeps its entries. A cursor is valid only with the q, source and status it was issued under, ignoring the case of q.

q matches action, actor.name and each target id as a literal substring, ignoring case. A cursor is valid only with the q, source and status it was issued under, so changing any of them means starting again.

Request

Query

q

stringmin: 1max: 100

Case-insensitive literal substring match against action, actor.name and each target id. An entry matching any of them is returned.

source

string

console for an org-scoped token, api for an API key.

Allowed values2 values

status

string

success when the write committed, denied when a secret write was refused with 403 because the organization's tenancy is not active.

Allowed values2 values

limit

integerint32min: 1max: 100default: 20

Maximum number of items to return.

cursor

string

Opaque pagination cursor returned by a previous call, as nextCursor or, on the operations that offer one, prevCursor.

Response

nextCursor

stringnullable

Cursor for the next page. Null when there are no more items.

data

object[]required
Array items11 properties each

id

stringrequired

Opaque entry identifier.

occurredAt

string (date-time)requireddate-time

When the write ran.

action

stringrequired
Possible values31 values

status

stringrequired

success when the write committed, denied when a secret write was refused with 403 because the organization's tenancy is not active.

Possible values2 values

actor

objectrequired

The credential that made the write, as it was named at write time.

Properties3 properties
kind
stringrequired

token for an org-scoped token, apiKey for an API key.

Possible values2 values
id
stringrequired

The token subject or the API key id. Opaque.

name
stringrequired

The token's name claim or the API key's name, copied when the write ran.

source

stringrequired

console for an org-scoped token, api for an API key.

Possible values2 values

The caller's IP address. Omitted when it is not known.

The environment the write was scoped to. Omitted when it had none.

Properties2 properties
id
string (uuid)UUID v4

Omitted when production had no row when the request resolved it.

name
stringrequired

targets

object[]required

What the write acted on, by the identifier this API addresses it with: an app by appId, a version by its number, a secret, variable, connector or environment by name, and a build or source upload by id. environment.defaults.update names none.

Array items2 properties each
type
stringrequired
Possible values8 values
id
stringrequired

detail

objectrequired

The non-secret change, under the names and in the shapes this API uses for the fields. A changed field is {"from": …, "to": …}, with configuration fields under configuration. An app update that rolls a new version names it under versionNumber, even when no field changed. A build delete that cancels an in-flight build records the status it left the build in under status, as a plain value. A secret write names the secret and records that its value changed, never the value. A denied entry carries the refusal under refusal.

requestId

string

The request id the API answered with. Omitted when it is not known.

Errors

StatusWhen
400The request was malformed and could not be parsed (e.g. invalid JSON). A well-formed request that fails validation returns 422 instead.
401Missing or invalid credentials
422The request was well-formed but semantically invalid (e.g. a missing or out-of-range field). A request that could not be parsed returns 400. The errors array carries one entry per offending field.
500Unexpected server error
503A required service is temporarily unavailable