List audit log entries - Ara Documentation

List audit log entries

curl --request GET \
  --url https://api.ara.so/v3/organizations/{orgId}/audit-logs \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.ara.so/v3/organizations/{orgId}/audit-logs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.ara.so/v3/organizations/{orgId}/audit-logs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.ara.so/v3/organizations/{orgId}/audit-logs"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.ara.so/v3/organizations/{orgId}/audit-logs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "items": [
    {
      "id": "<string>",
      "action": "<string>",
      "actor": "<string>",
      "target": "<string>",
      "metadata": {},
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "has_next_page": true,
  "end_cursor": "<string>",
  "entries": [
    {
      "id": "<string>",
      "action": "<string>",
      "actor": "<string>",
      "target": "<string>",
      "metadata": {},
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "next_before": "<string>"
}

GET

/

v3

/

organizations

/

{orgId}

/

audit-logs

List audit log entries

curl --request GET \
  --url https://api.ara.so/v3/organizations/{orgId}/audit-logs \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.ara.so/v3/organizations/{orgId}/audit-logs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.ara.so/v3/organizations/{orgId}/audit-logs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.ara.so/v3/organizations/{orgId}/audit-logs"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.ara.so/v3/organizations/{orgId}/audit-logs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "items": [
    {
      "id": "<string>",
      "action": "<string>",
      "actor": "<string>",
      "target": "<string>",
      "metadata": {},
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "has_next_page": true,
  "end_cursor": "<string>",
  "entries": [
    {
      "id": "<string>",
      "action": "<string>",
      "actor": "<string>",
      "target": "<string>",
      "metadata": {},
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "next_before": "<string>"
}

Authorizations

Authorization

string

header

required

Your ara_ API key from Settings > Ara API. Keys are capability-scoped: run, plugins:read, secrets:read, secrets:write, sessions:read, knowledge:read, repos:read, repos:write, reviews:read, reviews:write, analytics:read, org:read, org:write, attachments:read, attachments:write, plugins:write, guardrails:read, guardrails:write.

Path Parameters

orgId

string

required

Organization id or slug. Resolve it with GET /v3/self.

Query Parameters

limit

integer

default:50

Maximum entries to return (default 50, max 200).

before

string<date-time>

Return only entries created before this timestamp.

action

string

Return only entries with this exact action.

actor

string

Return only entries performed by this actor user id.

since

string<date-time>

Return only entries created at or after this ISO timestamp.

Response

200 - application/json

Audit log entries.

items

object[]

Show child attributes

has_next_page

boolean

end_cursor

string | null

Pass back as after for the next page.

entries

object[]

Legacy twin of items.

Show child attributes

next_before

string | null

Legacy twin of end_cursor.

⌘I