{ "uuid": "e3f91c7a-a7b9-4c39-bbb5-4029d2d9a102", "lastMigration": 29, "name": "Account API", "endpointPrefix": "", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "5ba72e7e-7169-473b-8a1c-6e806fac1f73", "documentation": "Get Account Balance", "method": "get", "endpoint": "account/get-balance", "responses": [ { "uuid": "0d4ef068-d3a3-488c-82a1-daec0bcea1f0", "body": "{\n \"autoReload\": \"{{oneOf (array 'true' 'false')}}\",\n \"value\": 10.28\n}", "latency": 0, "statusCode": 200, "label": "The current balance of your account", "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": "51f7bdda-c65d-4e25-bf09-cdcc84a001b7", "body": "{\n \"error-code\": \"401\",\n \"error-code-label\": \"authentication failed\"\n}", "latency": 0, "statusCode": 401, "label": "Not Authorised. You must supply your `api_key` and `api_secret` as query parameters to this request", "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": "d0a409a7-a2fe-4571-bf31-4344355b995f", "documentation": "Register an email sender", "method": "post", "endpoint": "account/register-sender", "responses": [ { "uuid": "78a658da-0394-4652-8eb0-ec4128128b90", "body": "{\n \"application_ids\": [\n \"6ec9eb7de1d34e77ac2c0ad597c9554a\",\n \"5dba5838689f402dba0c77957e2181f3\"\n ],\n \"name\": \"optionalName\",\n \"provider\": \"{{oneOf (array 'email')}}\",\n \"value\": \"alice@company.com\"\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" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "31ee0a7b-d513-47a3-ae5d-8eb898f3e26d", "documentation": "Change Account Settings", "method": "post", "endpoint": "account/settings", "responses": [ { "uuid": "354f6ae5-c060-4549-8d44-7822103d1c93", "body": "{\n \"dr-callback-url\": \"https://example.com/webhooks/delivery-receipt\",\n \"max-calls-per-second\": 30,\n \"max-inbound-request\": 30,\n \"max-outbound-request\": 30,\n \"mo-callback-url\": \"https://example.com/webhooks/inbound-sms\"\n}", "latency": 0, "statusCode": 200, "label": "OK. Settings were updated if supplied, the details of the current settings are included in the response.", "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": "deda5437-c05d-4872-83a5-b673aae85afe", "body": "", "latency": 0, "statusCode": 401, "label": "Not Authorised. You must supply your `api_key` and `api_secret` as query parameters to this request", "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": "186c0194-ae48-4117-aedc-a449d1cc3cac", "documentation": "Top Up Account Balance", "method": "post", "endpoint": "account/top-up", "responses": [ { "uuid": "9edb9a7b-f638-4151-b28f-dd66ef7917c2", "body": "{\n \"error-code\": \"200\",\n \"error-code-label\": \"success\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "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": "a2ad7a1f-ae02-4109-9a38-be612ab43052", "body": "{\n \"error-code\": \"401\",\n \"error-code-label\": \"authentication failed\"\n}", "latency": 0, "statusCode": 401, "label": "Not Authorised", "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": "e5b2c147-3886-41e1-927e-31f39ce13aca", "documentation": "Retrieve API Secrets", "method": "get", "endpoint": "accounts/:api_key/secrets", "responses": [ { "uuid": "db54d346-9e3b-4362-b93f-d33d1e78d46b", "body": "{\n \"_embedded\": {\n \"secrets\": [\n {\n \"_links\": {\n \"self\": {\n \"href\": \"\"\n }\n },\n \"created_at\": \"2017-03-02T16:34:49Z\",\n \"id\": \"ad6dc56f-07b5-46e1-a527-85530e625800\"\n }\n ]\n },\n \"_links\": {\n \"self\": {\n \"href\": \"\"\n }\n }\n}", "latency": 0, "statusCode": 200, "label": "The list of your current API secrets", "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": "d777cd0c-04d4-4604-8c63-46d8503f741d", "body": "{\n \"detail\": \"You did not provide correct credentials.\",\n \"instance\": \"bf0ca0bf927b3b52e3cb03217e1a1ddf\",\n \"title\": \"Unauthorized\",\n \"type\": \"https://developer.nexmo.com/api-errors#unauthorized\"\n}", "latency": 0, "statusCode": 401, "label": "Credentials are missing or invalid", "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": "291087b7-6452-47de-9be0-5531ee5c2f13", "body": "{\n \"detail\": \"API key 'abc123' not found\",\n \"instance\": \"bf0ca0bf927b3b52e3cb03217e1a1ddf\",\n \"title\": \"Invalid API Key\",\n \"type\": \"https://developer.nexmo.com/api-errors#invalid-api-key\"\n}", "latency": 0, "statusCode": 404, "label": "Item 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": "d4d3a0fc-42a9-478c-b517-af8bdd2379c5", "documentation": "Create API Secret", "method": "post", "endpoint": "accounts/:api_key/secrets", "responses": [ { "uuid": "28b17dbf-f201-4f1b-b2b1-bd6da7202820", "body": "{\n \"_links\": {\n \"self\": {\n \"href\": \"\"\n }\n },\n \"created_at\": \"2017-03-02T16:34:49Z\",\n \"id\": \"ad6dc56f-07b5-46e1-a527-85530e625800\"\n}", "latency": 0, "statusCode": 201, "label": "Secret created", "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": "c48cf4b8-4323-4c00-b1d7-5e2b8065293d", "body": "{\n \"detail\": \"The request failed due to secret validation errors\",\n \"instance\": \"bf0ca0bf927b3b52e3cb03217e1a1ddf\",\n \"invalid_parameters\": [\n {\n \"name\": \"secret\",\n \"reason\": \"Does not meet complexity requirements\"\n }\n ],\n \"title\": \"Bad Request\",\n \"type\": \"https://developer.nexmo.com/api-errors/account/secret-management#validation\"\n}", "latency": 0, "statusCode": 400, "label": "Bad request. This usually indicates valid data but can also occur when a user has exceeded the allowed number of secrets on their account.", "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": "79bc7423-6d5b-4421-b7d7-0bf532a06ca4", "body": "{\n \"detail\": \"You did not provide correct credentials.\",\n \"instance\": \"bf0ca0bf927b3b52e3cb03217e1a1ddf\",\n \"title\": \"Unauthorized\",\n \"type\": \"https://developer.nexmo.com/api-errors#unauthorized\"\n}", "latency": 0, "statusCode": 401, "label": "Credentials are missing or invalid", "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": "1bb8cbc9-929f-45b0-82ca-a55c1f998bf6", "body": "{\n \"detail\": \"API key 'abc123' not found\",\n \"instance\": \"bf0ca0bf927b3b52e3cb03217e1a1ddf\",\n \"title\": \"Invalid API Key\",\n \"type\": \"https://developer.nexmo.com/api-errors#invalid-api-key\"\n}", "latency": 0, "statusCode": 404, "label": "Item 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": "d9d06ad6-cfc6-4bb5-9408-31e9b247919c", "documentation": "Revoke an API Secret", "method": "delete", "endpoint": "accounts/:api_key/secrets/:secret_id", "responses": [ { "uuid": "9ae3c6a4-8234-43be-9c54-67ff138dd3e9", "body": "", "latency": 0, "statusCode": 204, "label": "Revoked secret response (without body content)", "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": "d264fabb-06b7-4222-b8a2-1205de1350f5", "body": "{\n \"detail\": \"You did not provide correct credentials.\",\n \"instance\": \"bf0ca0bf927b3b52e3cb03217e1a1ddf\",\n \"title\": \"Unauthorized\",\n \"type\": \"https://developer.nexmo.com/api-errors#unauthorized\"\n}", "latency": 0, "statusCode": 401, "label": "Credentials are missing or invalid", "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": "00eef03c-79b3-4d86-9cfa-36d6c9881ea7", "body": "{\n \"detail\": \"Can not delete the last secret. The account must always have at least 1 secret active at any time\",\n \"instance\": \"bf0ca0bf927b3b52e3cb03217e1a1ddf\",\n \"title\": \"Secret Deletion Forbidden\",\n \"type\": \"https://developer.nexmo.com/api-errors/account/secret-management#delete-last-secret\"\n}", "latency": 0, "statusCode": 403, "label": "Operation forbidden by permissions or because this is the only API secret and you are required to have at least one.", "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": "c219643b-776b-4f98-b3e2-c8a46a926ecb", "body": "{\n \"detail\": \"API key 'abc123' not found\",\n \"instance\": \"bf0ca0bf927b3b52e3cb03217e1a1ddf\",\n \"title\": \"Invalid API Key\",\n \"type\": \"https://developer.nexmo.com/api-errors#invalid-api-key\"\n}", "latency": 0, "statusCode": 404, "label": "Item 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": "6d6d4d72-77f2-4717-9df9-a35eef606d1d", "documentation": "Retrieve one API Secret", "method": "get", "endpoint": "accounts/:api_key/secrets/:secret_id", "responses": [ { "uuid": "4278b766-900d-408a-bf75-4750f4e6afe0", "body": "{\n \"_links\": {\n \"self\": {\n \"href\": \"\"\n }\n },\n \"created_at\": \"2017-03-02T16:34:49Z\",\n \"id\": \"ad6dc56f-07b5-46e1-a527-85530e625800\"\n}", "latency": 0, "statusCode": 200, "label": "API secret response", "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": "b458080c-3b71-4a20-b4f1-e63b6c4b4468", "body": "{\n \"detail\": \"You did not provide correct credentials.\",\n \"instance\": \"bf0ca0bf927b3b52e3cb03217e1a1ddf\",\n \"title\": \"Unauthorized\",\n \"type\": \"https://developer.nexmo.com/api-errors#unauthorized\"\n}", "latency": 0, "statusCode": 401, "label": "Credentials are missing or invalid", "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": "e2885644-aaaa-4a2a-873d-05fd7c13ec33", "body": "{\n \"detail\": \"API key 'abc123' not found\",\n \"instance\": \"bf0ca0bf927b3b52e3cb03217e1a1ddf\",\n \"title\": \"Invalid API Key\",\n \"type\": \"https://developer.nexmo.com/api-errors#invalid-api-key\"\n}", "latency": 0, "statusCode": 404, "label": "Item 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": "5ba72e7e-7169-473b-8a1c-6e806fac1f73" }, { "type": "route", "uuid": "d0a409a7-a2fe-4571-bf31-4344355b995f" }, { "type": "route", "uuid": "31ee0a7b-d513-47a3-ae5d-8eb898f3e26d" }, { "type": "route", "uuid": "186c0194-ae48-4117-aedc-a449d1cc3cac" }, { "type": "route", "uuid": "e5b2c147-3886-41e1-927e-31f39ce13aca" }, { "type": "route", "uuid": "d4d3a0fc-42a9-478c-b517-af8bdd2379c5" }, { "type": "route", "uuid": "d9d06ad6-cfc6-4bb5-9408-31e9b247919c" }, { "type": "route", "uuid": "6d6d4d72-77f2-4717-9df9-a35eef606d1d" } ] }