Update Portal Audit Log Replay Job

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

put

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Body

application/json

The request schema to replace a portal 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 portal 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/portals/{portalId}/audit-log-replay-job

Body

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

Get Portal Audit Log Replay Job

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

get

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Response

application/json

Response from fetching or updating an portal 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/portals/{portalId}/audit-log-replay-job
 
application/json

Update Portal Audit Log Webhook

Updates the configuration for a webhook to receive audit logs.

patch

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Body

application/json

The request schema to modify an portal audit log webhook.

enabledboolean

Indicates if the data should be sent to the configured destination.

Default:false

Example:true

audit_log_destination_idstring(uuid)

ID of the audit log destination.

Response

application/json

Portal audit log webhook response

enabledboolean

Indicates if the data should be sent to the configured audit log destination.

Default:false

Example:true

audit_log_destination_idstring(uuid)

ID of the audit log destination.

patch/portals/{portalId}/audit-log-webhook

Body

{ "enabled": false }
 
application/json

Get Portal Audit Log Webhook

Returns configuration for the audit log webhook.

get

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Response

application/json

Portal audit log webhook response

enabledboolean

Indicates if the data should be sent to the configured audit log destination.

Default:false

Example:true

audit_log_destination_idstring(uuid)

ID of the audit log destination.

get/portals/{portalId}/audit-log-webhook
 
application/json

Delete Portal 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

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Response

No Content

delete/portals/{portalId}/audit-log-webhook