Community OpenAPI document · agent-readySecurityCompliancebasic2 EndpointsREST
Know of an official OpenAPI document? Contribute it →
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://jentic.com/install.sh?src=apis&api=%2Fapis%2Fnexmo.com%2Fvonage-audit-api" | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fnexmo.com%2Fvonage-audit-api" | 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 your Jentic One instance.
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
Jentic AI Readiness Score
This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.
A
Audit API
- Foundational (D-)43/100
93
Foundational Compliance75
Developer Experience & Jentic Compatibility58
AI-Readiness & Agent Experience94
Agent Usability10
Security100
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
93
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: A+Signals: 4
99%
Lint Results
Aggregated quality score from linter diagnostics, weighted by severity.
100%
Resolution Completeness
Percentage of `$ref` references that resolve successfully.
100%
Specification Validity
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
75%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
75
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: A-Signals: 4
52%
Example Density
How richly the API is illustrated with examples.
96%
Example Validity
Percentage of examples that conform to their schemas.
50%
Response Coverage
Percentage of operations with complete response definitions (success, client error, server error).
100%
Tooling Readiness
Health of API ingestion, bundling, and resolution within Jentic pipelines.
58
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: C+Signals: 4
73%
Description Coverage
Coverage of descriptions across API elements.
0%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
100%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
60%
Summary Coverage
Coverage of summaries across operations/tags/info.
94
Agent Usability
Functional utility, complexity comfort, and AI orchestration readiness.
Grade: A+Signals: 1
94%
Complexity Comfort
Agent comfort level based on API operational and structural complexity.
10
Security
Trust, risk posture, and security compliance.
Grade: FSignals: 1
10%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
100
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: A+Signals: 1
100%
Descriptive Richness
Clarity and depth of descriptions across API elements.
Score it yourself
Every API in the directory is allowlisted, so you can re-score it with no key required.
npx @jentic/api-scorecard-cli score <openapi-url>Why Jentic?
What agents get from Jentic-routed access to this vendor.
Setup
Wiring the Vonage Audit API by hand means setting up HTTP Basic auth with your API key and secret, pointing at the beta/audit host, and paging through the audit event trail yourself. Through Jentic you install once, import the Audit API from the API Directory, store the key and secret once, and your agent calls it.
Permission scoping
The Audit API puts the event id in the URL path (/events/{id}), so a rule can pin your agent to reading one event or the event list. This surface is read-only, so the agent has only retrieval operations to call and no way to modify account state.
Credential isolation
Your Vonage API key and secret are stored once, encrypted, by your own Jentic One instance and injected as the Basic auth header at execution time. They never enter the agent's prompt, logs, or context.
Intent-based discovery
Agents search Jentic by intent such as 'list Vonage account audit events' or 'read a single audit event', and Jentic returns the matching Audit API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.
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 Jentic One instance 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.
Can I limit what my agent is allowed to do with the Vonage Audit API?
Yes. Jentic One is self-hosted by you, so your own rules decide which operations and credentials the agent may use. This API is read-only and exposes just two operations, GET /events to list audit events and GET /events/{id} to read a single event, so you can allow only those retrieval calls and the agent has no way to modify account settings. Because the event id sits in the URL path, you can pin the agent to reading the event list or a specific event.
GET STARTED