Get one rate limit endpoint set.
The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.
This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/ja-jp/docs/api/doc/atlas-admin-api-v2/operation/operation-getratelimit.
For more information and examples, see the referenced API documentation linked above.
Syntax
atlas api rateLimiting getRateLimit [options]
Options
Name | Type | Required | Description |
|---|---|---|---|
--endpointSetId | string | true | The ID of the rate limit endpoint set. |
--envelope | 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. |
--groupId | string | false | 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. |
-h, --help | false | help for getRateLimit | |
--ipAddress | string | false | 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. |
--orgId | string | false | 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. |
-o, --output | string | false | preferred api format, can be ["json", go-template] This value defaults to "json". |
--outputFile | 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) |
--pretty | false | Flag that indicates whether the response body should be in the prettyprint format. | |
--userId | 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, the limits returned are applicable to the specified user. The requesting user must be the same as the specified user. |
--version | 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". |
Inherited Options
Name | Type | Required | Description |
|---|---|---|---|
-P, --profile | string | false | Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |
Examples
atlas api rateLimiting getRateLimit --version preview --endpointSetId rateLimitsInspection_group --groupId 32b6e34b3d91647abb20e7b8 --ipAddress 127.0.0.1 --orgId 32b6e34b3d91647abb20e7b8 --userId mdb_sa_id_1234567890abcdef12345678