Create Access List Entries for One Organization API Key
On this page
All requests to this endpoint must originate from an IP address on the Ops Manager user's API access list. For complete documentation on configuring API access lists, see Require an API Access List for Your Organization.
Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Create one or more new access list entries for the specified API Key.
Resource
POST /orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList
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 Organization API Key for which you
want to create a new access list entry. |
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 For endpoints that return one result, response body includes:
For endpoints that return a list of results, the | None |
Request Body Parameters
Specify an array of documents, where each document represents one access list entry you want to add to the project. You must specify an array even if you are only associating a single access list entry to the project.
When you submit a POST request containing ipAddress or
cidrBlock values which are not already present in the access list,
Ops Manager adds those entries to the list of existing entries in the
access list. Ops Manager does not set the access list to only contain the
entries specified in the request.
Note
Ops Manager supports up to 500 API Keys within a single organization.
In the following table, [i] represents an array index.
Name | Type | Description |
|---|---|---|
[i].ipAddress | string | IP address to be added to the access list for the
API key. This field is mutually exclusive with the
cidrBlock field. |
[i].cidrBlock | string | Access list entry in CIDR notation to be added for the
API key. This field is mutually exclusive with the
ipAddress field. |
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 | array | Array includes one object for each item detailed in the
results Embedded Document section. |
links | array | 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 | Integer 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 object within the results array is one access list entry.
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
1 curl --user '{USER-ID}:{API-KEY}' --digest \ 2 --header 'Accept: application/json' \ 3 --header 'Content-Type: application/json' \ 4 --include \ 5 --request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList?pretty=true" \ 6 --data ' 7 [{ 8 "ipAddress" : "77.54.32.11" 9 }]'
Example Response
Response Header
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
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 "links" : [ { 3 "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList?pretty=true&pageNum=1&itemsPerPage=100", 4 "rel" : "self" 5 } ], 6 "results" : [ { 7 "cidrBlock" : "206.252.195.126/32", 8 "count" : 47, 9 "created" : "2019-01-24T16:26:37Z", 10 "ipAddress" : "206.252.195.126", 11 "lastUsed" : "2019-01-25T16:32:47Z", 12 "lastUsedAddress" : "206.252.195.126", 13 "links" : [ { 14 "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList/206.252.195.126", 15 "rel" : "self" 16 } ] 17 }, { 18 "cidrBlock" : "76.54.32.11/32", 19 "count" : 0, 20 "created" : "2019-01-24T21:09:05Z", 21 "ipAddress" : null, 22 "links" : [ { 23 "href" : "https://<OpsManagerHost>:<Port>/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList/76.54.32.11", 24 "rel" : "self" 25 } ] 26 } ], 27 "totalCount" : 2 28 }