{ "uuid": "06b58de4-d40f-4ef1-aa7c-ef3148c9f4d0", "lastMigration": 29, "name": "Audit API", "endpointPrefix": "beta/audit", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "fbcbfb72-2175-4518-a73c-14592e386f05", "documentation": "Retrieve audit events", "method": "get", "endpoint": "events", "responses": [ { "uuid": "13cf7794-f1a5-4671-b730-d10528be4592", "body": "{\n \"_embedded\": {\n \"events\": [\n {\n \"_links\": {\n \"self\": {\n \"href\": \"https://api.nexmo.com/beta/audit/events/aaaaaaaa-bbbb-cccc-dddd-0123456789ab\"\n }\n },\n \"account_id\": \"abcd1234\",\n \"context\": {\n \"created\": {\n \"accountId\": \"abcdef01\",\n \"answer_url\": {\n \"method\": \"GET\",\n \"url\": \"https://example.org/call\"\n },\n \"appId\": \"aaaaaaaa-bbbb-cccc-dddd-0123456789ab\",\n \"event_url\": {\n \"method\": \"POST\",\n \"url\": \"https://example.org/event\"\n },\n \"name\": \"My voice app\",\n \"type\": \"voice\"\n }\n },\n \"created_at\": \"2018-07-04T11:41:32\",\n \"event_type\": \"{{oneOf (array 'USER_STATUS' 'USER_UPDATE' 'USER_BILLING_UPDATE' 'USER_CREATE' 'USER_LOGIN' 'USER_LOGOUT' 'USER_PRODUCT_SEARCH' 'USER_API_KEYS_UPDATE' 'ACCOUNT_SECRET_DELETE' 'ACCOUNT_SECRET_CREATE' 'ACCOUNT_UPDATE_SPAMMER' 'ACCOUNT_UPDATE_SETTINGS_API' 'NUMBER_ASSIGN' 'NUMBER_UPDATED' 'NUMBER_RELEASE' 'NUMBER_LINKED' 'NUMBER_UNLINKED' 'APP_CREATE' 'APP_UPDATE' 'APP_DELETE' 'APP_DISABLE' 'APP_ENABLE' 'IP_WHITELIST_CREATE' 'IP_WHITELIST_DELETE' 'AUTORELOAD_ENABLE' 'AUTORELOAD_UPDATE' 'AUTORELOAD_DISABLE')}}\",\n \"event_type_description\": \"Application created.\",\n \"id\": \"aaaaaaaa-bbbb-cccc-dddd-0123456789ab\",\n \"source\": \"{{oneOf (array 'CD' 'DEVAPI')}}\",\n \"source_country\": \"GB\",\n \"source_description\": \"{{oneOf (array 'Customer Dashboard' 'Developer API')}}\",\n \"source_ip\": \"192.0.2.0\",\n \"user_email\": \"user@example.org\",\n \"user_id\": 1234567\n }\n ]\n },\n \"_links\": {\n \"last\": {\n \"href\": \"http://api.nexmo.com/beta/audit/events?page=2&size=30\"\n },\n \"next\": {\n \"href\": \"http://api.nexmo.com/beta/audit/events?page=2&size=30\"\n },\n \"self\": {\n \"href\": \"http://api.nexmo.com/beta/audit/events\"\n }\n },\n \"page\": {\n \"number\": 1,\n \"size\": 100,\n \"totalElements\": 120,\n \"totalPages\": 2\n }\n}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "8a745c6d-69d9-48d2-9689-bf44739b912c", "body": "{\n \"error\": \"Unauthorized\",\n \"message\": \"Full authentication is required. JWT was not found in \\\"Authorization\\\" HTTP header.\",\n \"status\": 401\n}", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "22852aa8-eaca-4bdd-923e-af0970090e9c", "body": "{\n \"error\": \"Forbidden\",\n \"message\": \"An example goes here\",\n \"status\": 403\n}", "latency": 0, "statusCode": 403, "label": "Forbidden", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "372eead1-25a1-477d-b1bb-4fbc3f5dfce5", "body": "{\n \"error\": \"Not Found\",\n \"message\": \"Event with provided id: aaaaaaaa-bbbb-cccc-dddd-0123456789ab was not found\",\n \"status\": 404\n}", "latency": 0, "statusCode": 404, "label": "Not Found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "6d570cc4-cf16-4d13-814d-96d0dc0766c6", "documentation": "Retrieve audit event types", "method": "options", "endpoint": "events", "responses": [ { "uuid": "66975555-bd18-4f1f-9a99-fcd61f6e6e94", "body": "{\n \"eventTypes\": [\n {\n \"description\": \"Application created.\",\n \"type\": \"{{oneOf (array 'USER_STATUS' 'USER_UPDATE' 'USER_BILLING_UPDATE' 'USER_CREATE' 'USER_LOGIN' 'USER_LOGOUT' 'USER_PRODUCT_SEARCH' 'USER_API_KEYS_UPDATE' 'ACCOUNT_SECRET_DELETE' 'ACCOUNT_SECRET_CREATE' 'ACCOUNT_UPDATE_SPAMMER' 'ACCOUNT_UPDATE_SETTINGS_API' 'NUMBER_ASSIGN' 'NUMBER_UPDATED' 'NUMBER_RELEASE' 'NUMBER_LINKED' 'NUMBER_UNLINKED' 'APP_CREATE' 'APP_UPDATE' 'APP_DELETE' 'APP_DISABLE' 'APP_ENABLE' 'IP_WHITELIST_CREATE' 'IP_WHITELIST_DELETE' 'AUTORELOAD_ENABLE' 'AUTORELOAD_UPDATE' 'AUTORELOAD_DISABLE')}}\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "76fb5d2e-1cf9-48b3-ac3b-282779a8d1d1", "body": "{\n \"error\": \"No Content\",\n \"message\": \"No content\",\n \"status\": 204\n}", "latency": 0, "statusCode": 204, "label": "No Content", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "313d3e18-7adf-45e1-aa8d-5bdf9ca328c7", "body": "{\n \"error\": \"Unauthorized\",\n \"message\": \"Full authentication is required. JWT was not found in \\\"Authorization\\\" HTTP header.\",\n \"status\": 401\n}", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "c5e60710-3f61-4bea-85bc-5ba897d64495", "body": "{\n \"error\": \"Forbidden\",\n \"message\": \"An example goes here\",\n \"status\": 403\n}", "latency": 0, "statusCode": 403, "label": "Forbidden", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7419392f-4299-4159-9b22-e77696a4491a", "documentation": "Retrieve individual audit event", "method": "get", "endpoint": "events/:id", "responses": [ { "uuid": "ca0616b4-4b0d-470b-9734-c5bd07a78b7f", "body": "{\n \"_links\": {\n \"self\": {\n \"href\": \"https://api.nexmo.com/beta/audit/events/aaaaaaaa-bbbb-cccc-dddd-0123456789ab\"\n }\n },\n \"account_id\": \"abcd1234\",\n \"context\": {\n \"created\": {\n \"accountId\": \"abcdef01\",\n \"answer_url\": {\n \"method\": \"GET\",\n \"url\": \"https://example.org/call\"\n },\n \"appId\": \"aaaaaaaa-bbbb-cccc-dddd-0123456789ab\",\n \"event_url\": {\n \"method\": \"POST\",\n \"url\": \"https://example.org/event\"\n },\n \"name\": \"My voice app\",\n \"type\": \"voice\"\n }\n },\n \"created_at\": \"2018-07-04T11:41:32\",\n \"event_type\": \"{{oneOf (array 'USER_STATUS' 'USER_UPDATE' 'USER_BILLING_UPDATE' 'USER_CREATE' 'USER_LOGIN' 'USER_LOGOUT' 'USER_PRODUCT_SEARCH' 'USER_API_KEYS_UPDATE' 'ACCOUNT_SECRET_DELETE' 'ACCOUNT_SECRET_CREATE' 'ACCOUNT_UPDATE_SPAMMER' 'ACCOUNT_UPDATE_SETTINGS_API' 'NUMBER_ASSIGN' 'NUMBER_UPDATED' 'NUMBER_RELEASE' 'NUMBER_LINKED' 'NUMBER_UNLINKED' 'APP_CREATE' 'APP_UPDATE' 'APP_DELETE' 'APP_DISABLE' 'APP_ENABLE' 'IP_WHITELIST_CREATE' 'IP_WHITELIST_DELETE' 'AUTORELOAD_ENABLE' 'AUTORELOAD_UPDATE' 'AUTORELOAD_DISABLE')}}\",\n \"event_type_description\": \"Application created.\",\n \"id\": \"aaaaaaaa-bbbb-cccc-dddd-0123456789ab\",\n \"source\": \"{{oneOf (array 'CD' 'DEVAPI')}}\",\n \"source_country\": \"GB\",\n \"source_description\": \"{{oneOf (array 'Customer Dashboard' 'Developer API')}}\",\n \"source_ip\": \"192.0.2.0\",\n \"user_email\": \"user@example.org\",\n \"user_id\": 1234567\n}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "060f67c6-1667-4782-a914-4489ebe362b9", "body": "{\n \"error\": \"Unauthorized\",\n \"message\": \"Full authentication is required. JWT was not found in \\\"Authorization\\\" HTTP header.\",\n \"status\": 401\n}", "latency": 0, "statusCode": 401, "label": "Unauthorized", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "c8ddf843-5259-46f0-898c-907bf670c448", "body": "{\n \"error\": \"Not Found\",\n \"message\": \"Event with provided id: aaaaaaaa-bbbb-cccc-dddd-0123456789ab was not found\",\n \"status\": 404\n}", "latency": 0, "statusCode": 404, "label": "Not Found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" } ], "proxyMode": false, "proxyHost": "", "proxyRemovePrefix": false, "tlsOptions": { "enabled": false, "type": "CERT", "pfxPath": "", "certPath": "", "keyPath": "", "caPath": "", "passphrase": "" }, "cors": true, "headers": [], "proxyReqHeaders": [{ "key": "", "value": "" }], "proxyResHeaders": [{ "key": "", "value": "" }], "data": [], "folders": [], "rootChildren": [ { "type": "route", "uuid": "fbcbfb72-2175-4518-a73c-14592e386f05" }, { "type": "route", "uuid": "6d570cc4-cf16-4d13-814d-96d0dc0766c6" }, { "type": "route", "uuid": "7419392f-4299-4159-9b22-e77696a4491a" } ] }