- API >
- API Resources >
- Organizations >
- API Keys >
- Get All Whitelist Entries for an API Key
Get All Whitelist Entries for an API Key¶
On this page
Retrieve information on all whitelist entries for the specified API Key.
Base URL: https://cloud.mongodb.com/api/atlas/v1.0
Resource¶
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 | Description | Default | ||||
---|---|---|---|---|---|---|---|
pageNum |
integer | Page number (1-based). | 1 |
||||
itemsPerPage |
integer | Maximum number of items to return, up to a maximum of 100. | 100 |
||||
pretty |
boolean | Indicates whether the response body should be in a prettyprint format. | false |
||||
envelope |
boolean | Indicates whether or not to wrap the response in an envelope. Some API clients cannot access the HTTP response headers or
status code. To remediate this, set For endpoints that return one result, response body includes:
For endpoints that return a list of results, the |
Request Body Parameters¶
This endpoint does not 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 | object array | This array includes one object for each item detailed in the results Embedded Document section. |
links | object array | This array includes one or more links to sub-resources and/or related resources. The relations between URLs are explained in the Web Linking Specification. |
totalCount | number | The count of the total number of items in the result set. It may be greater than the number of objects in the results array if the entire result set is paginated. |
results Embedded Document¶
Each result is one whitelist entry.
Name | Type | Description |
---|---|---|
cidrBlock |
string | CIDR-notated range of whitelisted IP addresses. |
count |
number | Total number of requests that have originated from this IP address. |
created |
date | Date this IP address was added to the whitelist. |
ipAddress |
string | Whitelisted IP address. |
lastUsed |
date | Date of the most recent request that originated from this IP address. This field only appears if at least one request has originated from this IP address, and is only updated when a whitelisted resource is accessed. |
lastUsedAddress |
string | IP address from which the last call to the API was issued. This field only appears if at least one request has originated from this IP address. |
links |
array | An array of documents, representing a link to one or more sub-resources and/or related resources such as list pagination. See Linking for more information. |