{ "uuid": "3b644374-81c8-4e52-b237-94b5c2d3d8b5", "lastMigration": 29, "name": "Gateway REST API", "endpointPrefix": "", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "d477ef9e-5ddd-4334-bb91-83f9b055af6d", "documentation": "Gets a list of *API Definition* objects that are currently live on the gateway \n", "method": "get", "endpoint": "tyk/apis/", "responses": [ { "uuid": "ba1329c0-f69b-41f1-9b81-e6e34edae747", "body": "", "latency": 0, "statusCode": 200, "label": "Succesful list 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": "624ad351-90cb-4ed6-a6ba-11288f2232b4", "documentation": "Create an *API Definition* object\n", "method": "post", "endpoint": "tyk/apis/", "responses": [ { "uuid": "79431f8e-49ab-4325-a908-d7924534a9a2", "body": "", "latency": 0, "statusCode": 200, "label": "Succesful API Deletion", "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": "e48bb9e5-85ce-4a84-9892-5d4b5ebf0454", "documentation": "Deletes an *API Definition* object, if it exists\n", "method": "delete", "endpoint": "tyk/apis/:apiID", "responses": [ { "uuid": "b436a516-6128-4a6d-967f-7373b358d27e", "body": "", "latency": 0, "statusCode": 200, "label": "Succesful API Deletion", "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": "45e71930-ffb3-4bca-9611-65d31c80fb53", "documentation": "Gets an *API Definition* object, if it exists\n", "method": "get", "endpoint": "tyk/apis/:apiID", "responses": [ { "uuid": "62d42615-f370-4c52-8e7a-345eb27ef067", "body": "", "latency": 0, "statusCode": 200, "label": "Succesful API 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": "c59c04fa-2c2f-4cce-96d5-57cfda8db0ad", "documentation": "Updates an *API Definition* object, if it exists\n", "method": "put", "endpoint": "tyk/apis/:apiID", "responses": [ { "uuid": "2647bc87-07ef-44c2-b82c-c856f774d7c2", "body": "", "latency": 0, "statusCode": 200, "label": "Succesful API Deletion", "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": "c5fe6e5e-37db-4074-8a38-2ec99fcca278", "documentation": "Gets the health check values for an API if it is being recorded\n", "method": "get", "endpoint": "tyk/health/", "responses": [ { "uuid": "3db2dcd6-4b59-4b94-9c7a-e7ec8231bc03", "body": "", "latency": 0, "statusCode": 200, "label": "Succesful healthcheck 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": "39f57b4e-0e70-45c0-bcc8-104ed6211cbe", "documentation": "Gets a list of *key* IDs (will only work with non-hashed installations)\n", "method": "get", "endpoint": "tyk/keys/", "responses": [ { "uuid": "a8c4e7c6-f57a-4dfb-ad4c-534d94f84cab", "body": "", "latency": 0, "statusCode": 200, "label": "Successful 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": "26df26f0-5065-465e-b815-139f2080522c", "documentation": "Create a new *API token* with the *session object* defined in the body\n", "method": "post", "endpoint": "tyk/keys/create", "responses": [ { "uuid": "3c81394c-a5bd-4c34-825f-cc7944beb245", "body": "", "latency": 0, "statusCode": 200, "label": "Key Created 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": "7c9af5e7-4d84-4d04-9a00-146353923005", "documentation": "Remove this *API token* from the gateway, this will completely destroy the token and metadata associated with the token and instantly stop access from being granted\n", "method": "delete", "endpoint": "tyk/keys/:keyId", "responses": [ { "uuid": "7bceace7-d3f1-4be5-bfac-334c5f20b9f7", "body": "", "latency": 0, "statusCode": 200, "label": "Key Deleted 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": "d9eded75-f240-4aef-96df-80782e7969c8", "documentation": "Add a pre-specified *API token* with the *session object* defined in the body, this operatin creates a custom token that dsoes not use the gateway naming convention for tokens\n", "method": "post", "endpoint": "tyk/keys/:keyId", "responses": [ { "uuid": "5b580eba-e6e4-4994-8d1c-9e301827c150", "body": "", "latency": 0, "statusCode": 200, "label": "Key Added 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": "d43ad204-9902-4913-a872-9002a64de21a", "documentation": "Update an *API token* with the *session object* defined in the body, this operatin overwrites the existing object\n", "method": "put", "endpoint": "tyk/keys/:keyId", "responses": [ { "uuid": "708bbc16-e100-4ff2-adea-b805dd9ea46b", "body": "", "latency": 0, "statusCode": 200, "label": "Key Updated 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": "94891af9-2ed0-4fa9-9622-511ae5ee7331", "documentation": "The final request from an authorising party for a redirect URI during the Tyk OAuth flow\n", "method": "post", "endpoint": "tyk/oauth/authorize-client/", "responses": [ { "uuid": "d982973a-5946-474c-8e44-e56bf99cf357", "body": "", "latency": 0, "statusCode": 200, "label": "Succesful token 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": "5a142eaf-2579-43e2-ba78-1f02bf00ea16", "documentation": "Create a new OAuth client\n", "method": "post", "endpoint": "tyk/oauth/clients/create", "responses": [ { "uuid": "adea222f-d0e9-4fc2-9cff-484319ca846d", "body": "", "latency": 0, "statusCode": 200, "label": "Succesful create 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": "f7973759-0cb7-475b-b29d-aa0944342b3f", "documentation": "Get a list of OAuth clients bound to this back end \n", "method": "get", "endpoint": "tyk/oauth/clients/:apiId", "responses": [ { "uuid": "aa70800c-57ed-4fe6-b345-0cb164b029a6", "body": "", "latency": 0, "statusCode": 200, "label": "Succesful listy 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": "1df1f2db-4d73-4431-b835-dd7571877320", "documentation": "Delete the OAuth client\n", "method": "delete", "endpoint": "tyk/oauth/clients/:apiId/:clientId", "responses": [ { "uuid": "471ef4f9-609f-4619-8749-8de1aaf1c0aa", "body": "", "latency": 0, "statusCode": 200, "label": "Succesful OAuth client deletion", "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": "a087b8bc-208e-4b25-b4f5-6e136be9b481", "documentation": "Invalidate a refresh token\n", "method": "delete", "endpoint": "tyk/oauth/refresh/:keyId", "responses": [ { "uuid": "1da27334-0781-4d5f-851d-fcd487fa8aff", "body": "", "latency": 0, "statusCode": 200, "label": "Succesful token revoked", "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": "936f5b41-6de5-4603-9bfb-cb0dd7f1523b", "documentation": "Will reload the targetted gateway\n", "method": "get", "endpoint": "tyk/reload/", "responses": [ { "uuid": "fb4ed87f-3295-49af-887a-ddcd5984d4a0", "body": "", "latency": 0, "statusCode": 200, "label": "Succesful reload 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": "49a3cba5-08f1-41ea-a29d-f92689cc4491", "documentation": "Will reload the cluster via the targeted gateway\n", "method": "get", "endpoint": "tyk/reload/group", "responses": [ { "uuid": "2cfd2fb9-137b-450b-97ce-13a150d8d5e3", "body": "", "latency": 0, "statusCode": 200, "label": "Succesful reload 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" } ], "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": "d477ef9e-5ddd-4334-bb91-83f9b055af6d" }, { "type": "route", "uuid": "624ad351-90cb-4ed6-a6ba-11288f2232b4" }, { "type": "route", "uuid": "e48bb9e5-85ce-4a84-9892-5d4b5ebf0454" }, { "type": "route", "uuid": "45e71930-ffb3-4bca-9611-65d31c80fb53" }, { "type": "route", "uuid": "c59c04fa-2c2f-4cce-96d5-57cfda8db0ad" }, { "type": "route", "uuid": "c5fe6e5e-37db-4074-8a38-2ec99fcca278" }, { "type": "route", "uuid": "39f57b4e-0e70-45c0-bcc8-104ed6211cbe" }, { "type": "route", "uuid": "26df26f0-5065-465e-b815-139f2080522c" }, { "type": "route", "uuid": "7c9af5e7-4d84-4d04-9a00-146353923005" }, { "type": "route", "uuid": "d9eded75-f240-4aef-96df-80782e7969c8" }, { "type": "route", "uuid": "d43ad204-9902-4913-a872-9002a64de21a" }, { "type": "route", "uuid": "94891af9-2ed0-4fa9-9622-511ae5ee7331" }, { "type": "route", "uuid": "5a142eaf-2579-43e2-ba78-1f02bf00ea16" }, { "type": "route", "uuid": "f7973759-0cb7-475b-b29d-aa0944342b3f" }, { "type": "route", "uuid": "1df1f2db-4d73-4431-b835-dd7571877320" }, { "type": "route", "uuid": "a087b8bc-208e-4b25-b4f5-6e136be9b481" }, { "type": "route", "uuid": "936f5b41-6de5-4603-9bfb-cb0dd7f1523b" }, { "type": "route", "uuid": "49a3cba5-08f1-41ea-a29d-f92689cc4491" } ] }