Get One Access List Entry for One Organization API Key¶
Retrieve information on a single API Key access list entry using the unique identifier for the API Key and desired permitted address.
Resource¶
Base URL: https://cloud.mongodb.com/api/atlas/v1.0
GET /orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList/{ACCESS-LIST-ENTRY}
Request Path Parameters¶
Name | Type | Necessity | Description |
---|---|---|---|
ORG-ID | string | Required | 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 | Required | Unique identifier for the API Key for which you want to retrieve access list entries. Use the /orgs/{ORG-ID}/apiKeys endpoint to retrieve all API Keys for the specified organization to which the authenticated user has access. |
ACCESS-LIST-ENTRY | string | Required | IP address or CIDR block. 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 might use any of the HTTP request query parameters available to all Atlas API resources. All of these are optional.
Name | Type | Necessity | Description | Default | ||||
---|---|---|---|---|---|---|---|---|
pretty | boolean | Optional | Flag indicating 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. This option may be needed for some API clients. These 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:
| false |
Request Body Parameters¶
This endpoint doesn't use HTTP request body parameters.
Response¶
Name | Type | Description |
---|---|---|
cidrBlock | string | CIDR |