Skip to content
  • Auto
  • Light
  • Dark
Get Started

System Log

System Log

System Log

List Events
client.SystemLog.ListEvents(ctx, body) (*ListarrayNextPageTokenstringSystemLogListEventsResponse, error)
post/api/v1/systemlog/events

System LogExports

Create
client.SystemLog.Exports.New(ctx, body) (*ExporterExporterSystemLogExportNewResponse, error)
post/api/v1/systemlog/exports
Get
client.SystemLog.Exports.Get(ctx, exportID) (*ExporterExporterSystemLogExportGetResponse, error)
get/api/v1/systemlog/exports/{export_id}
Update
client.SystemLog.Exports.Update(ctx, exportID, body) (*ExporterExporterSystemLogExportUpdateResponse, error)
post/api/v1/systemlog/exports/{export_id}
List
client.SystemLog.Exports.List(ctx, query) (*ListarrayNextPageTokenstringSystemLogExportListResponse, error)
get/api/v1/systemlog/exports
Delete
client.SystemLog.Exports.Delete(ctx, exportID, body) (*SystemLogExportDeleteResponse, error)
delete/api/v1/systemlog/exports/{export_id}
List Events
client.SystemLog.Exports.ListEvents(ctx, exportID, body) (*ListarrayNextPageTokenstringSystemLogExportListEventsResponse, error)
post/api/v1/systemlog/exports/{export_id}/events
Export To Datasource
ExportToDatasourcestruct

The ExportToDatasource message.

ShowShow
DatasourceIDstring
optional

The datasourceId field.

FormatExportToDatasourceFormatExportFormatUnspecifiedExportToDatasourceFormatExportToDatasourceFormatExportFormatOcsfJsonZstdExportToDatasourceFormatExportToDatasourceFormatExportFormatOcsfJsonGzipExportToDatasourceFormatExportToDatasourceFormat
optional

The format field.

Hide ParametersShow Parameters
ExportToDatasourceFormatExportFormatUnspecifiedconst
ExportToDatasourceFormatExportFormatUnspecifiedExportToDatasourceFormatExportToDatasourceFormatExportFormatOcsfJsonZstdExportToDatasourceFormatExportToDatasourceFormatExportFormatOcsfJsonGzipExportToDatasourceFormatExportToDatasourceFormat
"EXPORT_FORMAT_UNSPECIFIED"
ExportToDatasourceFormatExportFormatOcsfJsonZstdconst
ExportToDatasourceFormatExportFormatUnspecifiedExportToDatasourceFormatExportToDatasourceFormatExportFormatOcsfJsonZstdExportToDatasourceFormatExportToDatasourceFormatExportFormatOcsfJsonGzipExportToDatasourceFormatExportToDatasourceFormat
"EXPORT_FORMAT_OCSF_JSON_ZSTD"
ExportToDatasourceFormatExportFormatOcsfJsonGzipconst
ExportToDatasourceFormatExportFormatUnspecifiedExportToDatasourceFormatExportToDatasourceFormatExportFormatOcsfJsonZstdExportToDatasourceFormatExportToDatasourceFormatExportFormatOcsfJsonGzipExportToDatasourceFormatExportToDatasourceFormat
"EXPORT_FORMAT_OCSF_JSON_GZIP"
Prefixstring
optional

The prefix field.

Exporter
Exporterstruct

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
CreatedAtTime
optional
formatdate-time
DatasourceDatasourceIDstringFormatExportToDatasourceFormatPrefixstringExportToDatasource
optional

The ExportToDatasource message.

DeletedAtTime
optional
formatdate-time
DisplayNamestring
optional

The displayName field.

ExportIDstring
optional

The exportId field.

StateExporterStateExportStateUnspecifiedExporterStateExporterStateExportStateExportingExporterStateExporterStateExportStateWaitingExporterStateExporterStateExportStateErrorExporterStateExporterState
optional

The state field.

Hide ParametersShow Parameters
ExporterStateExportStateUnspecifiedconst
ExporterStateExportStateUnspecifiedExporterStateExporterStateExportStateExportingExporterStateExporterStateExportStateWaitingExporterStateExporterStateExportStateErrorExporterStateExporterState
"EXPORT_STATE_UNSPECIFIED"
ExporterStateExportStateExportingconst
ExporterStateExportStateUnspecifiedExporterStateExporterStateExportStateExportingExporterStateExporterStateExportStateWaitingExporterStateExporterStateExportStateErrorExporterStateExporterState
"EXPORT_STATE_EXPORTING"
ExporterStateExportStateWaitingconst
ExporterStateExportStateUnspecifiedExporterStateExporterStateExportStateExportingExporterStateExporterStateExportStateWaitingExporterStateExporterStateExportStateErrorExporterStateExporterState
"EXPORT_STATE_WAITING"
ExporterStateExportStateErrorconst
ExporterStateExportStateUnspecifiedExporterStateExporterStateExportStateExportingExporterStateExporterStateExportStateWaitingExporterStateExporterStateExportStateErrorExporterStateExporterState
"EXPORT_STATE_ERROR"
UpdatedAtTime
optional
formatdate-time
WatermarkEventIDstring
optional

we've synchorized this far