Admin REST API

Retrieve SIEM, CSPM and Billing data using the Keeper Admin REST API

Overview

The Keeper Admin REST API provides scoped tokens for supported enterprise integrations. Use it to retrieve data for SIEM, CSPM, and billing systems.

The API performs these integrations without client-side data decryption. It does not require customer-hosted middleware.

Use the Service Mode REST API for broader platform or administration workflows. Service Mode exposes hundreds of Commander capabilities through a customer-hosted middleware service.

Prerequisites

• Enterprise Root Administrator permissions (required to create API tokens).
• Keeper Commander CLI installed to create and manage API tokens.

Manage API Tokens via Keeper Commander (CLI)

The Commander CLI includes a public-api-key command group with list, generate, and revoke operations. The snippets below summarize the most useful flows.

List API tokens

# Table view
public-api-key list

# JSON output to a file
public-api-key list --format json --output api_keys.json

# CSV export
public-api-key list --format csv --output api_keys.csv

Generate an API token

Each token is scoped to a specific integration, and grants access only to the API endpoints associated with that integration:

• SIEM — grants access to the SIEM / Audit Events API.
• CSPM — grants access to the Risk Management API.
• BILLING — grants access to the MSP Billing API.

# 30‑day SIEM key (Read) — for SIEM / Audit Events API
public-api-key generate --name "SIEM Integration" --integrations "SIEM:1" --expires 30d

# 30‑day CSPM key (Read) — for Risk Management API
public-api-key generate --name "CSPM Integration" --integrations "CSPM:1" --expires 30d

# 30‑day Billing key (Read) — for MSP Billing API
public-api-key generate --name "Billing Tool" --integrations "BILLING:1" --expires 30d

# Permanent key (never expires) with JSON output
public-api-key generate --name "Permanent Tool" --integrations "SIEM:1" --expires never --format json --output backup_key.json

Integration and action codes

• Integrations: SIEM (SIEM / Audit Events API), CSPM (Risk Management API), BILLING (MSP Billing API)
• Actions: 1 = READ, 2 = READ_WRITE
• Expiration options: 24h, 7d, 30d, 1y, never

Example: --integrations "CSPM:1" means CSPM (read), used for calling the Risk Management API.

Revoke an API token

# Interactive confirmation
public-api-key revoke <token_value>

# Force (no prompt)
public-api-key revoke <token_value> --force

Security Notes

• Treat API tokens like passwords; rotate them on a schedule.
• Restrict permissions to the minimum required roles and actions.
• Prefer short expirations; use never only for special automation cases.
• Store tokens in a secure location (e.g., Keeper Vault).

API Specs

• ARAM Events
• Risk Management (CSPM)
• MSP Billing