Docs Menu
Docs Home
/
MongoDB Ops Manager
/
API
/
Ops Manager Administration API Resources
/
Programmatic API Keys
/
Organization Programmatic API Key Access Lists

Get One Access List Entry for One Organization API Key

On this page

  • Resource
  • Request Path Parameters
  • Request Query Parameters
  • Request Body Parameters
  • Response
  • Example Request
  • Example Response
  • Response Header
  • Response Body

Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

Retrieve information on a single API Key access list entry using the unique identifier for the API Key and desired IP address.

Resource

GET /orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList/{ACCESS-LIST-ENTRY}

Request Path Parameters

Name
Type
Description
ORG-ID
string
Unique identifier for the organization to which the target API Key belongs. Request 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 access list entries. Request 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
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

The following query parameters are optional:

Name
Type
Description
Default
pageNum
integer
Page number (1-index based).
1
itemsPerPage
integer
Number of items to return per page, up to a maximum of 500.
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 "envelope" : true in the query.

For endpoints that return one result, response body includes:

Name
Description
status
HTTP response code
content
Expected response body

For endpoints that return a list of results, the results object is an envelope. Ops Manager adds the status field to the response body.

None

Request Body Parameters

This endpoint doesn't use HTTP request body parameters.

Response

Name
Type
Description
cidrBlock
string
CIDR-notated range of IP addresses in the access list.
count
number
Total number of requests that have originated from this IP address.
created
date
Date this IP address was added to the access list.
ipAddress
string
IP address in the access list.
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 resource is retrieved from the access list.
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

1curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2  --header "Accept: application/json" \
3  --header "Content-Type: application/json" \
4  --request GET "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList/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}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

Response Body

1{
2    "cidrBlock": "192.0.2.0/24",
3    "count": 0,
4    "created": "2019-11-01T14:32:57Z",
5    "links": [
6        {
7            "href": "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList/192.0.2.0%2F24",
8            "rel": "self"
9        },
10        {
11            "href": "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}",
12            "rel": "http://mms.mongodb.com/apiKeys"
13        }
14    ]
15}

Back

Get All Access List Entries for One Organization API Key

Next

Create Access List Entries for One Organization API Key