List Events

List Events

client.SystemLog.ListEvents(ctx, body) (*ListarrayNextPageTokenstringSystemLogListEventsResponse, error)

post/api/v1/systemlog/events

ListEvents pulls Events from the ConductorOne system.

This endpoint should be used to synchorize the system log events to external systems.

Parameters

bodyPageSizefieldPageTokenfieldSincefieldSinceEventUidfieldSortDirectionfieldUntilfieldSystemLogListEventsParams

Hide ParametersShow Parameters

PageSizefield

optional

param.Field[int64]

The pageSize field.

formatint32

PageTokenfield

optional

param.Field[string]

The pageToken field.

Sincefield

optional

param.Field[Time]

formatdate-time

SinceEventUidfield

optional

param.Field[string]

The sinceEventUid field.

SortDirectionfield

optional

param.Field[SystemLogListEventsParamsSortDirection]

The sortDirection field.

Hide ParametersShow Parameters

SystemLogListEventsParamsSortDirectionSortDirectionUnspecifiedconst

SystemLogListEventsParamsSortDirection

"SORT_DIRECTION_UNSPECIFIED"

SystemLogListEventsParamsSortDirectionSortDirectionAscconst

SystemLogListEventsParamsSortDirection

"SORT_DIRECTION_ASC"

SystemLogListEventsParamsSortDirectionSortDirectionDescconst

SystemLogListEventsParamsSortDirection

"SORT_DIRECTION_DESC"

Untilfield

optional

param.Field[Time]

formatdate-time

Returns

SystemLogListEventsResponsestruct

The SystemLogServiceListEventsResponse message.

Hide ParametersShow Parameters

Listarray

optional

[]map[string, any]

List contains an array of JSON OCSF events.

NextPageTokenstring

optional

The nextPageToken field.

Request example Go

package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/-go"
  "github.com/stainless-sdks/-go/option"
)

func main() {
  client := conductoronesdk.NewClient(
    option.WithAPIKey("My API Key"),
  )
  response, err := client.SystemLog.ListEvents(context.TODO(), conductoronesdk.SystemLogListEventsParams{

  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response.List)
}

200 Example

{
  "list": [
    {
      "foo": "bar"
    }
  ],
  "nextPageToken": "nextPageToken"
}