Skip to content

Commit e93e2ef

Browse files
committed
client sync
1 parent 76f7515 commit e93e2ef

File tree

1 file changed

+44
-0
lines changed

1 file changed

+44
-0
lines changed

src/FusionAuthClient.ts

+44
Original file line numberDiff line numberDiff line change
@@ -3530,6 +3530,42 @@ export class FusionAuthClient {
35303530
.go();
35313531
}
35323532

3533+
/**
3534+
* Retrieves the FusionAuth system health. This API will return 200 if the system is healthy, and 500 if the system is un-healthy.
3535+
*
3536+
* @returns {Promise<ClientResponse<void>>}
3537+
*/
3538+
retrieveSystemHealth(): Promise<ClientResponse<void>> {
3539+
return this.startAnonymous<void, void>()
3540+
.withUri('/api/health')
3541+
.withMethod("GET")
3542+
.go();
3543+
}
3544+
3545+
/**
3546+
* Retrieves the FusionAuth system status. This request is anonymous and does not require an API key. When an API key is not provided the response will contain a single value in the JSON response indicating the current health check.
3547+
*
3548+
* @returns {Promise<ClientResponse<StatusResponse>>}
3549+
*/
3550+
retrieveSystemStatus(): Promise<ClientResponse<StatusResponse>> {
3551+
return this.startAnonymous<StatusResponse, void>()
3552+
.withUri('/api/status')
3553+
.withMethod("GET")
3554+
.go();
3555+
}
3556+
3557+
/**
3558+
* Retrieves the FusionAuth system status using an API key. Using an API key will cause the response to include the product version, health checks and various runtime metrics.
3559+
*
3560+
* @returns {Promise<ClientResponse<StatusResponse>>}
3561+
*/
3562+
retrieveSystemStatusUsingAPIKey(): Promise<ClientResponse<StatusResponse>> {
3563+
return this.start<StatusResponse, void>()
3564+
.withUri('/api/status')
3565+
.withMethod("GET")
3566+
.go();
3567+
}
3568+
35333569
/**
35343570
* Retrieves the tenant for the given Id.
35353571
*
@@ -8769,6 +8805,14 @@ export interface UIConfiguration {
87698805
menuFontColor?: string;
87708806
}
87718807

8808+
/**
8809+
* The public Status API response
8810+
*
8811+
* @author Daniel DeGroff
8812+
*/
8813+
export interface StatusResponse extends Record<string, any> {
8814+
}
8815+
87728816
export enum RegistrationType {
87738817
basic = "basic",
87748818
advanced = "advanced"

0 commit comments

Comments
 (0)