Class ServerApi

Hierarchy

BaseAPI
- ServerApi

Constructors

constructor

new ServerApi(configuration?: Configuration): ServerApi

Inherited from BaseAPI.constructor
- Defined in client/runtime.ts:24
Parameters
- configuration: Configuration = ...
Returns ServerApi

Properties

Protected configuration

configuration: Configuration = ...

Methods

pluginsGet

pluginsGet(): Promise<AdminModules>

- Defined in client/apis/ServerApi.ts:59
Fetch the list of loaded plugins

Returns Promise<AdminModules>

pluginsGetRaw

pluginsGetRaw(): Promise<ApiResponse<AdminModules>>

- Defined in client/apis/ServerApi.ts:39
Fetch the list of loaded plugins

Returns Promise<ApiResponse<AdminModules>>

Protected request

request(context: RequestOpts): Promise<Response>

Inherited from BaseAPI.request
- Defined in client/runtime.ts:50
Parameters
- context: RequestOpts
Returns Promise<Response>

shutdownGet

shutdownGet(): Promise<object>

- Defined in client/apis/ServerApi.ts:85
Shut down server

Returns Promise<object>

shutdownGetRaw

shutdownGetRaw(): Promise<ApiResponse<object>>

- Defined in client/apis/ServerApi.ts:67
Shut down server

Returns Promise<ApiResponse<object>>

statusConfigGet

statusConfigGet(): Promise<AdminConfig>

- Defined in client/apis/ServerApi.ts:113
Fetch the server configuration

Returns Promise<AdminConfig>

statusConfigGetRaw

statusConfigGetRaw(): Promise<ApiResponse<AdminConfig>>

- Defined in client/apis/ServerApi.ts:93
Fetch the server configuration

Returns Promise<ApiResponse<AdminConfig>>

statusGet

statusGet(): Promise<AdminStatus>

- Defined in client/apis/ServerApi.ts:141
Fetch the server status

Returns Promise<AdminStatus>

statusGetRaw

statusGetRaw(): Promise<ApiResponse<AdminStatus>>

- Defined in client/apis/ServerApi.ts:121
Fetch the server status

Returns Promise<ApiResponse<AdminStatus>>

statusLiveGet

statusLiveGet(): Promise<AdminStatusLiveliness>

- Defined in client/apis/ServerApi.ts:171
Liveliness check

Returns Promise<AdminStatusLiveliness>

statusLiveGetRaw

statusLiveGetRaw(): Promise<ApiResponse<AdminStatusLiveliness>>

- Defined in client/apis/ServerApi.ts:149
Liveliness check

Returns Promise<ApiResponse<AdminStatusLiveliness>>

statusReadyGet

statusReadyGet(): Promise<AdminStatusReadiness>

- Defined in client/apis/ServerApi.ts:201
Readiness check

Returns Promise<AdminStatusReadiness>

statusReadyGetRaw

statusReadyGetRaw(): Promise<ApiResponse<AdminStatusReadiness>>

- Defined in client/apis/ServerApi.ts:179
Readiness check

Returns Promise<ApiResponse<AdminStatusReadiness>>

statusResetPost

statusResetPost(): Promise<object>

- Defined in client/apis/ServerApi.ts:227
Reset statistics

Returns Promise<object>

statusResetPostRaw

statusResetPostRaw(): Promise<ApiResponse<object>>

- Defined in client/apis/ServerApi.ts:209
Reset statistics

Returns Promise<ApiResponse<object>>

withMiddleware

withMiddleware<T>(...middlewares: Middleware[]): T

Inherited from BaseAPI.withMiddleware
- Defined in client/runtime.ts:28
Type parameters
- T: BaseAPI<T>
Parameters
- Rest ...middlewares: Middleware[]
Returns T

withPostMiddleware

withPostMiddleware<T>(...postMiddlewares: (undefined | ((context: ResponseContext) => Promise<void | Response>))[]): T

Inherited from BaseAPI.withPostMiddleware
- Defined in client/runtime.ts:42
Type parameters
- T: BaseAPI<T>
Parameters
- Rest ...postMiddlewares: (undefined | ((context: ResponseContext) => Promise<void | Response>))[]
Returns T

withPreMiddleware

withPreMiddleware<T>(...preMiddlewares: (undefined | ((context: RequestContext) => Promise<void | FetchParams>))[]): T

Inherited from BaseAPI.withPreMiddleware
- Defined in client/runtime.ts:34
Type parameters
- T: BaseAPI<T>
Parameters
- Rest ...preMiddlewares: (undefined | ((context: RequestContext) => Promise<void | FetchParams>))[]
Returns T

Generated using TypeDoc