Update Audit Log Replay Job

Updates a job to re-send audit logs to an organization’s webhook.

put

Body

application/json

The request schema to replace an audit log replay job.

start_atstring(date-time)required

The start of a date-time range in RFC3339 format e.g. 2017-07-21T17:32:28Z.
Must be within the last 7 days.

end_atstring(date-time)required

The end of a date-time range in RFC3339 format e.g. 2017-07-21T17:32:28Z.
Must be within the last 7 days.

Response

application/json

Response from fetching or updating an audit log replay job

start_atstring(date-time)

The start of a date-time range. Initial value is 0001-01-01T00:00:0Z.

Example:2017-07-21T17:32:28Z

end_atstring(date-time)

The end of a date-time range. Initial value is 0001-01-01T00:00:0Z.

Example:2017-07-21T17:32:28Z

statusstringread-only

Allowed values:unconfiguredacceptedpendingrunningcompletedfailed

updated_atstring(date-time)read-only

Timestamp when this job was last updated. Initial value is 0001-01-01T00:00:0Z.

put/audit-log-replay-job

Body

{ "start_at": "start_at", "end_at": "end_at" }
 
application/json

Get Audit Log Replay Job

Returns the audit log replay job’s configuration and status.

get

Response

application/json

Response from fetching or updating an audit log replay job

start_atstring(date-time)

The start of a date-time range. Initial value is 0001-01-01T00:00:0Z.

Example:2017-07-21T17:32:28Z

end_atstring(date-time)

The end of a date-time range. Initial value is 0001-01-01T00:00:0Z.

Example:2017-07-21T17:32:28Z

statusstringread-only

Allowed values:unconfiguredacceptedpendingrunningcompletedfailed

updated_atstring(date-time)read-only

Timestamp when this job was last updated. Initial value is 0001-01-01T00:00:0Z.

get/audit-log-replay-job
 
application/json

Update Audit Log Webhook

Updates the configuration for a webhook to receive audit logs.

patch

Body

application/json

The request schema to modify an audit log webhook.

endpointstring

The endpoint that will receive audit log messages.

Example:https://example.com/audit-logs

authorizationstring

The value to include in the Authorization header when sending audit logs to the webhook.

Example:Bearer sometoken

enabledboolean

Indicates if the data should be sent to the webhook.

Default:false

Example:true

log_formatstring

The output format of each log messages.

Allowed values:cefjsoncps

Default:cef

skip_ssl_verificationboolean

Indicates if the SSL certificate verification of the host endpoint should be skipped when delivering payloads.
We strongly recommend not setting this to ‘true’ as you are subject to man-in-the-middle and other attacks.
This option should be considered only for self-signed SSL certificates used in a non-production environment.

Default:false

Example:false

Response

application/json

Get response for audit log webhook

endpointstring

The endpoint that will receive audit log messages.

Example:https://example.com/audit-logs

enabledboolean

Indicates whether audit data should be sent to the webhook.

Example:true

log_formatstring

The output format of each log messages.

Allowed values:cefjsoncps

Default:cef

skip_ssl_verificationboolean

Indicates if the SSL certificate verification of the host endpoint should be skipped when delivering payloads.

Default:false

Example:false

updated_atstring(date-time)read-only

Timestamp when this webhook was last updated. Initial value is 0001-01-01T00:00:0Z.

patch/audit-log-webhook

Body

{ "enabled": false }
 
application/json

Get Audit Log Webhook

Returns configuration for the audit log webhook.

get

Response

application/json

Get response for audit log webhook

endpointstring

The endpoint that will receive audit log messages.

Example:https://example.com/audit-logs

enabledboolean

Indicates whether audit data should be sent to the webhook.

Example:true

log_formatstring

The output format of each log messages.

Allowed values:cefjsoncps

Default:cef

skip_ssl_verificationboolean

Indicates if the SSL certificate verification of the host endpoint should be skipped when delivering payloads.

Default:false

Example:false

updated_atstring(date-time)read-only

Timestamp when this webhook was last updated. Initial value is 0001-01-01T00:00:0Z.

get/audit-log-webhook
 
application/json

Get Audit Log Webhook Status

Returns status of the audit log webhook.

get

Response

application/json

Get response for audit log webhook status

webhook_statusstring

Current status of a webhook. active indicates the webhook is sending or ready to send requests.
inactive indicates the webhook has been turned off due to failed attempts.

Allowed values:activeinactive

Example:active

webhook_enabledboolean

Configured status of a webhook. enabled indicates the client will accept requests.
disabled indicates the client will not accept requests.

Example:true

last_attempt_atstring(date-time)

The last time a request was made to the webhook, regardless of outcome.

Example:2023-03-21T09:29:14.52Z

last_response_codeinteger

The last response code received from the webhook.

Example:401

last_response_messagestring

The last message received from the webhook. Useful for debugging.

Example:Unauthenticated

get/audit-log-webhook/status
 
application/json