Navigation

API Keys

Use the /orgs/{ORG-ID}/apiKeys resource to view, create, or delete API Keys within the specified Atlas organization.

Endpoints

These endpoints can be accessed by users with the Organization Owner role in the organization the API Key belongs to, or by the API Key itself.

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.
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}.
PATCH /api/atlas/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID} Update an API Key.
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}.
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}.