- API >
- Public API Resources >
- Programmatic API Keys >
- Global Programmatic API Keys >
- Delete One Global API Key
Delete One Global API Key¶
On this page
Delete one Global API Key from Ops Manager using the unique identifier for that Key.
Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource¶
Required Roles¶
Requires that the API Key calling this endpoint have the
Global Owner
role.
Request Parameters¶
Request Path Parameters¶
All request path parameters are required.
Name | Type | Description |
---|---|---|
API-KEY-ID |
string | Unique identifier for the API key you want to delete. Use the /admin/apiKeys endpoint to retrieve all API keys to which the authenticated user has access. |
Request Query Parameters¶
The following query parameters are optional:
Name | Type | Description | Default | ||||||
---|---|---|---|---|---|---|---|---|---|
pretty |
boolean | Flag indicating whether the response body should be in a prettyprint format. | false |
||||||
envelope |
boolean | Flag indicating 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, the response body includes:
|
false |
Request Body Parameters¶
This endpoint does not use HTTP request body parameters.
Response¶
This endpoint does not have response elements.