Audit API

The Vonage Audit API allows you to view details of changes to your account. More information is available at https://developer.nexmo.com/en/audit/overview. Please note that the Audit API is currently in Beta

Download OpenAPI Specification

Available Operations

Retrieve audit events

Get a series of audit events describing changes made to your Vonage API account over time.

gethttps://api.nexmo.com/beta/audit/events

Authentication

Key	Description	Where	Example
Authorization	Base64 encoded API key and secret joined by a colon. Read more	Headers	`Basic <base64>`

Query Parameters

event_type

string

exampleAPP_CREATE

Filter results by this event type.

Must be one of:USER_STATUSUSER_UPDATEUSER_BILLING_UPDATEUSER_CREATEUSER_LOGINUSER_LOGOUTUSER_PRODUCT_SEARCHUSER_API_KEYS_UPDATEACCOUNT_SECRET_DELETEACCOUNT_SECRET_CREATEACCOUNT_UPDATE_SPAMMERACCOUNT_UPDATE_SETTINGS_APINUMBER_ASSIGNNUMBER_UPDATEDNUMBER_RELEASENUMBER_LINKEDNUMBER_UNLINKEDAPP_CREATEAPP_UPDATEAPP_DELETEAPP_DISABLEAPP_ENABLEIP_WHITELIST_CREATEIP_WHITELIST_DELETEAUTORELOAD_ENABLEAUTORELOAD_UPDATEAUTORELOAD_DISABLE

date_from

string

Start of time range for audit events. DateTime in ISO-8601 format.

date_to

string

End of time range for audit events. DateTime in ISO-8601 format.

search_text

string

Return only audit events where the JSON object contains this search text. Must be legal text for a JSON attribute value, that is quotes and braces must be escaped.

page

string

Page number starting with page 1.

size

integer

Min1

Max100

Default30

Number of elements per page.

Responses
Content Type
application/json

_embedded

object

Container containing the events array.

events

array

string

exampleaaaaaaaa-bbbb-cccc-dddd-0123456789ab

UUID of the audit event

event_type

string

exampleAPP_CREATE

The type of the audit event.

event_type_description

string

exampleApplication created.

A description of the event type

created_at

string(date-time)

example2018-07-04T11:41:32

When the audit event was created.

user_email

string(email)

exampleuser@example.org

Email of the user whose account the audit event is associated with.

user_id

integer

example1234567

The ID of the user that the audit event is associated with.

account_id

string

exampleabcd1234

The NEXMO_API_KEY of the Vonage API account that the audit event is associated with.

source

string

exampleCD

The source of the event. CD: Customer Dashboard DEVAPI: via Developer API

Must be one of:CDDEVAPI

source_ip

string(ipv4)

example192.0.2.0

The IP address used to make the account change.

source_description

string(A human readable description of the `source`.)

exampleCustomer Dashboard

Description of the audit event source.

Must be one of:Customer DashboardDeveloper API

source_country

string

exampleGB

ISO 3166-1 Alpha-2 country code recorded for the event.

context

One Of

appId

string

exampleaaaaaaaa-bbbb-cccc-dddd-0123456789ab

UUID of the app that was created

created

object

accountId

string

exampleabcdef01

Which account the app is associated with

appId

string

exampleaaaaaaaa-bbbb-cccc-dddd-0123456789ab

UUID of the app that was created

name

string

exampleMy Voice App

The name of the application created

answer_url

object

method

string

exampleGET

The HTTP method used to make a callback to your application

Must be one of:GETPOST

url

string(url)

examplehttps://example.org/my-app-callback

The URL used for a callback to your application

event_url

object

method

string

exampleGET

The HTTP method used to make a callback to your application

Must be one of:GETPOST

url

string(url)

examplehttps://example.org/my-app-callback

The URL used for a callback to your application

type

string

examplevoice

The type of application created

_links

object

A link to this audit event object if you were to retrieve it individually.

self

href

string(uri)

examplehttps://api.nexmo.com/beta/audit/events/aaaaaaaa-bbbb-cccc-dddd-0123456789ab

URI of this document.

_links

object

Container containing self, next and last page links.

self

object

href

string(uri)

examplehttp://api.nexmo.com/beta/audit/events

URI of this document.

object

href

string(uri)

examplehttp://api.nexmo.com/beta/audit/events?page=2&size=30

URI of the next document.

last

object

href

string(uri)

examplehttp://api.nexmo.com/beta/audit/events?page=2&size=30

URI of the last document in the sequence.

page

object

Page containing results.

size

integer

Min1

Max100

Default30

example100

The total number of items in this response (page).

totalElements

integer

example120

The total number of items across all pages.

totalPages

integer

example2

The number of pages of data in the response.

number

integer

example1

Which page of the pagination sequence you are looking at.

Example Response

