Skip to main content
GET
/
organizations
/
{name}
/
audit-log
List audit logs
curl --request GET \
  --url https://api.planetscale.com/v1/organizations/{name}/audit-log \
  --header 'Authorization: <api-key>'
{
  "has_next": true,
  "has_prev": true,
  "cursor_start": "<string>",
  "cursor_end": "<string>",
  "data": [
    {
      "id": "<string>",
      "actor_id": "<string>",
      "actor_type": "<string>",
      "auditable_id": "<string>",
      "auditable_type": "<string>",
      "target_id": "<string>",
      "target_type": "<string>",
      "location": "<string>",
      "target_display_name": "<string>",
      "audit_action": "<string>",
      "action": "<string>",
      "actor_display_name": "<string>",
      "auditable_display_name": "<string>",
      "remote_ip": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "metadata": {}
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Path Parameters

​
name
string
required

The name of the organization

Response

Returns the audit log events

​
has_next
boolean
required

Whether there is a next page of results

​
has_prev
boolean
required

Whether there is a previous page of results

​
cursor_start
string
required

The ID of the first object in the current results

​
cursor_end
string
required

The ID of the last object in the current results

​
data
object[]
required
⌘I