- API >
- Public API Resources >
- API Keys
API Keys¶
Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Organization API Key Endpoints¶
Use the /orgs/{ORG-ID}/apiKeys resource to view, create, or delete
API Keys within the specified Ops Manager
organization.
The Organization API Key, or users with the
Organization Owner role in the
organization in which the
API Key belongs, can be access these
endpoints.
| Method | Endpoint | Description |
|---|---|---|
GET |
/orgs/{ORG-ID}/apiKeys | Get all API Keys associated with {ORG-ID}. |
GET |
/orgs/{ORG-ID}/apiKeys/{API-KEY-ID} | Get one API Key associated with {ORG-ID} by its ID. |
GET |
/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/whitelist | Get all whitelist entries that belong to {API-KEY-ID}. |
GET |
/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/whitelist/{IP-ADDRESS} | Get the whitelist entry for {API-KEY-ID} specified by
{IP-ADDRESS}. |
POST |
/orgs/{ORG-ID}/apiKeys | Create an API Key for the specified organization. |
POST |
/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/whitelist | Create one or more whitelist entries for {API-KEY-ID}. |
PATCH |
/orgs/{ORG-ID}/apiKeys/{API-KEY-ID} | Update one API Key associated with {ORG-ID}. |
DELETE |
/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID} | Delete the API Key with ID {API-KEY-ID}. |
DELETE |
/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/whitelist/{IP-ADDRESS} | Delete the whitelist entry for {API-KEY-ID} specified by
{IP-ADDRESS}. |
Organization API Keys on Projects Endpoints¶
Use the following resources to view, create and assign, or unassign Organization programmatic API Keys within the specified Ops Manager project.
The Organization API Key, or users with the Project Owner
role in the project in which the API Key
belongs, can be access these endpoints.
| Method | Endpoint | Description |
|---|---|---|
GET |
/groups/{GROUP-ID}/apiKeys | Get All Organization API Keys Assigned to One Project with ID
{GROUP_ID}. |
PATCH |
/groups/{GROUP-ID}/apiKeys/{API-KEY-ID} | Modify Roles of One Organization API Key to One Project. |
POST |
/groups/{GROUP-ID}/apiKeys | Create and Assign One Organization API Key to One Project. |
POST |
/groups/{GROUP-ID}/apiKeys/{API-KEY-ID} | Assign One Organization API Key to One Project. |
DELETE |
/groups/{GROUP-ID}/apiKeys/{API-KEY-ID} | Unassign One Organization API Key ({API-KEY-ID}) from One
Project. |