{ "uuid": "a9ce71ee-5b16-4c0a-9d3d-6ce087d1dcf7", "lastMigration": 29, "name": "Shorten.REST API Documentation", "endpointPrefix": "", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "4ff60cae-24a6-4efd-9928-052306779a6b", "documentation": "Delete alias", "method": "delete", "endpoint": "aliases", "responses": [ { "uuid": "563e5a83-9748-4954-a393-ff6fb7d0fe4a", "body": "", "latency": 0, "statusCode": 200, "label": "Empty 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" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "7b425dc9-732e-4539-818d-d0439a9ce1ac", "documentation": "Get alias", "method": "get", "endpoint": "aliases", "responses": [ { "uuid": "47a820bb-0909-4b64-abb5-18025ed006ac", "body": "{\n \"createdAt\": 1595845801514,\n \"destinations\": [\n {\n \"country\": \"\",\n \"os\": \"\",\n \"url\": \"\"\n }\n ],\n \"domainName\": \"your.domain.com\",\n \"metatags\": [\n {\n \"content\": \"\",\n \"name\": \"\"\n }\n ],\n \"name\": \"aBcDe012\",\n \"snippets\": [\n {\n \"id\": \"\",\n \"parameters\": {}\n }\n ],\n \"updatedAt\": 1595845801514\n}", "latency": 0, "statusCode": 200, "label": "Alias model or **null**", "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": "f39e4013-eea7-4279-8c3a-38fc6dd99d34", "documentation": "Create alias", "method": "post", "endpoint": "aliases", "responses": [ { "uuid": "77d0b146-d3e9-46a4-acd7-9dfd9961f99a", "body": "{\n \"aliasName\": \"aBcDe012\",\n \"domainName\": \"your.domain.com\",\n \"shortUrl\": \"https://your.domain.com/aBcDe012\"\n}", "latency": 0, "statusCode": 200, "label": "Response contains aliasName, domainName and full generated short link", "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": "8d890c7b-5534-40a9-9b25-5c812ab42348", "documentation": "Update alias", "method": "put", "endpoint": "aliases", "responses": [ { "uuid": "e919c012-f29e-4a6b-b696-486a2adc90ed", "body": "", "latency": 0, "statusCode": 200, "label": "Empty 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" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1f6b7305-c7eb-45d7-a09e-32a0dbc91553", "documentation": "Get aliases by domain", "method": "get", "endpoint": "aliases/all", "responses": [ { "uuid": "477cc70b-565d-47bf-b653-528823eb6796", "body": "{\n \"aliases\": [\n \"\"\n ],\n \"lastId\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "returns Array of aliases with lastId", "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": "518f974b-ba12-47bc-a155-d89e44fb8c7c", "documentation": "Get clicks", "method": "get", "endpoint": "clicks", "responses": [ { "uuid": "c18e41c0-53cb-47a1-98a2-2e96621e61a3", "body": "{\n \"clicks\": [\n {\n \"alias\": \"\",\n \"aliasId\": \"\",\n \"browser\": \"\",\n \"country\": \"\",\n \"createdAt\": {{faker 'number.int' max=99999}},\n \"destination\": \"\",\n \"domain\": \"\",\n \"os\": \"\",\n \"referrer\": \"\",\n \"userAgent\": \"\"\n }\n ],\n \"lastId\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "returns Array of Click models, also returns lastId", "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" } ], "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": "4ff60cae-24a6-4efd-9928-052306779a6b" }, { "type": "route", "uuid": "7b425dc9-732e-4539-818d-d0439a9ce1ac" }, { "type": "route", "uuid": "f39e4013-eea7-4279-8c3a-38fc6dd99d34" }, { "type": "route", "uuid": "8d890c7b-5534-40a9-9b25-5c812ab42348" }, { "type": "route", "uuid": "1f6b7305-c7eb-45d7-a09e-32a0dbc91553" }, { "type": "route", "uuid": "518f974b-ba12-47bc-a155-d89e44fb8c7c" } ] }