Class EventApi

EventApi - object-oriented interface

Export

EventApi

Hierarchy

BaseAPI
- EventApi

Index

Constructors

constructor

new EventApi(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): EventApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns EventApi
Inherited from BaseAPI.constructor
- Defined in packages/lib-apiclient/src/generated/base.ts:52

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: Configuration | undefined

Methods

eventControllerCreate

eventControllerCreate(
eventCreateDTO?: EventCreateDTO,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<EventOutputDTO, any>>
Required permissions: MANAGE_EVENTS
OperationId: EventControllerCreate
Parameters
- OptionaleventCreateDTO: EventCreateDTO
  EventCreateDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<EventOutputDTO, any>>
Throws
Memberof
EventApi
- Defined in packages/lib-apiclient/src/generated/api.ts:18920

eventControllerExport

eventControllerExport(
eventSearchInputDTO?: EventSearchInputDTO,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any>>
Export events matching the search criteria to CSV format. Accepts the same parameters as the search endpoint. Maximum time range is 90 days. Required permissions: READ_EVENTS
OperationId: EventControllerExport
Parameters
- OptionaleventSearchInputDTO: EventSearchInputDTO
  EventSearchInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
Memberof
EventApi
- Defined in packages/lib-apiclient/src/generated/api.ts:18934

eventControllerGetFailedFunctions

eventControllerGetFailedFunctions(
eventSearchInputDTO?: EventSearchInputDTO,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<EventOutputArrayDTOAPI, any>>
Fetches events where cronjob, hook and command failed. Supports all the common query parameters Required permissions: READ_MODULES, READ_EVENTS
OperationId: EventControllerGetFailedFunctions
Parameters
- OptionaleventSearchInputDTO: EventSearchInputDTO
  EventSearchInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<EventOutputArrayDTOAPI, any>>
Throws
Memberof
EventApi
- Defined in packages/lib-apiclient/src/generated/api.ts:18948

eventControllerGetOne

eventControllerGetOne(
id: string,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<EventOutputDTO, any>>
Required permissions: READ_EVENTS
OperationId: EventControllerGetOne
Parameters
- id: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<EventOutputDTO, any>>
Throws
Memberof
EventApi
- Defined in packages/lib-apiclient/src/generated/api.ts:18962

eventControllerSearch

eventControllerSearch(
eventSearchInputDTO?: EventSearchInputDTO,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<EventOutputArrayDTOAPI, any>>
Search events Required permissions: READ_EVENTS
OperationId: EventControllerSearch
Parameters
- OptionaleventSearchInputDTO: EventSearchInputDTO
  EventSearchInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<EventOutputArrayDTOAPI, any>>
Throws
Memberof
EventApi
- Defined in packages/lib-apiclient/src/generated/api.ts:18976

Class EventApi

Export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns EventApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

eventControllerCreate

Parameters

Returns Promise<AxiosResponse<EventOutputDTO, any>>

Throws

Memberof

eventControllerExport

Parameters

Returns Promise<AxiosResponse<void, any>>

Throws

Memberof

eventControllerGetFailedFunctions

Parameters

Returns Promise<AxiosResponse<EventOutputArrayDTOAPI, any>>

Throws

Memberof

eventControllerGetOne

Parameters

Returns Promise<AxiosResponse<EventOutputDTO, any>>

Throws

Memberof

eventControllerSearch

Parameters

Returns Promise<AxiosResponse<EventOutputArrayDTOAPI, any>>

Throws

Memberof

Settings

On This Page

`Protected`axios

`Protected`basePath

`Protected`configuration