{
   "_embedded": {
      "events": [
         {
            "id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
            "event_type": "APP_CREATE",
            "event_type_description": "Application created.",
            "created_at": "2018-07-04T11:41:32",
            "user_email": "user@example.org",
            "user_id": 1234567,
            "account_id": "abcd1234",
            "source": "CD",
            "source_ip": "192.0.2.0",
            "source_description": "Customer Dashboard",
            "source_country": "GB",
            "context": {
               "created": {
                  "accountId": "abcdef01",
                  "appId": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
                  "name": "My voice app",
                  "answer_url": {
                     "method": "GET",
                     "url": "https://example.org/call"
                  },
                  "type": "voice",
                  "event_url": {
                     "method": "POST",
                     "url": "https://example.org/event"
                  }
               }
            },
            "_links": {
               "self": {
                  "href": "https://api.nexmo.com/beta/audit/events/aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
               }
            }
         }
      ]
   },
   "_links": {
      "self": {
         "href": "http://api.nexmo.com/beta/audit/events"
      },
      "next": {
         "href": "http://api.nexmo.com/beta/audit/events?page=2&size=30"
      },
      "last": {
         "href": "http://api.nexmo.com/beta/audit/events?page=2&size=30"
      }
   },
   "page": {
      "size": 100,
      "totalElements": 120,
      "totalPages": 2,
      "number": 1
   }
}

Retrieve audit event types

Get audit event types.

optionshttps://api.nexmo.com/beta/audit/events

Authentication

Key	Description	Where	Example
Authorization	Base64 encoded API key and secret joined by a colon. Read more	Headers	`Basic <base64>`

Responses
Content Type
application/json

eventTypes

array

An array of audit event types.

type

string

exampleAPP_CREATE

The type of the audit event.

description

string

exampleApplication created.

A description of the event type

Example Response

{
   "eventTypes": [
      {
         "type": "APP_CREATE",
         "description": "Application created."
      }
   ]
}

Retrieve individual audit event

Get the specified audit event.

gethttps://api.nexmo.com/beta/audit/events/:id

Authentication

Key	Description	Where	Example
Authorization	Base64 encoded API key and secret joined by a colon. Read more	Headers	`Basic <base64>`

Path Parameters

string

Required

The UUID of the audit event to retrieve

Responses
Content Type
application/json

string

exampleaaaaaaaa-bbbb-cccc-dddd-0123456789ab

UUID of the audit event

event_type

string

exampleAPP_CREATE

The type of the audit event.

event_type_description

string

exampleApplication created.

A description of the event type

created_at

string(date-time)

example2018-07-04T11:41:32

When the audit event was created.

user_email

string(email)

exampleuser@example.org

Email of the user whose account the audit event is associated with.

user_id

integer

example1234567

The ID of the user that the audit event is associated with.

account_id

string

exampleabcd1234

The NEXMO_API_KEY of the Vonage API account that the audit event is associated with.

source

string

exampleCD

The source of the event. CD: Customer Dashboard DEVAPI: via Developer API

Must be one of:CDDEVAPI

source_ip

string(ipv4)

example192.0.2.0

The IP address used to make the account change.

source_description

string(A human readable description of the `source`.)

exampleCustomer Dashboard

Description of the audit event source.

Must be one of:Customer DashboardDeveloper API

source_country

string

exampleGB

ISO 3166-1 Alpha-2 country code recorded for the event.

context

One Of

appId

string

exampleaaaaaaaa-bbbb-cccc-dddd-0123456789ab

UUID of the app that was created

created

object

accountId

string

exampleabcdef01

Which account the app is associated with

appId

string

exampleaaaaaaaa-bbbb-cccc-dddd-0123456789ab

UUID of the app that was created

name

string

exampleMy Voice App

The name of the application created

answer_url

object

method

string

exampleGET

The HTTP method used to make a callback to your application

Must be one of:GETPOST

url

string(url)

examplehttps://example.org/my-app-callback

The URL used for a callback to your application

event_url

object

method

string

exampleGET

The HTTP method used to make a callback to your application

Must be one of:GETPOST

url

string(url)

examplehttps://example.org/my-app-callback

The URL used for a callback to your application

type

string

examplevoice

The type of application created

_links

object

A link to this audit event object if you were to retrieve it individually.

self

href

string(uri)

examplehttps://api.nexmo.com/beta/audit/events/aaaaaaaa-bbbb-cccc-dddd-0123456789ab

URI of this document.

Example Response

{
   "id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
   "event_type": "APP_CREATE",
   "event_type_description": "Application created.",
   "created_at": "2018-07-04T11:41:32",
   "user_email": "user@example.org",
   "user_id": 1234567,
   "account_id": "abcd1234",
   "source": "CD",
   "source_ip": "192.0.2.0",
   "source_description": "Customer Dashboard",
   "source_country": "GB",
   "context": {
      "created": {
         "accountId": "abcdef01",
         "appId": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
         "name": "My voice app",
         "answer_url": {
            "method": "GET",
            "url": "https://example.org/call"
         },
         "type": "voice",
         "event_url": {
            "method": "POST",
            "url": "https://example.org/event"
         }
      }
   },
   "_links": {
      "self": {
         "href": "https://api.nexmo.com/beta/audit/events/aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
      }
   }
}

Audit API

Available Operations

Retrieve audit events

Authentication

Query Parameters

Responses Content Typeapplication/json

Example Response

Retrieve audit event types

Authentication

Responses Content Typeapplication/json

Example Response

Retrieve individual audit event

Authentication

Path Parameters

Responses Content Typeapplication/json

Example Response

Responses
Content Type
application/json

Responses
Content Type
application/json

Responses
Content Type
application/json