Delete One Access List Entry for an API Key¶

On this page

Resource
Response
Example Request
Example Response

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 Enable API Whitelisting for Your Organization.

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

Delete a specified address on the access list from the specified API Key.

Resource¶

copy

DELETE /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:

status	HTTP response code
envelope	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 does not use HTTP request body parameters.

Response¶

This endpoint returns an empty JSON document.

Example Request¶

copy

curl --user "{USERNAME}:{APIKEY}" --digest \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
  --request DELETE "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList/192.0.2.0%2F24"

Example Response¶

HTTP/1.1 204 No Content

← Create Access List Entries for One Organization API Key Organization API Keys on Projects →