- API >
- Public API Resources >
- Programmatic API Keys >
- Organization Programmatic API Keys
Organization Programmatic API Keys¶
Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Use the /orgs/{ORG-ID}/apiKeys
resource to view, create, or delete
Programmatic |api| Keys within the specified
Ops Manager organization.
Permissions¶
To use these endpoints, grant the following roles to an Project API Key or user in your Organization:
Role | Possible Action |
---|---|
Any role in the Organization | Retrieve Organization API Keys |
Organization Owner or
Organization User Admin |
Create, update, or delete a Organization API Key |
Endpoints¶
Method | Endpoint | Description |
---|---|---|
GET |
/orgs/{ORG-ID}/apiKeys | Get all API Keys for the organization identified with
{ORG-ID} . |
GET |
/orgs/{ORG-ID}/apiKeys/{API-KEY-ID} | Get one API Key for the organization identified with
{ORG-ID} . |
POST |
/orgs/{ORG-ID}/apiKeys | Create an API Key for the organization identified with
{ORG-ID} . |
PATCH |
/orgs/{ORG-ID}/apiKeys/{API-KEY-ID} | Update one API Key for the organization identified with
{ORG-ID} . |
DELETE |
/orgs/{ORG-ID}/apiKeys/{API-KEY-ID} | Delete the API Key with ID {API-KEY-ID} . |