{ "uuid": "823e9e58-4bc9-47ca-973f-a653fbcc2ebc", "lastMigration": 29, "name": "Postmark Account-level API", "endpointPrefix": "", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "d921ce76-7169-4e7a-93c5-19aa6a7db94f", "documentation": "List Domains", "method": "get", "endpoint": "domains", "responses": [ { "uuid": "faab7511-775a-4c75-9d9b-d3bc181bf80c", "body": "{\n \"Domains\": [\n {\n \"DKIMVerified\": {{faker 'datatype.boolean'}},\n \"ID\": {{faker 'number.int' max=99999}},\n \"Name\": \"\",\n \"ReturnPathDomainVerified\": {{faker 'datatype.boolean'}},\n \"SPFVerified\": {{faker 'datatype.boolean'}},\n \"WeakDKIM\": {{faker 'datatype.boolean'}}\n }\n ],\n \"TotalCount\": {{faker 'number.int' max=99999}}\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": "d713c518-e7be-45de-b8c7-de867aa31370", "body": "{\n \"ErrorCode\": {{faker 'number.int' max=99999}},\n \"Message\": \"\"\n}", "latency": 0, "statusCode": 422, "label": "An error was generated due to incorrect use of the API. See the Message associated with this response for more information.", "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": "2e9de3b0-4d04-4670-8f10-6c6cc161bfc9", "body": "", "latency": 0, "statusCode": 500, "label": "Indicates an internal server error occurred.", "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": "1b55a6e9-15eb-4dc5-ad15-905b17ee2c75", "documentation": "Create a Domain", "method": "post", "endpoint": "domains", "responses": [ { "uuid": "c121536a-24f2-4756-859a-e86d69f29138", "body": "{\n \"DKIMHost\": \"\",\n \"DKIMPendingHost\": \"\",\n \"DKIMPendingTextValue\": \"\",\n \"DKIMRevokedHost\": \"\",\n \"DKIMRevokedTextValue\": \"\",\n \"DKIMTestValue\": \"\",\n \"DKIMUpdateStatus\": \"\",\n \"DKIMVerified\": {{faker 'datatype.boolean'}},\n \"ID\": {{faker 'number.int' max=99999}},\n \"Name\": \"\",\n \"ReturnPathDomain\": \"\",\n \"ReturnPathDomainCNAMEValue\": \"\",\n \"ReturnPathDomainVerified\": {{faker 'datatype.boolean'}},\n \"SPFHost\": \"\",\n \"SPFTextValue\": \"\",\n \"SPFVerified\": {{faker 'datatype.boolean'}},\n \"SafeToRemoveRevokedKeyFromDNS\": {{faker 'datatype.boolean'}},\n \"WeakDKIM\": {{faker 'datatype.boolean'}}\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": "d4f2eb0c-8112-436f-a14f-c4f7550dfb75", "body": "{\n \"ErrorCode\": {{faker 'number.int' max=99999}},\n \"Message\": \"\"\n}", "latency": 0, "statusCode": 422, "label": "An error was generated due to incorrect use of the API. See the Message associated with this response for more information.", "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": "6c0dfd57-23e4-420d-b876-7037c0f73799", "body": "", "latency": 0, "statusCode": 500, "label": "Indicates an internal server error occurred.", "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": "a5259276-919e-41ce-a8b8-bcdb29258ec4", "documentation": "Delete a Domain", "method": "delete", "endpoint": "domains/:domainid", "responses": [ { "uuid": "9b4bb433-bc6d-4751-a1d8-ee0f4db2549d", "body": "{\n \"ErrorCode\": {{faker 'number.int' max=99999}},\n \"Message\": \"\"\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": "3658f6c3-e912-4eea-8704-c84429cc5223", "body": "{\n \"ErrorCode\": {{faker 'number.int' max=99999}},\n \"Message\": \"\"\n}", "latency": 0, "statusCode": 422, "label": "An error was generated due to incorrect use of the API. See the Message associated with this response for more information.", "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": "546881a4-c54d-414d-8b56-5f71dd08747c", "body": "", "latency": 0, "statusCode": 500, "label": "Indicates an internal server error occurred.", "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": "250453e9-9209-41aa-99df-a2eb2a9b552b", "documentation": "Get a Domain", "method": "get", "endpoint": "domains/:domainid", "responses": [ { "uuid": "14669663-b414-4fd3-9c71-9cc8f6ba106a", "body": "{\n \"DKIMHost\": \"\",\n \"DKIMPendingHost\": \"\",\n \"DKIMPendingTextValue\": \"\",\n \"DKIMRevokedHost\": \"\",\n \"DKIMRevokedTextValue\": \"\",\n \"DKIMTestValue\": \"\",\n \"DKIMUpdateStatus\": \"\",\n \"DKIMVerified\": {{faker 'datatype.boolean'}},\n \"ID\": {{faker 'number.int' max=99999}},\n \"Name\": \"\",\n \"ReturnPathDomain\": \"\",\n \"ReturnPathDomainCNAMEValue\": \"\",\n \"ReturnPathDomainVerified\": {{faker 'datatype.boolean'}},\n \"SPFHost\": \"\",\n \"SPFTextValue\": \"\",\n \"SPFVerified\": {{faker 'datatype.boolean'}},\n \"SafeToRemoveRevokedKeyFromDNS\": {{faker 'datatype.boolean'}},\n \"WeakDKIM\": {{faker 'datatype.boolean'}}\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": "9946a6c6-abc3-41f0-9e8c-7fd056ecbe21", "body": "{\n \"ErrorCode\": {{faker 'number.int' max=99999}},\n \"Message\": \"\"\n}", "latency": 0, "statusCode": 422, "label": "An error was generated due to incorrect use of the API. See the Message associated with this response for more information.", "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": "69933553-f5b5-4148-8d60-af4d41474f1d", "body": "", "latency": 0, "statusCode": 500, "label": "Indicates an internal server error occurred.", "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": "6d291c82-3dc8-4651-9cd8-2309b9ec69d9", "documentation": "Update a Domain", "method": "put", "endpoint": "domains/:domainid", "responses": [ { "uuid": "a9bc704b-ecb2-484f-9048-618317952496", "body": "{\n \"DKIMHost\": \"\",\n \"DKIMPendingHost\": \"\",\n \"DKIMPendingTextValue\": \"\",\n \"DKIMRevokedHost\": \"\",\n \"DKIMRevokedTextValue\": \"\",\n \"DKIMTestValue\": \"\",\n \"DKIMUpdateStatus\": \"\",\n \"DKIMVerified\": {{faker 'datatype.boolean'}},\n \"ID\": {{faker 'number.int' max=99999}},\n \"Name\": \"\",\n \"ReturnPathDomain\": \"\",\n \"ReturnPathDomainCNAMEValue\": \"\",\n \"ReturnPathDomainVerified\": {{faker 'datatype.boolean'}},\n \"SPFHost\": \"\",\n \"SPFTextValue\": \"\",\n \"SPFVerified\": {{faker 'datatype.boolean'}},\n \"SafeToRemoveRevokedKeyFromDNS\": {{faker 'datatype.boolean'}},\n \"WeakDKIM\": {{faker 'datatype.boolean'}}\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": "a01020a9-dfd0-43e8-92f5-ba8bef9206f3", "body": "{\n \"ErrorCode\": {{faker 'number.int' max=99999}},\n \"Message\": \"\"\n}", "latency": 0, "statusCode": 422, "label": "An error was generated due to incorrect use of the API. See the Message associated with this response for more information.", "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": "220b3fce-ca61-4f14-9b50-5f8d3a90954f", "body": "", "latency": 0, "statusCode": 500, "label": "Indicates an internal server error occurred.", "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": "1887f68d-d283-47fe-a57f-8cdcc43ba54f", "documentation": "Rotate DKIM Key", "method": "post", "endpoint": "domains/:domainid/rotatedkim", "responses": [ { "uuid": "915e695a-9e30-4d27-88b3-f062b7b6203b", "body": "{\n \"DKIMHost\": \"\",\n \"DKIMPendingHost\": \"\",\n \"DKIMPendingTextValue\": \"\",\n \"DKIMRevokedHost\": \"\",\n \"DKIMRevokedTextValue\": \"\",\n \"DKIMTestValue\": \"\",\n \"DKIMUpdateStatus\": \"\",\n \"DKIMVerified\": {{faker 'datatype.boolean'}},\n \"ID\": {{faker 'number.int' max=99999}},\n \"Name\": \"\",\n \"SafeToRemoveRevokedKeyFromDNS\": {{faker 'datatype.boolean'}},\n \"WeakDKIM\": {{faker 'datatype.boolean'}}\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": "32a785bb-ffd1-4afc-b923-28e1bfe413a1", "body": "{\n \"ErrorCode\": {{faker 'number.int' max=99999}},\n \"Message\": \"\"\n}", "latency": 0, "statusCode": 422, "label": "An error was generated due to incorrect use of the API. See the Message associated with this response for more information.", "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": "52b86409-0e0b-41b6-81fe-292dc14c528a", "body": "", "latency": 0, "statusCode": 500, "label": "Indicates an internal server error occurred.", "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": "b66beccb-a08d-4dd2-bd24-54e282d1fa13", "documentation": "Request DNS Verification for DKIM", "method": "put", "endpoint": "domains/:domainid/verifydkim", "responses": [ { "uuid": "4f78954b-6fb2-48ee-96a2-f810cb220351", "body": "{\n \"DKIMHost\": \"\",\n \"DKIMPendingHost\": \"\",\n \"DKIMPendingTextValue\": \"\",\n \"DKIMRevokedHost\": \"\",\n \"DKIMRevokedTextValue\": \"\",\n \"DKIMTestValue\": \"\",\n \"DKIMUpdateStatus\": \"\",\n \"DKIMVerified\": {{faker 'datatype.boolean'}},\n \"ID\": {{faker 'number.int' max=99999}},\n \"Name\": \"\",\n \"ReturnPathDomain\": \"\",\n \"ReturnPathDomainCNAMEValue\": \"\",\n \"ReturnPathDomainVerified\": {{faker 'datatype.boolean'}},\n \"SPFHost\": \"\",\n \"SPFTextValue\": \"\",\n \"SPFVerified\": {{faker 'datatype.boolean'}},\n \"SafeToRemoveRevokedKeyFromDNS\": {{faker 'datatype.boolean'}},\n \"WeakDKIM\": {{faker 'datatype.boolean'}}\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": "80aca03c-4f0d-4269-85eb-457b93f531a9", "body": "{\n \"ErrorCode\": {{faker 'number.int' max=99999}},\n \"Message\": \"\"\n}", "latency": 0, "statusCode": 422, "label": "An error was generated due to incorrect use of the API. See the Message associated with this response for more information.", "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": "cffdf0c6-e70e-4ccc-bd2f-a372a7e761e8", "body": "", "latency": 0, "statusCode": 500, "label": "Indicates an internal server error occurred.", "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": "dceba8bf-7d3e-434e-8de3-f150e51a3321", "documentation": "Request DNS Verification for Return-Path", "method": "put", "endpoint": "domains/:domainid/verifyreturnpath", "responses": [ { "uuid": "666a30ae-100c-4d51-8c34-1dcb7188be67", "body": "{\n \"DKIMHost\": \"\",\n \"DKIMPendingHost\": \"\",\n \"DKIMPendingTextValue\": \"\",\n \"DKIMRevokedHost\": \"\",\n \"DKIMRevokedTextValue\": \"\",\n \"DKIMTestValue\": \"\",\n \"DKIMUpdateStatus\": \"\",\n \"DKIMVerified\": {{faker 'datatype.boolean'}},\n \"ID\": {{faker 'number.int' max=99999}},\n \"Name\": \"\",\n \"ReturnPathDomain\": \"\",\n \"ReturnPathDomainCNAMEValue\": \"\",\n \"ReturnPathDomainVerified\": {{faker 'datatype.boolean'}},\n \"SPFHost\": \"\",\n \"SPFTextValue\": \"\",\n \"SPFVerified\": {{faker 'datatype.boolean'}},\n \"SafeToRemoveRevokedKeyFromDNS\": {{faker 'datatype.boolean'}},\n \"WeakDKIM\": {{faker 'datatype.boolean'}}\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": "5fe5adef-9232-4845-8fd5-b30b7c952724", "body": "{\n \"ErrorCode\": {{faker 'number.int' max=99999}},\n \"Message\": \"\"\n}", "latency": 0, "statusCode": 422, "label": "An error was generated due to incorrect use of the API. See the Message associated with this response for more information.", "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": "5b1c8d17-1501-42b7-bede-7759bdb8346b", "body": "", "latency": 0, "statusCode": 500, "label": "Indicates an internal server error occurred.", "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": "d5f36921-37c0-4946-bf99-d45c5fcccb0b", "documentation": "Request DNS Verification for SPF", "method": "post", "endpoint": "domains/:domainid/verifyspf", "responses": [ { "uuid": "024cd5cb-5d2e-4c61-bf0e-bb4320b96b03", "body": "{\n \"SPFHost\": \"\",\n \"SPFTextValue\": \"\",\n \"SPFVerified\": {{faker 'datatype.boolean'}}\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": "ce0b8039-effc-4e2b-9635-c20b9699c83d", "body": "{\n \"ErrorCode\": {{faker 'number.int' max=99999}},\n \"Message\": \"\"\n}", "latency": 0, "statusCode": 422, "label": "An error was generated due to incorrect use of the API. See the Message associated with this response for more information.", "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": "ef812775-146c-43ae-903f-8114450d64af", "body": "", "latency": 0, "statusCode": 500, "label": "Indicates an internal server error occurred.", "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": "fafdfeb1-db28-4b6f-b5b1-4a9ea4b2b987", "documentation": "List Sender Signatures", "method": "get", "endpoint": "senders", "responses": [ { "uuid": "92b429e9-6148-4f45-8e65-b1032079f4d2", "body": "{\n \"SenderSignatures\": [\n {\n \"Confirmed\": {{faker 'datatype.boolean'}},\n \"Domain\": \"\",\n \"EmailAddress\": \"{{faker 'internet.email'}}\",\n \"ID\": {{faker 'number.int' max=99999}},\n \"Name\": \"\",\n \"ReplyToEmailAddress\": \"{{faker 'internet.email'}}\"\n }\n ],\n \"TotalCount\": {{faker 'number.int' max=99999}}\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": "ed1c9af1-9f9c-43bd-aaa0-2e2f627ae653", "body": "{\n \"ErrorCode\": {{faker 'number.int' max=99999}},\n \"Message\": \"\"\n}", "latency": 0, "statusCode": 422, "label": "An error was generated due to incorrect use of the API. See the Message associated with this response for more information.", "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": "643e9345-a914-4077-b1b4-7863228be728", "body": "", "latency": 0, "statusCode": 500, "label": "Indicates an internal server error occurred.", "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": "da5c900b-051a-4751-8f49-bceabcfb1c50", "documentation": "Create a Sender Signature", "method": "post", "endpoint": "senders", "responses": [ { "uuid": "f59b1aef-d77a-4d47-b8d0-883e6a6eb629", "body": "{\n \"Confirmed\": {{faker 'datatype.boolean'}},\n \"DKIMHost\": \"\",\n \"DKIMPendingHost\": \"\",\n \"DKIMPendingTextValue\": \"\",\n \"DKIMRevokedHost\": \"\",\n \"DKIMRevokedTextValue\": \"\",\n \"DKIMTestValue\": \"\",\n \"DKIMUpdateStatus\": \"\",\n \"DKIMVerified\": {{faker 'datatype.boolean'}},\n \"Domain\": \"\",\n \"EmailAddress\": \"{{faker 'internet.email'}}\",\n \"ID\": {{faker 'number.int' max=99999}},\n \"Name\": \"\",\n \"ReplyToEmailAddress\": \"{{faker 'internet.email'}}\",\n \"ReturnPathDomain\": \"\",\n \"ReturnPathDomainCNAMEValue\": \"\",\n \"ReturnPathDomainVerified\": {{faker 'datatype.boolean'}},\n \"SPFHost\": \"\",\n \"SPFTextValue\": \"\",\n \"SPFVerified\": {{faker 'datatype.boolean'}},\n \"SafeToRemoveRevokedKeyFromDNS\": {{faker 'datatype.boolean'}},\n \"WeakDKIM\": {{faker 'datatype.boolean'}}\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": "5a5330dc-66f9-4011-aa0b-62bf66520d24", "body": "{\n \"ErrorCode\": {{faker 'number.int' max=99999}},\n \"Message\": \"\"\n}", "latency": 0, "statusCode": 422, "label": "An error was generated due to incorrect use of the API. See the Message associated with this response for more information.", "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": "92b2c195-7572-4fe6-99d4-75820e947d5c", "body": "", "latency": 0, "statusCode": 500, "label": "Indicates an internal server error occurred.", "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": "6dd26dd3-04ff-4668-855e-685aeda9e747", "documentation": "Delete a Sender Signature", "method": "delete", "endpoint": "senders/:signatureid", "responses": [ { "uuid": "660a5082-c3ac-419b-9570-ec319202370f", "body": "{\n \"ErrorCode\": {{faker 'number.int' max=99999}},\n \"Message\": \"\"\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": "2c3e2c6f-9583-462c-b0dc-c23b816b64a0", "body": "{\n \"ErrorCode\": {{faker 'number.int' max=99999}},\n \"Message\": \"\"\n}", "latency": 0, "statusCode": 422, "label": "An error was generated due to incorrect use of the API. See the Message associated with this response for more information.", "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": "29ea4fca-57cf-40c5-9e16-d969ea6d4307", "body": "", "latency": 0, "statusCode": 500, "label": "Indicates an internal server error occurred.", "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": "7018ad8e-69c3-4b95-b8de-677a74e66a3f", "documentation": "Get a Sender Signature", "method": "get", "endpoint": "senders/:signatureid", "responses": [ { "uuid": "3bd7c258-d9b9-43b9-afee-ab994ad5047a", "body": "{\n \"Confirmed\": {{faker 'datatype.boolean'}},\n \"DKIMHost\": \"\",\n \"DKIMPendingHost\": \"\",\n \"DKIMPendingTextValue\": \"\",\n \"DKIMRevokedHost\": \"\",\n \"DKIMRevokedTextValue\": \"\",\n \"DKIMTestValue\": \"\",\n \"DKIMUpdateStatus\": \"\",\n \"DKIMVerified\": {{faker 'datatype.boolean'}},\n \"Domain\": \"\",\n \"EmailAddress\": \"{{faker 'internet.email'}}\",\n \"ID\": {{faker 'number.int' max=99999}},\n \"Name\": \"\",\n \"ReplyToEmailAddress\": \"{{faker 'internet.email'}}\",\n \"ReturnPathDomain\": \"\",\n \"ReturnPathDomainCNAMEValue\": \"\",\n \"ReturnPathDomainVerified\": {{faker 'datatype.boolean'}},\n \"SPFHost\": \"\",\n \"SPFTextValue\": \"\",\n \"SPFVerified\": {{faker 'datatype.boolean'}},\n \"SafeToRemoveRevokedKeyFromDNS\": {{faker 'datatype.boolean'}},\n \"WeakDKIM\": {{faker 'datatype.boolean'}}\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": "85b6eff2-412b-4ae5-84ea-4e64a8f18172", "body": "{\n \"ErrorCode\": {{faker 'number.int' max=99999}},\n \"Message\": \"\"\n}", "latency": 0, "statusCode": 422, "label": "An error was generated due to incorrect use of the API. See the Message associated with this response for more information.", "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": "9f159adf-f0f0-401e-b86d-7488f5fc9f8b", "body": "", "latency": 0, "statusCode": 500, "label": "Indicates an internal server error occurred.", "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": "37d54044-dfc6-4f0c-bc95-26cae948d752", "documentation": "Update a Sender Signature", "method": "put", "endpoint": "senders/:signatureid", "responses": [ { "uuid": "937f2df3-e767-43d4-8642-f9d45413285a", "body": "{\n \"Confirmed\": {{faker 'datatype.boolean'}},\n \"DKIMHost\": \"\",\n \"DKIMPendingHost\": \"\",\n \"DKIMPendingTextValue\": \"\",\n \"DKIMRevokedHost\": \"\",\n \"DKIMRevokedTextValue\": \"\",\n \"DKIMTestValue\": \"\",\n \"DKIMUpdateStatus\": \"\",\n \"DKIMVerified\": {{faker 'datatype.boolean'}},\n \"Domain\": \"\",\n \"EmailAddress\": \"{{faker 'internet.email'}}\",\n \"ID\": {{faker 'number.int' max=99999}},\n \"Name\": \"\",\n \"ReplyToEmailAddress\": \"{{faker 'internet.email'}}\",\n \"ReturnPathDomain\": \"\",\n \"ReturnPathDomainCNAMEValue\": \"\",\n \"ReturnPathDomainVerified\": {{faker 'datatype.boolean'}},\n \"SPFHost\": \"\",\n \"SPFTextValue\": \"\",\n \"SPFVerified\": {{faker 'datatype.boolean'}},\n \"SafeToRemoveRevokedKeyFromDNS\": {{faker 'datatype.boolean'}},\n \"WeakDKIM\": {{faker 'datatype.boolean'}}\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": "bce072aa-36e6-4b73-ae4a-29501e26d6d9", "body": "{\n \"ErrorCode\": {{faker 'number.int' max=99999}},\n \"Message\": \"\"\n}", "latency": 0, "statusCode": 422, "label": "An error was generated due to incorrect use of the API. See the Message associated with this response for more information.", "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": "c8198103-06cb-4b3a-80d3-9c94e19a9cd0", "body": "", "latency": 0, "statusCode": 500, "label": "Indicates an internal server error occurred.", "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": "a79240a3-3dbd-4abb-8dc0-50757bf019d2", "documentation": "Request a new DKIM Key", "method": "post", "endpoint": "senders/:signatureid/requestnewdkim", "responses": [ { "uuid": "33e09bd9-4f13-49c4-9911-e28178d6368e", "body": "{\n \"ErrorCode\": {{faker 'number.int' max=99999}},\n \"Message\": \"\"\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": "d1b02575-3c52-45b9-a13a-f4d39cb17667", "body": "{\n \"ErrorCode\": {{faker 'number.int' max=99999}},\n \"Message\": \"\"\n}", "latency": 0, "statusCode": 422, "label": "An error was generated due to incorrect use of the API. See the Message associated with this response for more information.", "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": "ca213023-af03-433f-b520-15e1b8d1eeb2", "body": "", "latency": 0, "statusCode": 500, "label": "Indicates an internal server error occurred.", "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": "08f3a55a-7fc1-4832-939c-3706e4d970ec", "documentation": "Resend Signature Confirmation Email", "method": "post", "endpoint": "senders/:signatureid/resend", "responses": [ { "uuid": "ed248c1c-9fca-40d2-8a8b-fef4c1ae48ef", "body": "{\n \"ErrorCode\": {{faker 'number.int' max=99999}},\n \"Message\": \"\"\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": "1ea0711d-ff28-42ff-8afd-8f958369138d", "body": "{\n \"ErrorCode\": {{faker 'number.int' max=99999}},\n \"Message\": \"\"\n}", "latency": 0, "statusCode": 422, "label": "An error was generated due to incorrect use of the API. See the Message associated with this response for more information.", "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": "49425477-442b-4a7a-81b4-53c4c0bfbe3e", "body": "", "latency": 0, "statusCode": 500, "label": "Indicates an internal server error occurred.", "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": "a49eb3be-a15a-4b49-ab57-4e1821a856a4", "documentation": "Request DNS Verification for SPF", "method": "post", "endpoint": "senders/:signatureid/verifyspf", "responses": [ { "uuid": "492be0ad-eec3-40e6-9892-da9c10873545", "body": "{\n \"Confirmed\": {{faker 'datatype.boolean'}},\n \"DKIMHost\": \"\",\n \"DKIMPendingHost\": \"\",\n \"DKIMPendingTextValue\": \"\",\n \"DKIMRevokedHost\": \"\",\n \"DKIMRevokedTextValue\": \"\",\n \"DKIMTestValue\": \"\",\n \"DKIMUpdateStatus\": \"\",\n \"DKIMVerified\": {{faker 'datatype.boolean'}},\n \"Domain\": \"\",\n \"EmailAddress\": \"{{faker 'internet.email'}}\",\n \"ID\": {{faker 'number.int' max=99999}},\n \"Name\": \"\",\n \"ReplyToEmailAddress\": \"{{faker 'internet.email'}}\",\n \"ReturnPathDomain\": \"\",\n \"ReturnPathDomainCNAMEValue\": \"\",\n \"ReturnPathDomainVerified\": {{faker 'datatype.boolean'}},\n \"SPFHost\": \"\",\n \"SPFTextValue\": \"\",\n \"SPFVerified\": {{faker 'datatype.boolean'}},\n \"SafeToRemoveRevokedKeyFromDNS\": {{faker 'datatype.boolean'}},\n \"WeakDKIM\": {{faker 'datatype.boolean'}}\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": "1c655240-fd53-4580-891b-8f1c943feedf", "body": "{\n \"ErrorCode\": {{faker 'number.int' max=99999}},\n \"Message\": \"\"\n}", "latency": 0, "statusCode": 422, "label": "An error was generated due to incorrect use of the API. See the Message associated with this response for more information.", "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": "8de2a28e-6000-4156-91d0-a093a5c7cf66", "body": "", "latency": 0, "statusCode": 500, "label": "Indicates an internal server error occurred.", "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": "fac2331f-eb03-48e6-9e76-5dc4de103029", "documentation": "List servers", "method": "get", "endpoint": "servers", "responses": [ { "uuid": "f0ae8c11-5aeb-4353-9bc7-8a719e5ade08", "body": "{\n \"Servers\": [\n {\n \"ApiTokens\": [\n \"\"\n ],\n \"BounceHookUrl\": \"\",\n \"ClickHookUrl\": \"\",\n \"Color\": \"\",\n \"DeliveryHookUrl\": \"\",\n \"ID\": {{faker 'number.int' max=99999}},\n \"InboundAddress\": \"\",\n \"InboundDomain\": \"\",\n \"InboundHash\": \"\",\n \"InboundHookUrl\": \"\",\n \"InboundSpamThreshold\": {{faker 'number.int' max=99999}},\n \"Name\": \"\",\n \"OpenHookUrl\": \"\",\n \"PostFirstOpenOnly\": {{faker 'datatype.boolean'}},\n \"RawEmailEnabled\": {{faker 'datatype.boolean'}},\n \"ServerLink\": \"\",\n \"SmtpApiActivated\": {{faker 'datatype.boolean'}},\n \"TrackLinks\": \"{{oneOf (array 'None' 'HtmlAndTextTracking' 'HtmlOnlyTracking' 'TextOnlyTracking')}}\",\n \"TrackOpens\": {{faker 'datatype.boolean'}}\n }\n ],\n \"TotalCount\": {{faker 'number.int' max=99999}}\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": "293a47e8-c4d2-497a-982b-f10816b3c947", "body": "{\n \"ErrorCode\": {{faker 'number.int' max=99999}},\n \"Message\": \"\"\n}", "latency": 0, "statusCode": 422, "label": "An error was generated due to incorrect use of the API. See the Message associated with this response for more information.", "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": "0acb46c1-3136-4d35-8f08-d878938f7e2d", "body": "", "latency": 0, "statusCode": 500, "label": "Indicates an internal server error occurred.", "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": "5264ffb9-c2ca-4ee4-bce9-284d7c023a18", "documentation": "Create a Server", "method": "post", "endpoint": "servers", "responses": [ { "uuid": "0d7ea497-30af-4ca2-8367-00fc94dec0ae", "body": "{\n \"ApiTokens\": [\n \"\"\n ],\n \"BounceHookUrl\": \"\",\n \"ClickHookUrl\": \"\",\n \"Color\": \"\",\n \"DeliveryHookUrl\": \"\",\n \"ID\": {{faker 'number.int' max=99999}},\n \"InboundAddress\": \"\",\n \"InboundDomain\": \"\",\n \"InboundHash\": \"\",\n \"InboundHookUrl\": \"\",\n \"InboundSpamThreshold\": {{faker 'number.int' max=99999}},\n \"Name\": \"\",\n \"OpenHookUrl\": \"\",\n \"PostFirstOpenOnly\": {{faker 'datatype.boolean'}},\n \"RawEmailEnabled\": {{faker 'datatype.boolean'}},\n \"ServerLink\": \"\",\n \"SmtpApiActivated\": {{faker 'datatype.boolean'}},\n \"TrackLinks\": \"{{oneOf (array 'None' 'HtmlAndTextTracking' 'HtmlOnlyTracking' 'TextOnlyTracking')}}\",\n \"TrackOpens\": {{faker 'datatype.boolean'}}\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": "b681d11a-26cf-4043-b301-b4570bb1e12f", "body": "{\n \"ErrorCode\": {{faker 'number.int' max=99999}},\n \"Message\": \"\"\n}", "latency": 0, "statusCode": 422, "label": "An error was generated due to incorrect use of the API. See the Message associated with this response for more information.", "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": "0d727a37-0213-4538-a83e-c7b2b18dff13", "body": "", "latency": 0, "statusCode": 500, "label": "Indicates an internal server error occurred.", "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": "730bd3d3-9653-452a-afc2-73bb1adfe21b", "documentation": "Delete a Server", "method": "delete", "endpoint": "servers/:serverid", "responses": [ { "uuid": "d9374ad0-4f94-4572-95aa-d25423ce8f1e", "body": "", "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": "6682b6f3-f021-4041-aec8-30335ed9b009", "body": "{\n \"ErrorCode\": {{faker 'number.int' max=99999}},\n \"Message\": \"\"\n}", "latency": 0, "statusCode": 422, "label": "An error was generated due to incorrect use of the API. See the Message associated with this response for more information.", "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": "2ed940ba-9f06-4a31-b7b5-9f77e3cc17f2", "body": "", "latency": 0, "statusCode": 500, "label": "Indicates an internal server error occurred.", "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": "b60c2135-9eb5-409a-bf19-5e27113032ba", "documentation": "Get a Server", "method": "get", "endpoint": "servers/:serverid", "responses": [ { "uuid": "c5ac0d7c-00eb-4a35-86b7-8e894fe32304", "body": "{\n \"ApiTokens\": [\n \"\"\n ],\n \"BounceHookUrl\": \"\",\n \"ClickHookUrl\": \"\",\n \"Color\": \"\",\n \"DeliveryHookUrl\": \"\",\n \"ID\": {{faker 'number.int' max=99999}},\n \"InboundAddress\": \"\",\n \"InboundDomain\": \"\",\n \"InboundHash\": \"\",\n \"InboundHookUrl\": \"\",\n \"InboundSpamThreshold\": {{faker 'number.int' max=99999}},\n \"Name\": \"\",\n \"OpenHookUrl\": \"\",\n \"PostFirstOpenOnly\": {{faker 'datatype.boolean'}},\n \"RawEmailEnabled\": {{faker 'datatype.boolean'}},\n \"ServerLink\": \"\",\n \"SmtpApiActivated\": {{faker 'datatype.boolean'}},\n \"TrackLinks\": \"{{oneOf (array 'None' 'HtmlAndTextTracking' 'HtmlOnlyTracking' 'TextOnlyTracking')}}\",\n \"TrackOpens\": {{faker 'datatype.boolean'}}\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": "263a87f2-53f0-46cd-8d51-04fc1fa76c21", "body": "{\n \"ErrorCode\": {{faker 'number.int' max=99999}},\n \"Message\": \"\"\n}", "latency": 0, "statusCode": 422, "label": "An error was generated due to incorrect use of the API. See the Message associated with this response for more information.", "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": "6d84effb-55d3-4662-8367-2040fdfb29d4", "body": "", "latency": 0, "statusCode": 500, "label": "Indicates an internal server error occurred.", "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": "a82f7529-6ae8-46db-b4a8-b6b0efaff75b", "documentation": "Edit a Server", "method": "put", "endpoint": "servers/:serverid", "responses": [ { "uuid": "34fd4c64-d4f3-4121-b55e-be118ec5b5fc", "body": "{\n \"ApiTokens\": [\n \"\"\n ],\n \"BounceHookUrl\": \"\",\n \"ClickHookUrl\": \"\",\n \"Color\": \"\",\n \"DeliveryHookUrl\": \"\",\n \"ID\": {{faker 'number.int' max=99999}},\n \"InboundAddress\": \"\",\n \"InboundDomain\": \"\",\n \"InboundHash\": \"\",\n \"InboundHookUrl\": \"\",\n \"InboundSpamThreshold\": {{faker 'number.int' max=99999}},\n \"Name\": \"\",\n \"OpenHookUrl\": \"\",\n \"PostFirstOpenOnly\": {{faker 'datatype.boolean'}},\n \"RawEmailEnabled\": {{faker 'datatype.boolean'}},\n \"ServerLink\": \"\",\n \"SmtpApiActivated\": {{faker 'datatype.boolean'}},\n \"TrackLinks\": \"{{oneOf (array 'None' 'HtmlAndTextTracking' 'HtmlOnlyTracking' 'TextOnlyTracking')}}\",\n \"TrackOpens\": {{faker 'datatype.boolean'}}\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": "7ac43064-c9ae-4977-84ff-b69c97f381b6", "body": "{\n \"ErrorCode\": {{faker 'number.int' max=99999}},\n \"Message\": \"\"\n}", "latency": 0, "statusCode": 422, "label": "An error was generated due to incorrect use of the API. See the Message associated with this response for more information.", "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": "83f338b9-2234-4f15-aa3a-a6f9209eff5a", "body": "", "latency": 0, "statusCode": 500, "label": "Indicates an internal server error occurred.", "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": "eea5a9d2-c931-41cf-8bb1-532d931f95ae", "documentation": "Push templates from one server to another", "method": "put", "endpoint": "templates/push", "responses": [ { "uuid": "2724f413-aa66-4c7f-bf6b-6709d2fc2345", "body": "{\n \"Templates\": [\n {\n \"Action\": \"\",\n \"Alias\": \"\",\n \"Name\": \"\",\n \"TemplateId\": {{faker 'number.int' max=99999}}\n }\n ],\n \"TotalCount\": {{faker 'number.int' max=99999}}\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": "c211fc92-0050-4462-8c02-4a8abd5e6ee7", "body": "{\n \"ErrorCode\": {{faker 'number.int' max=99999}},\n \"Message\": \"\"\n}", "latency": 0, "statusCode": 422, "label": "An error was generated due to incorrect use of the API. See the Message associated with this response for more information.", "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": "89d0c118-5bb3-4f6e-8934-36cdbd86a2d5", "body": "", "latency": 0, "statusCode": 500, "label": "Indicates an internal server error occurred.", "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": "d921ce76-7169-4e7a-93c5-19aa6a7db94f" }, { "type": "route", "uuid": "1b55a6e9-15eb-4dc5-ad15-905b17ee2c75" }, { "type": "route", "uuid": "a5259276-919e-41ce-a8b8-bcdb29258ec4" }, { "type": "route", "uuid": "250453e9-9209-41aa-99df-a2eb2a9b552b" }, { "type": "route", "uuid": "6d291c82-3dc8-4651-9cd8-2309b9ec69d9" }, { "type": "route", "uuid": "1887f68d-d283-47fe-a57f-8cdcc43ba54f" }, { "type": "route", "uuid": "b66beccb-a08d-4dd2-bd24-54e282d1fa13" }, { "type": "route", "uuid": "dceba8bf-7d3e-434e-8de3-f150e51a3321" }, { "type": "route", "uuid": "d5f36921-37c0-4946-bf99-d45c5fcccb0b" }, { "type": "route", "uuid": "fafdfeb1-db28-4b6f-b5b1-4a9ea4b2b987" }, { "type": "route", "uuid": "da5c900b-051a-4751-8f49-bceabcfb1c50" }, { "type": "route", "uuid": "6dd26dd3-04ff-4668-855e-685aeda9e747" }, { "type": "route", "uuid": "7018ad8e-69c3-4b95-b8de-677a74e66a3f" }, { "type": "route", "uuid": "37d54044-dfc6-4f0c-bc95-26cae948d752" }, { "type": "route", "uuid": "a79240a3-3dbd-4abb-8dc0-50757bf019d2" }, { "type": "route", "uuid": "08f3a55a-7fc1-4832-939c-3706e4d970ec" }, { "type": "route", "uuid": "a49eb3be-a15a-4b49-ab57-4e1821a856a4" }, { "type": "route", "uuid": "fac2331f-eb03-48e6-9e76-5dc4de103029" }, { "type": "route", "uuid": "5264ffb9-c2ca-4ee4-bce9-284d7c023a18" }, { "type": "route", "uuid": "730bd3d3-9653-452a-afc2-73bb1adfe21b" }, { "type": "route", "uuid": "b60c2135-9eb5-409a-bf19-5e27113032ba" }, { "type": "route", "uuid": "a82f7529-6ae8-46db-b4a8-b6b0efaff75b" }, { "type": "route", "uuid": "eea5a9d2-c931-41cf-8bb1-532d931f95ae" } ] }