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

Télécharger la spécification OpenAPI
Opérations disponibles

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

Authentification

CléDescriptionOùExemple
Authorization

Clé et secret de l'API encodés en Base64 et reliés par deux points.
En savoir plus

Headers

Basic <base64>

Demande de renseignements Paramètres

event_type
string
exempleAPP_CREATE

Filter results by this event type.

Il doit s'agir de l'un d'entre eux :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
Défaut30

Number of elements per page.

Réponses
Type de contenu
application/json

OK

_embedded
object

Container containing the events array.

events
array
id
string
exempleaaaaaaaa-bbbb-cccc-dddd-0123456789ab

UUID of the audit event

event_type
string
exempleAPP_CREATE

The type of the audit event.

Il doit s'agir de l'un d'entre eux :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
event_type_description
string
exempleApplication created.

A description of the event type

created_at
string(date-time)
exemple2018-07-04T11:41:32

When the audit event was created.

user_email
string(email)
exempleuser@example.org

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

user_id
integer
exemple1234567

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

account_id
string
exempleabcd1234

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

source
string
exempleCD

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

Il doit s'agir de l'un d'entre eux :CDDEVAPI
source_ip
string(ipv4)
exemple192.0.2.0

The IP address used to make the account change.

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

Description of the audit event source.

Il doit s'agir de l'un d'entre eux :Customer DashboardDeveloper API
source_country
string
exempleGB

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

context
L'un des
appId
string
exempleaaaaaaaa-bbbb-cccc-dddd-0123456789ab

UUID of the app that was created

created
object
accountId
string
exempleabcdef01

Which account the app is associated with

appId
string
exempleaaaaaaaa-bbbb-cccc-dddd-0123456789ab

UUID of the app that was created

name
string
exempleMy Voice App

The name of the application created

answer_url
object
method
string
exempleGET

The HTTP method used to make a callback to your application

Il doit s'agir de l'un d'entre eux :GETPOST
url
string(url)
exemplehttps://example.org/my-app-callback

The URL used for a callback to your application

event_url
object
method
string
exempleGET

The HTTP method used to make a callback to your application

Il doit s'agir de l'un d'entre eux :GETPOST
url
string(url)
exemplehttps://example.org/my-app-callback

The URL used for a callback to your application

type
string
exemplevoice

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)
exemplehttps://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)
exemplehttp://api.nexmo.com/beta/audit/events

URI of this document.

next
object
href
string(uri)
exemplehttp://api.nexmo.com/beta/audit/events?page=2&size=30

URI of the next document.

last
object
href
string(uri)
exemplehttp://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
Défaut30
exemple100

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

totalElements
integer
exemple120

The total number of items across all pages.

totalPages
integer
exemple2

The number of pages of data in the response.

number
integer
exemple1

Which page of the pagination sequence you are looking at.

Exemple Réponse

{
   "_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

Authentification

CléDescriptionOùExemple
Authorization

Clé et secret de l'API encodés en Base64 et reliés par deux points.
En savoir plus

Headers

Basic <base64>

Réponses
Type de contenu
application/json

OK

eventTypes
array

An array of audit event types.

type
string
exempleAPP_CREATE

The type of the audit event.

Il doit s'agir de l'un d'entre eux :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
description
string
exempleApplication created.

A description of the event type

Exemple Réponse

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

Retrieve individual audit event

Get the specified audit event.

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

Authentification

CléDescriptionOùExemple
Authorization

Clé et secret de l'API encodés en Base64 et reliés par deux points.
En savoir plus

Headers

Basic <base64>

Trajectoire Paramètres

id
string
Exigée

The UUID of the audit event to retrieve

Réponses
Type de contenu
application/json

OK

id
string
exempleaaaaaaaa-bbbb-cccc-dddd-0123456789ab

UUID of the audit event

event_type
string
exempleAPP_CREATE

The type of the audit event.

Il doit s'agir de l'un d'entre eux :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
event_type_description
string
exempleApplication created.

A description of the event type

created_at
string(date-time)
exemple2018-07-04T11:41:32

When the audit event was created.

user_email
string(email)
exempleuser@example.org

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

user_id
integer
exemple1234567

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

account_id
string
exempleabcd1234

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

source
string
exempleCD

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

Il doit s'agir de l'un d'entre eux :CDDEVAPI
source_ip
string(ipv4)
exemple192.0.2.0

The IP address used to make the account change.

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

Description of the audit event source.

Il doit s'agir de l'un d'entre eux :Customer DashboardDeveloper API
source_country
string
exempleGB

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

context
L'un des
appId
string
exempleaaaaaaaa-bbbb-cccc-dddd-0123456789ab

UUID of the app that was created

created
object
accountId
string
exempleabcdef01

Which account the app is associated with

appId
string
exempleaaaaaaaa-bbbb-cccc-dddd-0123456789ab

UUID of the app that was created

name
string
exempleMy Voice App

The name of the application created

answer_url
object
method
string
exempleGET

The HTTP method used to make a callback to your application

Il doit s'agir de l'un d'entre eux :GETPOST
url
string(url)
exemplehttps://example.org/my-app-callback

The URL used for a callback to your application

event_url
object
method
string
exempleGET

The HTTP method used to make a callback to your application

Il doit s'agir de l'un d'entre eux :GETPOST
url
string(url)
exemplehttps://example.org/my-app-callback

The URL used for a callback to your application

type
string
exemplevoice

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)
exemplehttps://api.nexmo.com/beta/audit/events/aaaaaaaa-bbbb-cccc-dddd-0123456789ab

URI of this document.

Exemple Réponse

{
   "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"
      }
   }
}