Navigation

Global Programmatic API Key Whitelists

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

Use the /admin/whitelist resource to view, create, or delete Global Whitelist Entries, used in conjunction with Global Programmatic API Keys.

See also

To learn more about Global Whitelist Entries, see Global Whitelists.

Permissions

To use these endpoints, grant the following roles to an Project API Key or user in your Organization:

Role Possible Action
Any Global role Retrieve Global Whitelist Entries
Global Owner or Global User Admin Create, update, or delete a Global Whitelist Entry

Endpoints

Method Endpoint Description
GET /admin/whitelist Get all global whitelist entries.
GET /admin/whitelist/{WHITELIST-ID} Get one global whitelist entry.
POST /admin/whitelist Create one global whitelist entry.
PATCH /admin/whitelist/{WHITELIST-ID} Update the global whitelist entry specified by {WHITELIST-ID}.
DELETE /admin/whitelist/{WHITELIST-ID} Delete the global whitelist entry specified by {WHITELIST-ID}.