Get All Whitelist Entries for One Organization API Key¶
Retrieve information on all whitelist entries for the specified API Key.
Base URL: https://cloud.mongodb.com/api/atlas/v1.0
Resource¶
GET /orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/whitelist
Request Path Parameters¶
Name | Type | Description |
---|---|---|
ORG-ID | string | Unique identifier for the organization to which the target API Key belongs. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access. |
API-KEY-ID | string | Unique identifier for the API Key for which you want to retrieve whitelist entries. Use the /orgs/{ORG-ID}/apiKeys endpoint to retrieve all API Keys for the specified organization to which the authenticated user has access. |
Request Query Parameters¶
This endpoint may use any of the HTTP request query parameters available to all Atlas API resources. These are all optional.
Name | Type | Necessity | Description | Default | ||||
---|---|---|---|---|---|---|---|---|
pageNum | integer | Optional | Page number (1-based). | 1 | ||||
itemsPerPage | integer | Optional | Maximum number of items to return, up to a maximum of 100. | 100 | ||||
includeCount | boolean | Optional | Specifies whether the response returns the totalCount field. | true | ||||
pretty | boolean | Optional | Indicates whether the response body should be in a prettyprint format. | false | ||||
envelope | boolean | Optional | Flag indicating if Atlas should wrap the response in a JSON envelope. Some API clients cannot access the HTTP response headers or
status code. To remediate this, set For endpoints that return one result, the response body includes:
For endpoints that return a list of results, the results object is an envelope. Atlas adds the status field to the response body. | false |
Request Body Parameters¶
This endpoint doesn't use HTTP request body parameters.
Response¶
Response Document¶
The response JSON document includes an array of result objects, an array of link objects and a count of the total number of result objects retrieved.
Name | Type | Description |
---|---|---|
results | array of objects | One object for each item detailed in the results Embedded Document section. |
links | array of objects | One or more links to sub-resources and/or related resources. The relations between URL |