Sign in

v1

latestOpenAPI 3.0.1CC BY-NC-SA 3.0 US2026-07-145251,1312.6 MB
Rate Limiting

Return One Rate Limit

Get one rate limit endpoint set.

get/api/atlas/v2/rateLimits/{endpointSetId}

Path parameters

endpointSetIdstring required
Example:rateLimitsInspection_group

The ID of the rate limit endpoint set.

Query parameters

prettyboolean

Flag that indicates whether the response body should be in the prettyprint format.

envelopeboolean

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

groupIdstring
Example:32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies the Atlas Project to request rate limits for. When this parameter is provided, the limits returned are applicable to the specified project. The requesting user must have the Project Read Only role for the specified project.

orgIdstring
Example:32b6e34b3d91647abb20e7b8

Unique 24-hexadecimal digit string that identifies the Atlas Organization to request rate limits for. When this parameter is provided, the limits returned are applicable to the specified organization. The requesting user must have the Organization Read Only role for the specified organization.

userIdstring
Example:mdb_sa_id_1234567890abcdef12345678

A string that identifies the Atlas user to request rate limits for. The ID can for example be the Service Account Client ID or the API Public Key. When this parameter is provided, the limits returned are applicable to the specified user. The requesting user must be the same as the specified user.

ipAddressstring
Example:127.0.0.1

An IP address to request rate limits for. When this parameter is provided, the limits returned are applicable to the specified IP address. The requesting user must have the same IP address as the one provided in the request.

Response

OK