Audit

List the tenant-safe audit trail

GET

https://api.signals.pressone.africa/v1

/audit

List the tenant-safe audit trail › query Parameters

actor

string · enum

Enum values:

any

user

api_key

operator

system

kind

string · enum

Enum values:

any

trunks

numbers

credentials

seats

alerts

trunk_id

string

One trk_ trunk id, or any for every trunk.

range

string · enum

Enum values:

24h

30d

all

cursor

string

limit

integer · int32 · min: 0

List the tenant-safe audit trail › Responses

One page of audit events.

AuditPage

as_of

string · date-time · required

AuditEvent[] · required

next_cursor

string | null · required

previous_cursor

string | null · required

retention_days

integer · int64 · required

total

integer · int64 · min: 0 · required

total_all

integer · int64 · min: 0 · required

GET/audit

curl https://api.signals.pressone.africa/v1/audit \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "as_of": "2024-08-25T15:00:00Z",
  "data": [
    {
      "action": "action",
      "actor": {
        "detail": "detail",
        "name": "name",
        "type": "user"
      },
      "applied": true,
      "at": "2024-08-25T15:00:00Z",
      "category": "configuration",
      "detail": "detail",
      "effective_revision": 0,
      "from_revision": 0,
      "id": "id",
      "kind": "trunks",
      "request_id": "request_id",
      "resource": {
        "href": "href",
        "id": "id",
        "name": "name",
        "type": "type"
      },
      "summary": "summary",
      "ticket_ref": "ticket_ref",
      "to_revision": 0
    }
  ],
  "next_cursor": "next_cursor",
  "previous_cursor": "previous_cursor",
  "retention_days": 0,
  "total": 0,
  "total_all": 0
}

json

application/json

Explain one tenant-safe audit event

GET

https://api.signals.pressone.africa/v1

/audit/{event_id}

Explain one tenant-safe audit event › path Parameters

event_id

string · required

Audit event id

Explain one tenant-safe audit event › Responses

The audit event with its changes and timeline.

AuditEventDetail

AuditFieldChange[] · required

AuditEvent · required

notes

string[] · required

supersedes_at

string | null · date-time · required

AuditTimelineEntry[] · required

GET/audit/{event_id}

curl https://api.signals.pressone.africa/v1/audit/:event_id \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "changes": [
    {
      "after": "after",
      "before": "before",
      "label": "label",
      "redacted": true,
      "unchanged": true
    }
  ],
  "event": {
    "action": "action",
    "actor": {
      "detail": "detail",
      "name": "name",
      "type": "user"
    },
    "applied": true,
    "at": "2024-08-25T15:00:00Z",
    "category": "configuration",
    "detail": "detail",
    "effective_revision": 0,
    "from_revision": 0,
    "id": "id",
    "kind": "trunks",
    "request_id": "request_id",
    "resource": {
      "href": "href",
      "id": "id",
      "name": "name",
      "type": "type"
    },
    "summary": "summary",
    "ticket_ref": "ticket_ref",
    "to_revision": 0
  },
  "notes": [
    "string"
  ],
  "supersedes_at": "2024-08-25T15:00:00Z",
  "timeline": [
    {
      "at": "2024-08-25T15:00:00Z",
      "text": "text"
    }
  ]
}

json

application/json

Alerts Platform