Update Konnect 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.

audit_log_destination_idstring(uuid)

UUID of an existing audit log destination

enabledboolean

Indicates if the data should be sent to the webhook.

Default:false

Response

application/json

Get response for audit logs webhook

audit_log_destination_idstring(uuid)required

UUID of an existing audit log destination.

enabledbooleanrequired

Indicates whether audit data should be sent to the webhook.

patch/audit-log-webhook

Body

{ "audit_log_destination_id": "6945c4c4-3e06-4c5c-87e0-726d0cda4e05" }
 
application/json

Delete Konnect Audit Log Webhook

Removes configuration for the audit log webhook. The destination ID is set to empty, and the webhook enabled field is set to false

delete

Response

No Content

delete/audit-log-webhook
 

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

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