Your suggested change has been received. Thank you.

close

Suggest A Change

https://thales.na.market.dpondemand.io/docs/dpod/services/kmo….

back

Audit Query API

AuditLogsApi

search

AuditLogsApi

AuditLogsApi

Method HTTP request Description Scopes
export POST /audit-log-exports Create an asynchronous job to export audit logs. dpod.tenant.admin
dpod.tenant.appowner
dpod.tenant.api_appowner
poll GET /audit-log-exports/{jobId} Returns the state and result of an export audit logs operation. dpod.tenant.admin
dpod.tenant.appowner
dpod.tenant.api_appowner

export

ExportLogsResponse export(exportLogsRequest)

Create an asynchronous job to export audit logs to a compressed file using the specified filters. The state and result of the operation may be retrieved through the GET /v1/audit-log-exports/{jobId} API.

Parameters

Name Type Description Notes
exportLogsRequest ExportLogsRequest Contains the filter parameters to be used by the export audit logs operation.

Return type

ExportLogsResponse

Authorization

OAuth2

  • dpod.tenant.admin: Tenant Administrator
  • dpod.tenant.appowner: Application Owner
  • dpod.tenant.api_appowner: Application Owner API platform credentials

For more information about authorization see Getting Started Using the DPoD API.

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

poll

ExportLogsResponse poll(jobId)

Returns the state and result of an export audit logs operation that was created using the POST /v1/audit-log-exports API. When the operation has succeeded the \"location\" will be populated with a signed URL that may be used to download the compressed file.

Parameters

Name Type Description Notes
jobId UUID The ID of the export audit logs operation to retrieve. [default to null]

Return type

ExportLogsResponse

Authorization

OAuth2

  • dpod.tenant.admin: Tenant Administrator
  • dpod.tenant.appowner: Application Owner
  • dpod.tenant.api_appowner: Application Owner API platform credentials

For more information about authorization see Getting Started Using the DPoD API.

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json