Skip to content
  • Auto
  • Light
  • Dark
Get Started

System Log

System Log

System Log

List Events
client.systemLog.listEvents(SystemLogListEventsParamsbody?, RequestOptionsoptions?): listunionnextPageTokenstringSystemLogListEventsResponse
post/api/v1/systemlog/events

System LogExports

Create
client.systemLog.exports.create(ExportCreateParamsbody?, RequestOptionsoptions?): exporterExporterExportCreateResponse
post/api/v1/systemlog/exports
Get
client.systemLog.exports.retrieve(stringexportID, RequestOptionsoptions?): exporterExporterExportRetrieveResponse
get/api/v1/systemlog/exports/{export_id}
Update
client.systemLog.exports.update(stringexportID, ExportUpdateParamsbody?, RequestOptionsoptions?): exporterExporterExportUpdateResponse
post/api/v1/systemlog/exports/{export_id}
List
client.systemLog.exports.list(ExportListParamsquery?, RequestOptionsoptions?): listunionnextPageTokenstringExportListResponse
get/api/v1/systemlog/exports
Delete
client.systemLog.exports.delete(stringexportID, ExportDeleteParamsparams?, RequestOptionsoptions?): ExportDeleteResponse
delete/api/v1/systemlog/exports/{export_id}
List Events
client.systemLog.exports.listEvents(stringexportID, ExportListEventsParamsbody?, RequestOptionsoptions?): listunionnextPageTokenstringExportListEventsResponse
post/api/v1/systemlog/exports/{export_id}/events
Export To Datasource
ExportToDatasource

The ExportToDatasource message.

ShowShow
datasourceIdstring
optional

The datasourceId field.

formatunion
optional
"EXPORT_FORMAT_UNSPECIFIED" | "EXPORT_FORMAT_OCSF_JSON_ZSTD" | "EXPORT_FORMAT_OCSF_JSON_GZIP"

The format field.

Hide ParametersShow Parameters
"EXPORT_FORMAT_UNSPECIFIED"
"EXPORT_FORMAT_OCSF_JSON_ZSTD"
"EXPORT_FORMAT_OCSF_JSON_GZIP"
prefixstring
optional

The prefix field.

Exporter
Exporter

The Exporter message.

This message contains a oneof named export_to. Only a single field of the following list may be set at a time:

  • datasource
ShowShow
createdAtstring
optional
formatdate-time
datasourceunion
optional
datasourceIdstringformatunionprefixstringExportToDatasource | null

The ExportToDatasource message.

deletedAtstring
optional
formatdate-time
displayNamestring
optional

The displayName field.

exportIdstring
optional

The exportId field.

stateunion
optional
"EXPORT_STATE_UNSPECIFIED" | "EXPORT_STATE_EXPORTING" | "EXPORT_STATE_WAITING" | "EXPORT_STATE_ERROR"

The state field.

Hide ParametersShow Parameters
"EXPORT_STATE_UNSPECIFIED"
"EXPORT_STATE_EXPORTING"
"EXPORT_STATE_WAITING"
"EXPORT_STATE_ERROR"
updatedAtstring
optional
formatdate-time
watermarkEventIdstring
optional

we've synchorized this far