ESPRMAdminAPIRateLimit
Defined in: src/ESPRMAdminAPIRateLimit.ts:11
Shell class for admin API rate limit configuration operations. Methods are added via prototype augmentation in methods/ESPRMAdminAPIRateLimit/*.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ESPRMAdminAPIRateLimit():
ESPRMAdminAPIRateLimit
Returns
Section titled “Returns”ESPRMAdminAPIRateLimit
Methods
Section titled “Methods”getAPIRateLimit()
Section titled “getAPIRateLimit()”getAPIRateLimit():
Promise<GetAPIRateLimitResponse>
Defined in: src/methods/ESPRMAdminAPIRateLimit/GetAPIRateLimit.ts:20
Retrieves the current API rate limit configuration for the admin deployment.
Returns
Section titled “Returns”Promise<GetAPIRateLimitResponse>
A promise that resolves to the API rate limit response.
updateAPIRateLimit()
Section titled “updateAPIRateLimit()”updateAPIRateLimit(
params):Promise<ESPAPISuccessResponse>
Defined in: src/methods/ESPRMAdminAPIRateLimit/UpdateAPIRateLimit.ts:22
Updates the API rate limit configuration for the admin deployment.
Parameters
Section titled “Parameters”params
Section titled “params”The API rate limit update request parameters.
Returns
Section titled “Returns”Promise<ESPAPISuccessResponse>
A promise that resolves to a success response.