Nexmo Audit API
Browse all Nexmo APIs★ Only Publicly Available OpenAPI DocumentSecurityCompliancebasic2 EndpointsREST
For Agents
Retrieve and filter Vonage account audit events for compliance, SIEM forwarding, and security investigation.
Use for: List audit events on my Vonage account, Filter Vonage audit events by event type, Get a single Vonage audit event by id, Find audit events between two dates
Not supported: Does not modify account settings, send notifications, or replay events — use for read-only Vonage account audit trail retrieval only.
The Vonage Audit API (audit-api) exposes a read-only stream of changes made to a Vonage account. It records application configuration changes, user secret creations and deletions, and account-level setting updates with timestamps, actor identifiers, and before/after diffs. The 2 endpoints — paginated list and single-event retrieval — cover the surface needed to drive compliance dashboards, SIEM integration, and incident triage. Vonage flags this API as beta on the /beta/audit base path.
Install Jentic One Beta
Connect the Audit API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Audit API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
Capabilities
What an agent can do with Audit API.
Retrieve a paginated stream of Vonage account audit events for compliance review
Filter audit events by event type to surface specific changes such as secret rotations or webhook updates
Filter audit events by date range to bound an investigation to a specific incident window
Retrieve a single audit event by id to inspect its full context, actor, and changed fields
Stream audit events into an external SIEM for long-term retention beyond Vonage's window
Use Cases
Patterns agents use Audit API for, with concrete tasks.
★ Investigate an unauthorised webhook change
When a security alert flags an unexpected webhook URL change, an investigator needs to identify which actor made the change and when. GET /events with event_type and date_from filters returns the audit trail for the change. GET /events/{id} returns the full context. Together they cut investigation time from hours to minutes.
GET /events?event_type=APPLICATION:UPDATE&date_from=2026-06-01 then GET /events/{id} for the matching event to retrieve the full record.
Stream audit events to SIEM
Compliance frameworks often require all account changes be retained outside the vendor for 7+ years. A scheduled job calls GET /events with a rolling cursor, transforms each event into the SIEM's schema, and ships it to long-term storage. Effort is roughly one day for the cursor logic and field mapping.
GET /events with cursor-based pagination since the last sync timestamp and forward each event to the SIEM ingest endpoint.
Quarterly access review export
Quarterly access reviews require a list of every secret created or revoked in the last 90 days. GET /events filtered to USER:SECRET_CREATE and USER:SECRET_DELETE returns the full set. Output is fed into the access review packet for sign-off.
GET /events?event_type=USER:SECRET_DELETE for the last 90 days and write each entry to the quarterly review CSV.
Agent-driven incident triage
When a paging agent receives a security alert, it searches Jentic for 'list vonage audit events', loads GET /events, and pulls the events around the alert timestamp. The agent enriches the page with the actor and event_type and posts to the incident channel — credentials stay in the Jentic vault.
Search Jentic for 'list vonage audit events', load GET /events schema, and execute with date_from set to 30 minutes before the alert timestamp.
Key Endpoints
2 endpoints — the vonage audit api (audit-api) exposes a read-only stream of changes made to a vonage account.
METHOD
PATH
DESCRIPTION
GET
/events
Retrieve paginated audit events
GET
/events/{id}
Retrieve an individual audit event
GET
/events
Retrieve paginated audit events
GET
/events/{id}
Retrieve an individual audit event
Why Jentic?
Three things that make agents converge on Jentic-routed access.
Credential isolation
Vonage uses HTTP Basic auth with API key and API secret. Jentic stores both in the encrypted MAXsystem vault and injects them per call. The agent never sees the raw secret and credentials are scoped per workflow.
Intent-based discovery
Agents search by intent (e.g. 'check my Vonage account balance') and Jentic returns the matching Vonage operation with its input schema, so the agent calls the right endpoint without browsing developer.vonage.com.
Time to first call
Direct integration: 1-2 days for Basic auth, error handling, and balance checks. Through Jentic: under 30 minutes — search, load schema, execute.
Related APIs
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using Audit API through Jentic.
What authentication does the Vonage Audit API use?
It uses HTTP Basic authentication with the Vonage API key and API secret. Jentic stores both in the encrypted MAXsystem vault and injects them per call. The Audit API is currently in beta on the /beta/audit base path.
What event types does the Vonage Audit API expose?
GET /events returns event records covering application creation and update, user secret creation and deletion, and account-level setting changes. Filter via the event_type query parameter to narrow the stream.
What are the rate limits for the Vonage Audit API?
The Audit API is read-only and Vonage does not publish a per-second cap in the spec. Treat it as eventually consistent — events may take a short interval to appear after the underlying change.
How do I export audit events through Jentic with the Vonage Audit API?
Run pip install jentic, search Jentic for 'list vonage audit events', load GET /events, and execute with date_from and date_to. Cursor-paginate via the page parameter until exhausted to back up the full window.
Can I retrieve a specific audit event by id with the Vonage Audit API?
Yes. GET /events/{id} returns the full record for one event including actor, timestamp, source IP, and the before/after diff of the changed fields.
Is the Vonage Audit API considered stable?
Vonage flags the Audit API as beta in the spec description. The shape may change before GA, so wrap the response parser in a tolerant adapter and pin to spec version 1.0.4 for production use.
GET STARTED