Get One Whitelist Entry for One Organization API Key¶

Retrieve information on a single API Key whitelist entry using the unique identifier for the API Key and desired whitelisted address.

Base URL: https://cloud.mongodb.com/api/atlas/v1.0

Resource¶

GET /orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/whitelist/{IP-ADDRESS}

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.
`WHITELIST-ENTRY`	string	The IP or CIDR address. If the entry includes a subnet mask, such as `192.0.2.0/24`, use the URL-encoded value `%2F` for the forward slash `/`.

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 envelope=true in the query.

For endpoints that return one result, the response body includes:

status	HTTP response code
envelope	Expected response body

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¶

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.

Example Request¶

1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest --include \
2   --header "Accept: application/json" \
3   --header "Content-Type: application/json" \
4   --request GET "https://cloud.mongodb.com/api/atlas/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/whitelist/192.0.2.0%2F24?pretty=true"

Example Response¶

Response Header¶

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive

HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}

Response Body¶

1 {
2     "cidrBlock": "192.0.2.0/24",
3     "count": 0,
4     "created": "{ISO-TIMESTAMP}",
5     "links": [
6         {
7             "href": "https://cloud.mongodb.com/api/atlas/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/whitelist/192.0.2.0%2F24",
8             "rel": "self"
9         },
10         {
11             "href": "https://cloud.mongodb.com/api/atlas/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}",
12             "rel": "http://mms.mongodb.com/apiKeys"
13         }
14     ]
15 }

Give Feedback

← Get All Whitelist Entries for One Organization API Key Delete One Whitelist Entry for One Organization API Key →

1	curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest --include \
2	--header "Accept: application/json" \
3	--header "Content-Type: application/json" \
4	--request GET "https://cloud.mongodb.com/api/atlas/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/whitelist/192.0.2.0%2F24?pretty=true"

1	{
2	"cidrBlock": "192.0.2.0/24",
3	"count": 0,
4	"created": "{ISO-TIMESTAMP}",
5	"links": [
6	{
7	"href": "https://cloud.mongodb.com/api/atlas/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/whitelist/192.0.2.0%2F24",
8	"rel": "self"
9	},
10	{
11	"href": "https://cloud.mongodb.com/api/atlas/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}",
12	"rel": "http://mms.mongodb.com/apiKeys"
13	}
14	]
15	}