Create Whitelist Entries for One Organization API Key¶
Create one or more new whitelist entries for the specified API Key.
All requests to this endpoint must originate from an IP address in the organization's API access list.
Request Path Parameters¶
Unique identifier for the Organization API Key for which you want to create a new whitelist entry.
Request Query Parameters¶
This endpoint may use any of the HTTP request query parameters available to all Atlas API resources. These are all optional.
Page number, starting with one, that Atlas returns of the total number of objects.
Number of items that Atlas returns per page, up to a maximum of 500.
Flag that indicates whether Atlas returns the totalCount parameter in the response body.
Flag that indicates whether Atlas returns the JSON response in the prettyprint format.
Flag that indicates whether Atlas wraps the response in an envelope.
Some API clients cannot access the HTTP response headers or
status code. To remediate this, set
Endpoints that return a list of results use the results object as an envelope. Atlas adds the status parameter to the response body.
Request Body Parameters¶
Specify an array of documents, where each document represents one whitelist entry you want to add to the project. You must specify an array even if you are only associating a single whitelist entry to the project.
When you submit a
POST request containing
cidrBlock values which are not already present in the whitelist,
Atlas adds those entries to the list of existing entries in the
whitelist. Atlas does not set the whitelist to only contain the
entries specified in the request.
Atlas supports up to 500 API Keys within a single organization.
In the following table,
[i] represents an array index.
IP address to be added to the whitelist for the API key. This field is mutually exclusive with the
Whitelist entry in CIDR notation to be added for the API key. This field is mutually exclusive with the
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.
array of objects
One object for each item detailed in the results Embedded Document section.
array of objects
One or more links to sub-resources and/or related resources. The relations between URL