Navigation

Unassign One Organization API Key from One Project

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

Resource

DELETE /orgs/{GROUP-ID}/apiKeys/{API-KEY-ID}

Request Path Parameters

Name Type Description
GROUP-ID string Unique identifier for the Project you wish to unassign from the API key. Use the /groups endpoint to retrieve all organizations to which the authenticated user has access.
API-KEY-ID string Unique identifier for the API key you want to update. Request the /groups/{GROUP-ID}/apiKeys endpoint to retrieve all API keys to which the authenticated user has access for the specified organization.

Request Query Parameters

The following query parameters are optional:

Name Type Description Default
pageNum integer Page number (1-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

Example Request

1
2
3
4
5
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
  --include \
  --request DELETE "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/5953c5f380eef53887615f9a/apiKeys/5d1d12c087d9d63e6d682438"

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}

Response Body

This endpoint does not return a response body.