Update One Global Access List Entry¶

On this page

Resource
Required Roles
Request Parameters
Response
Example Request
Example Response
- Response Header
- Response Body

Update the values of one Global Access List Entry using the unique identifier for the desired IP address.

To find a specific Global Access List Entry, get the list of Global Access List Entries, then find the {ACCESS-LIST-ID} you need.

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

Resource¶

copy

PATCH /admin/accessList/{ACCESS-LIST-ID}

Required Roles¶

Requires that the API Key calling this endpoint have the Global Owner role.

Request Parameters¶

Request Path Parameters¶

Name	Type	Description
`ACCESS-LIST-ID`	string	Unique identifier for the Global Access List Entry.

Request Query Parameters¶

The following query parameters 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 that 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, the response body includes:

Name	Description
status	HTTP response code
envelope	Expected response body

false

Request Body Parameters¶

This endpoint does not use HTTP request body parameters.

Response¶

Name	Type	Description
`cidrBlock`	string	Range of IP addresses in an access list in IPv4 or IPv6 CIDR notation.
`created`	string	Timestamp, in the number of seconds that have elapsed since the UNIX epoch when you added this CIDR block to the Global Access List.
`description`	string	Explanation of the purpose of this Global Access List Entry.
`id`	string	Unique identifier for this Global Access List Entry.
`type`	string	Scope of the Global Access List Entry.
`updated`	string	Timestamp, in the number of seconds that have elapsed since the UNIX epoch when you last changed the CIDR block of this Global Access List Entry.

Example Request¶

copy

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
  --request PATCH "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/accessList/{ACCESS-LIST-ID}?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¶

{
  "cidrBlock" : "127.0.0.1/32",
  "created" : "2019-09-04T17:45:33Z",
  "description" : "Docs Example",
  "expires" : null,
  "id" : "{ACCESS-LIST-ID}",
  "lastUsed" : null,
  "type" : "GLOBAL_ROLE",
  "updated" : "2019-09-04T17:45:33Z"
}

← Create One Global Access List Entry Delete One Access List Entry for a Global API Key →