atlas api rateLimiting listRateLimits

/rateLimits?endpointPath=%2Fapi%2Fatlas%2Fv2%2Fclusters&endpointPath=%2Fapi%2Fatlas%2Fv2%2Fgroups%2F%7BgroupId%7D%2F

false

Filters the returned endpoint sets by the provided endpoint path. Multiple paths may be provided, for example /rateLimits?endpointPath=%2Fapi%2Fatlas%2Fv2%2Fclusters&endpointPath=%2Fapi%2Fatlas%2Fv2%2Fgroups%2F%7BgroupId%7D%2F. Replace /, { and } with their URL-encoded values (%2F, %7B and %7D respectively).

envelope

false

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.

string

false

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

false

help for listRateLimits

string

false

An IP address to request rate limits for. When this parameter is provided, only IP scoped endpoint sets are returned and 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.

int

false

Number of items that the response returns per page.

/rateLimits?name=Name1&name=Name2

false

Filters the returned endpoint sets by the provided endpoint set name. Multiple names may be provided, for example /rateLimits?name=Name1&name=Name2. For names that use spaces, replace the space with its URL-encoded value (%20).

string

false

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

string

false

preferred api format, can be ["json", go-template] This value defaults to "json".

string

false

file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip)

int

false

Number of the page that displays the current set of the total objects that the response returns.

false

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

string

false

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, only user scoped endpoint sets are returned and the limits returned are applicable to the specified user. The requesting user must be the same as the specified user.

string

false

api version to use when calling the api call [options: "2025-03-12", "preview"], defaults to the latest version or the profiles api_version config value if set This value defaults to "preview".