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

Get Audit Log Destinations

Returns configuration for the audit log destinations.

get

Query Parameters

page[size]integer

The maximum number of items to include per page. The last page of a collection may include fewer items.

Example:10

page[after]string

Request the next page of data, starting with the item after this parameter.

Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ

page[before]string

Request the next page of data, starting with the item before this parameter.

Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ

filterobject

Filter destinations returned in the response.

Show Child Parameters

Response

application/json

Response for audit log destinations

ListAuditLogDestinations

dataarray[object]required

Audit Log Destination Schema

Show Child Parameters
metaobjectrequired
Show Child Parameters
get/audit-log-destinations
 
application/json

Create Audit Log Destination

Creates a configuration for the audit log destination.

post

Body

application/json

The request schema to create an audit log destination.

namestringrequired

The name of the audit log destination.

Example:My Destination

endpointstringrequired

The endpoint that will receive audit log messages.

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

authorizationstringrequired

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

Example:Bearer sometoken

log_formatstringrequired

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

Audit log destination response

AuditLogDestination

Audit Log Destination Schema

idstring(uuid)

The unique ID of the audit log destination.

namestring

The name of the audit log destination.

endpointstring

The endpoint that will receive audit log messages.

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

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

created_atstring(date-time)read-only

Timestamp when this webhook was created.

updated_atstring(date-time)read-only

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

post/audit-log-destinations

Body

{ "id": "07ec3858-066b-4629-bdc5-d4aa893b424d", "name": "My Destination", "endpoint": "https://example.com/audit-log", "authorization": "Bearer token", "log_format": "cef", "skip_ssl_verification": false }
 
application/json

Get Audit Log Destination

Returns configuration for the audit log destination.

get

Path Parameters

auditLogDestinationIdstring(uuid)required

ID of the Audit Log Destination.

Response

application/json

Audit log destination response

AuditLogDestination

Audit Log Destination Schema

idstring(uuid)

The unique ID of the audit log destination.

namestring

The name of the audit log destination.

endpointstring

The endpoint that will receive audit log messages.

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

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

created_atstring(date-time)read-only

Timestamp when this webhook was created.

updated_atstring(date-time)read-only

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

get/audit-log-destinations/{auditLogDestinationId}
 
application/json

Update Audit Log Destination

Updates configuration for the audit log destination.

patch

Path Parameters

auditLogDestinationIdstring(uuid)required

ID of the Audit Log Destination.

Body

application/json

The request schema to modify an audit log destination.

namestring

The name of the audit log destination.

Example:My Destination

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

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

Audit log destination response

AuditLogDestination

Audit Log Destination Schema

idstring(uuid)

The unique ID of the audit log destination.

namestring

The name of the audit log destination.

endpointstring

The endpoint that will receive audit log messages.

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

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

created_atstring(date-time)read-only

Timestamp when this webhook was created.

updated_atstring(date-time)read-only

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

patch/audit-log-destinations/{auditLogDestinationId}

Body

{ "endpoint": "https://example.com/audit-log-json", "log_format": "json", "skip_ssl_verification": false }
 
application/json