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
Operações disponíveis
Autenticação
| Chave | Descrição | Onde | Exemplo |
|---|---|---|---|
| Authorization | Chave e segredo da API codificados em Base64, separados por dois pontos. | Headers | Basic <base64> |
Consulta Parâmetros
APP_CREATEFilter results by this event type.
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_DISABLEStart of time range for audit events. DateTime in ISO-8601 format.
End of time range for audit events. DateTime in ISO-8601 format.
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 number starting with page 1.
110030Number of elements per page.
Container containing the events array.
aaaaaaaa-bbbb-cccc-dddd-0123456789abUUID of the audit event
APP_CREATEThe type of the audit event.
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_DISABLEApplication created.A description of the event type
2018-07-04T11:41:32When the audit event was created.
user@example.orgEmail of the user whose account the audit event is associated with.
1234567The ID of the user that the audit event is associated with.
abcd1234The NEXMO_API_KEY of the Vonage API account that the audit event is associated with.
CDThe source of the event. CD: Customer Dashboard DEVAPI: via Developer API
CDDEVAPI192.0.2.0The IP address used to make the account change.
Customer DashboardDescription of the audit event source.
Customer DashboardDeveloper APIGBISO 3166-1 Alpha-2 country code recorded for the event.
aaaaaaaa-bbbb-cccc-dddd-0123456789abUUID of the app that was created
abcdef01Which account the app is associated with
aaaaaaaa-bbbb-cccc-dddd-0123456789abUUID of the app that was created
My Voice AppThe name of the application created
GETThe HTTP method used to make a callback to your application
GETPOSThttps://example.org/my-app-callbackThe URL used for a callback to your application
GETThe HTTP method used to make a callback to your application
GETPOSThttps://example.org/my-app-callbackThe URL used for a callback to your application
voiceThe type of application created
A link to this audit event object if you were to retrieve it individually.
https://api.nexmo.com/beta/audit/events/aaaaaaaa-bbbb-cccc-dddd-0123456789abURI of this document.
Container containing self, next and last page links.
http://api.nexmo.com/beta/audit/eventsURI of this document.
http://api.nexmo.com/beta/audit/events?page=2&size=30URI of the next document.
http://api.nexmo.com/beta/audit/events?page=2&size=30URI of the last document in the sequence.
Page containing results.
110030100The total number of items in this response (page).
120The total number of items across all pages.
2The number of pages of data in the response.
1Which page of the pagination sequence you are looking at.
Exemplo Resposta
{
"_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
}
}Autenticação
| Chave | Descrição | Onde | Exemplo |
|---|---|---|---|
| Authorization | Chave e segredo da API codificados em Base64, separados por dois pontos. | Headers | Basic <base64> |
An array of audit event types.
APP_CREATEThe type of the audit event.
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_DISABLEApplication created.A description of the event type
Exemplo Resposta
{
"eventTypes": [
{
"type": "APP_CREATE",
"description": "Application created."
}
]
}Autenticação
| Chave | Descrição | Onde | Exemplo |
|---|---|---|---|
| Authorization | Chave e segredo da API codificados em Base64, separados por dois pontos. | Headers | Basic <base64> |
aaaaaaaa-bbbb-cccc-dddd-0123456789abUUID of the audit event
APP_CREATEThe type of the audit event.
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_DISABLEApplication created.A description of the event type
2018-07-04T11:41:32When the audit event was created.
user@example.orgEmail of the user whose account the audit event is associated with.
1234567The ID of the user that the audit event is associated with.
abcd1234The NEXMO_API_KEY of the Vonage API account that the audit event is associated with.
CDThe source of the event. CD: Customer Dashboard DEVAPI: via Developer API
CDDEVAPI192.0.2.0The IP address used to make the account change.
Customer DashboardDescription of the audit event source.
Customer DashboardDeveloper APIGBISO 3166-1 Alpha-2 country code recorded for the event.
aaaaaaaa-bbbb-cccc-dddd-0123456789abUUID of the app that was created
abcdef01Which account the app is associated with
aaaaaaaa-bbbb-cccc-dddd-0123456789abUUID of the app that was created
My Voice AppThe name of the application created
GETThe HTTP method used to make a callback to your application
GETPOSThttps://example.org/my-app-callbackThe URL used for a callback to your application
GETThe HTTP method used to make a callback to your application
GETPOSThttps://example.org/my-app-callbackThe URL used for a callback to your application
voiceThe type of application created
A link to this audit event object if you were to retrieve it individually.
https://api.nexmo.com/beta/audit/events/aaaaaaaa-bbbb-cccc-dddd-0123456789abURI of this document.
Exemplo Resposta
{
"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"
}
}
}