POST
/
events
curl --request POST \
  --url https://auditr.io/api/events \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "org_id": "<string>",
  "action": "<string>",
  "action_result": "success",
  "actor_id": "<string>",
  "actor_type": "user",
  "actor_email": "jsmith@example.com",
  "actor_name": "<string>",
  "client_ip": "<string>",
  "request_method": "<string>",
  "request_path": "<string>",
  "response_status": 123,
  "occurred_at": "2023-11-07T05:31:56Z"
}'
{
  "id": "<string>",
  "sha256": "<string>",
  "parent_org_id": "<string>",
  "client_geo_lat": 123,
  "client_geo_lon": 123,
  "client_city": "<string>",
  "client_region_code": "<string>",
  "client_subdivision_1_code": "<string>",
  "user_agent_name": "<string>",
  "user_agent_version": "<string>",
  "org_id": "<string>",
  "action": "<string>",
  "action_result": "success",
  "actor_id": "<string>",
  "actor_type": "user",
  "actor_email": "jsmith@example.com",
  "actor_name": "<string>",
  "client_ip": "<string>",
  "request_method": "<string>",
  "request_path": "<string>",
  "response_status": 123,
  "occurred_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
org_id
string
required

Organization ID the event belongs to

action
string
required

Action used to categorize the event

action_result
enum<string>
required

The result of the action

Available options:
success,
failure
actor_id
string
required

Unique identifier of the actor

actor_type
enum<string>
required

Type of actor

Available options:
user,
machine
occurred_at
string
required

Time the event occurred in ISO format

actor_email
string

Actor's email

actor_name
string

Name of the actor

client_ip
string

IP where the action originated (IPv4/IPv6)

request_method
string

Request method

request_path
string

Request path

response_status
integer

Response status

Response

200
application/json
successful response
org_id
string
required

Organization ID the event belongs to

action
string
required

Action used to categorize the event

action_result
enum<string>
required

The result of the action

Available options:
success,
failure
actor_id
string
required

Unique identifier of the actor

actor_type
enum<string>
required

Type of actor

Available options:
user,
machine
occurred_at
string
required

Time the event occurred in ISO format

id
string

Event identifier

sha256
string

Fingerprint of the event

parent_org_id
string

Parent Organization ID the event belongs to

client_geo_lat
number

Latitude of the IP

client_geo_lon
number

Longitude of the IP

client_city
string

City of the IP

client_region_code
string

State/region of the IP

client_subdivision_1_code
string

Province of the IP

user_agent_name
string

Name of the user agent

user_agent_version
string

Version of the user agent

actor_email
string

Actor's email

actor_name
string

Name of the actor

client_ip
string

IP where the action originated (IPv4/IPv6)

request_method
string

Request method

request_path
string

Request path

response_status
integer

Response status