v1

latestOpenAPI 3.0.12026-07-1394386381.1 KB

RateLimit

Test rate limit

Set a rate local rate limit just on the current endpoint, for purposes of testing with Vivosuite.

post/tkhq/api/v1/test_rate_limits

Request body

organizationIdstring required

Unique identifier for a given organization. If the request is being made by a WebAuthN user and their sub-organization ID is unknown, this can be the parent organization ID; using the sub-organization ID when possible is preferred due to performance reasons.

isSetLimitboolean required

Whether or not to set a limit on this request.

limitinteger required

Rate limit to set for org, if is_set_limit is set to true.

Response

A successful response.

V1TestRateLimitsResponse required