{
  "opencollection": "1.0.0",
  "info": {
    "name": "Tyk Gateway API",
    "version": "5.7.1"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "X-Tyk-Authorization",
      "value": "{{X-Tyk-Authorization}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Health Checking",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Check the Health of the Tyk Gateway.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{tenant}/hello"
          },
          "docs": "From v2.7.5 you can now rename the `/hello`  endpoint by using the `health_check_endpoint_name` option."
        }
      ]
    },
    {
      "info": {
        "name": "Default",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Tyk Get List of Apis",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{tenant}/tyk/apis"
          },
          "docs": "List APIs from Tyk Gateway"
        },
        {
          "info": {
            "name": "Tyk Creat an Api",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{tenant}/tyk/apis",
            "params": [
              {
                "name": "base_api_id",
                "value": "663a4ed9b6be920001b191ae",
                "type": "query",
                "description": "The base API which the new version will be linked to."
              },
              {
                "name": "base_api_version_name",
                "value": "Default",
                "type": "query",
                "description": "The version name of the base API while creating the first version. This doesn't have to be sent for the next versions but if it is set, it will override base API version name."
              },
              {
                "name": "new_version_name",
                "value": "v2",
                "type": "query",
                "description": "The version name of the created version."
              },
              {
                "name": "set_default",
                "value": "true",
                "type": "query",
                "description": "If true, the new version is set as default version."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create API. A single Tyk node can have its API Definitions queried, deleted and updated remotely. This functionality enables you to remotely update your Tyk definitions without having to manage the files manually."
        },
        {
          "info": {
            "name": "Tyk Get Api Definition With It's Id.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{tenant}/tyk/apis/:apiID",
            "params": [
              {
                "name": "apiID",
                "value": "keyless",
                "type": "path",
                "description": "The API ID."
              }
            ]
          },
          "docs": "Get API definition from Tyk Gateway."
        },
        {
          "info": {
            "name": "Tyk Updating an Api Definition With Its Id.",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{tenant}/tyk/apis/:apiID",
            "params": [
              {
                "name": "apiID",
                "value": "1bd5c61b0e694082902cf15ddcc9e6a7",
                "type": "path",
                "description": "The API ID."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updating an API definition uses the same signature and object as a `POST`, however it will first ensure that the API ID that is being updated is the same as the one in the object being `PUT`.\n\nUpdating will completely replace the file descriptor and will not change an API Definition that has already been loaded, the hot-reload endpoint will need to be called to push the new definition to live."
        },
        {
          "info": {
            "name": "Tyk Deleting an Api Definition With Id.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{tenant}/tyk/apis/:apiID",
            "params": [
              {
                "name": "apiID",
                "value": "1bd5c61b0e694082902cf15ddcc9e6a7",
                "type": "path",
                "description": "The API ID."
              }
            ]
          },
          "docs": "Deleting an API definition will remove the file from the file store, the API definition will NOT be unloaded, a separate reload request will need to be made to disable the API endpoint."
        },
        {
          "info": {
            "name": "Tyk Listing Versions of an Api.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{tenant}/tyk/apis/:apiID/versions",
            "params": [
              {
                "name": "apiID",
                "value": "keyless",
                "type": "path",
                "description": "The API ID."
              },
              {
                "name": "searchText",
                "value": "Sample oas",
                "type": "query",
                "description": "Search for API version name"
              },
              {
                "name": "accessType",
                "value": "internal",
                "type": "query",
                "description": "Filter for internal or external API versions"
              }
            ]
          },
          "docs": "Listing versions of an API."
        }
      ]
    },
    {
      "info": {
        "name": "Tyk OAS APIs",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List All Apis in Tyk Oas Api Format.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{tenant}/tyk/apis/oas",
            "params": [
              {
                "name": "mode",
                "value": "public",
                "type": "query",
                "description": "By default mode is empty which means it will return the Tyk API OAS spec including the x-tyk-api-gateway part. \n When mode=public, the Tyk OAS API spec will exclude the x-tyk-api-gateway part in the response."
              }
            ]
          },
          "docs": "List all APIs in Tyk OAS API format, from Tyk Gateway."
        },
        {
          "info": {
            "name": "Create an Api With Tyk Oas Format.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{tenant}/tyk/apis/oas",
            "params": [
              {
                "name": "base_api_id",
                "value": "663a4ed9b6be920001b191ae",
                "type": "query",
                "description": "The base API which the new version will be linked to."
              },
              {
                "name": "base_api_version_name",
                "value": "Default",
                "type": "query",
                "description": "The version name of the base API while creating the first version. This doesn't have to be sent for the next versions but if it is set, it will override base API version name."
              },
              {
                "name": "new_version_name",
                "value": "v2",
                "type": "query",
                "description": "The version name of the created version."
              },
              {
                "name": "set_default",
                "value": "true",
                "type": "query",
                "description": "If true, the new version is set as default version."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create an API with Tyk OAS API format on the Tyk Gateway."
        },
        {
          "info": {
            "name": "Get a Tyk Oas Api Definition.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{tenant}/tyk/apis/oas/:apiID",
            "params": [
              {
                "name": "mode",
                "value": "public",
                "type": "query",
                "description": "By default mode is empty which means it will return the Tyk API OAS spec including the x-tyk-api-gateway part. \n When mode=public, the Tyk OAS API spec will exclude the x-tyk-api-gateway part in the response."
              },
              {
                "name": "apiID",
                "value": "4c1c0d8fc885401053ddac4e39ef676b",
                "type": "path",
                "description": "ID of the API you want to fetch"
              }
            ]
          },
          "docs": "Get Tyk OAS API definition using an API ID."
        },
        {
          "info": {
            "name": "Update a Tyk Oas Api Definition.",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{tenant}/tyk/apis/oas/:apiID",
            "params": [
              {
                "name": "apiID",
                "value": "4c1c0d8fc885401053ddac4e39ef676b",
                "type": "path",
                "description": "ID of the API you want to fetch"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updating an API definition uses the same signature an object as a `POST`, however it will first ensure that the API ID that is being updated is the same as the one in the object being `PUT`.\n\n\n      Updating will completely replace the file descriptor and will not change an API Definition that has already been loaded, the hot-reload endpoint will need to be called to push the new definition\nto live."
        },
        {
          "info": {
            "name": "Patch Api in Tyk Oas Format.",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://{tenant}/tyk/apis/oas/:apiID",
            "params": [
              {
                "name": "apiID",
                "value": "4c1c0d8fc885401053ddac4e39ef676b",
                "type": "path",
                "description": "ID of the API you want to fetch."
              },
              {
                "name": "upstreamURL",
                "value": "https://localhost:8080",
                "type": "query",
                "description": "Upstream URL for the API"
              },
              {
                "name": "listenPath",
                "value": "/user-test/",
                "type": "query",
                "description": "Listen path for the API"
              },
              {
                "name": "customDomain",
                "value": "tyk.io",
                "type": "query",
                "description": "Custom domain for the API"
              },
              {
                "name": "allowList",
                "value": "",
                "type": "query",
                "description": "Enable allowList middleware for all endpoints"
              },
              {
                "name": "validateRequest",
                "value": "",
                "type": "query",
                "description": "Enable validateRequest middleware for all endpoints having a request body with media type application/json"
              },
              {
                "name": "mockResponse",
                "value": "",
                "type": "query",
                "description": "Enable mockResponse middleware for all endpoints having responses configured."
              },
              {
                "name": "authentication",
                "value": "",
                "type": "query",
                "description": "Enable/disable the authentication mechanism in your Tyk Gateway for your OAS API"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "You can use this endpoint to update Tyk OAS part of the Tyk API definition.\nThis endpoint allows you to configure Tyk OAS extension based on query params provided(similar to import)."
        },
        {
          "info": {
            "name": "Deleting a Tyk Oas Api.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{tenant}/tyk/apis/oas/:apiID",
            "params": [
              {
                "name": "apiID",
                "value": "1bd5c61b0e694082902cf15ddcc9e6a7",
                "type": "path",
                "description": "The API ID."
              }
            ]
          },
          "docs": "Deleting an API definition will remove the file from the file store, the API definition will not be unloaded, a separate reload request will need to be made to disable the API endpoint."
        },
        {
          "info": {
            "name": "Download a Tyk Oas Format Api.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{tenant}/tyk/apis/oas/:apiID/export",
            "params": [
              {
                "name": "apiID",
                "value": "4c1c0d8fc885401053ddac4e39ef676b",
                "type": "path",
                "description": "ID of the API you want to fetch."
              },
              {
                "name": "mode",
                "value": "public",
                "type": "query",
                "description": "By default mode is empty which means it will return the Tyk API OAS spec including the x-tyk-api-gateway part. \n When mode=public, the Tyk OAS API spec will exclude the x-tyk-api-gateway part in the response."
              }
            ]
          },
          "docs": "Use the mode query parameter to specify if you want the x-tyk-api-gateway stripped out."
        },
        {
          "info": {
            "name": "Listing Versions of a Tyk Oas Api.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{tenant}/tyk/apis/oas/:apiID/versions",
            "params": [
              {
                "name": "apiID",
                "value": "4c1c0d8fc885401053ddac4e39ef676b",
                "type": "path",
                "description": "ID of the API you want to fetch."
              },
              {
                "name": "searchText",
                "value": "Sample oas",
                "type": "query",
                "description": "Search for API version name"
              },
              {
                "name": "accessType",
                "value": "internal",
                "type": "query",
                "description": "Filter for internal or external API versions"
              }
            ]
          },
          "docs": "Listing versions of a Tyk OAS API."
        },
        {
          "info": {
            "name": "Download All Tyk Oas Format Apis.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{tenant}/tyk/apis/oas/export",
            "params": [
              {
                "name": "mode",
                "value": "public",
                "type": "query",
                "description": "By default mode is empty which means it will return the Tyk API OAS spec including the x-tyk-api-gateway part. \n When mode=public, the Tyk OAS API spec will exclude the x-tyk-api-gateway part in the response."
              }
            ]
          },
          "docs": "Download all Tyk OAS format APIs, from the Gateway."
        },
        {
          "info": {
            "name": "Import an Api in Tyk Oas Format.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{tenant}/tyk/apis/oas/import",
            "params": [
              {
                "name": "upstreamURL",
                "value": "https://localhost:8080",
                "type": "query",
                "description": "Upstream URL for the API"
              },
              {
                "name": "listenPath",
                "value": "/user-test/",
                "type": "query",
                "description": "Listen path for the API"
              },
              {
                "name": "customDomain",
                "value": "tyk.io",
                "type": "query",
                "description": "Custom domain for the API"
              },
              {
                "name": "allowList",
                "value": "",
                "type": "query",
                "description": "Enable allowList middleware for all endpoints"
              },
              {
                "name": "validateRequest",
                "value": "",
                "type": "query",
                "description": "Enable validateRequest middleware for all endpoints having a request body with media type application/json"
              },
              {
                "name": "mockResponse",
                "value": "",
                "type": "query",
                "description": "Enable mockResponse middleware for all endpoints having responses configured."
              },
              {
                "name": "authentication",
                "value": "",
                "type": "query",
                "description": "Enable/disable the authentication mechanism in your Tyk Gateway for your OAS API"
              },
              {
                "name": "base_api_id",
                "value": "663a4ed9b6be920001b191ae",
                "type": "query",
                "description": "The base API which the new version will be linked to."
              },
              {
                "name": "base_api_version_name",
                "value": "Default",
                "type": "query",
                "description": "The version name of the base API while creating the first version. This doesn't have to be sent for the next versions but if it is set, it will override base API version name."
              },
              {
                "name": "new_version_name",
                "value": "v2",
                "type": "query",
                "description": "The version name of the created version."
              },
              {
                "name": "set_default",
                "value": "true",
                "type": "query",
                "description": "If true, the new version is set as default version."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Import an Tyk OAS format API without x-tyk-gateway.\n For use with an existing Tyk OAS API that you want to expose via your Tyk Gateway."
        }
      ]
    },
    {
      "info": {
        "name": "Cache Invalidation",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Tyk Invalidate Cache.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{tenant}/tyk/cache/:apiID",
            "params": [
              {
                "name": "apiID",
                "value": "ae67bb862a3241a49117508e0f9ee839",
                "type": "path",
                "description": "The API ID."
              }
            ]
          },
          "docs": "Invalidate cache for the given API."
        }
      ]
    },
    {
      "info": {
        "name": "Certs",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Tyk List Certificates.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{tenant}/tyk/certs",
            "params": [
              {
                "name": "org_id",
                "value": "5e9d9544a1dcd60001d0ed20",
                "type": "query",
                "description": "Organisation ID to list the certificates."
              },
              {
                "name": "mode",
                "value": "detailed",
                "type": "query",
                "description": "Mode to list the certificate details."
              }
            ]
          },
          "docs": "List all certificates in the Tyk Gateway."
        },
        {
          "info": {
            "name": "Tyk Add a Certificate.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{tenant}/tyk/certs",
            "params": [
              {
                "name": "org_id",
                "value": "5e9d9544a1dcd60001d0ed20",
                "type": "query",
                "description": "Organisation ID to add the certificate to."
              }
            ]
          },
          "docs": "Add a certificate to the Tyk Gateway."
        },
        {
          "info": {
            "name": "Tyk Delete Certificate.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{tenant}/tyk/certs/:certID",
            "params": [
              {
                "name": "certID",
                "value": "5e9d9544a1dcd60001d0ed20a6ab77653d5da938f452bb8cc9b55b0630a6743dabd8dc92bfb025abb09ce035",
                "type": "path",
                "description": "Certificate ID to be deleted."
              },
              {
                "name": "org_id",
                "value": "5e9d9544a1dcd60001d0ed20",
                "type": "query",
                "description": "Organisation ID to delete the certificates from."
              }
            ]
          },
          "docs": "Delete certificate by ID."
        }
      ]
    },
    {
      "info": {
        "name": "CertsTag",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Return One Certificate or List Multiple Certificates in the Tyk Gateway Given a Comma Separated List of Cert Ids.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{tenant}/tyk/certs/:certID",
            "params": [
              {
                "name": "certID",
                "value": "e6ce2b49-3e31-44de-95a7-12f054724283,5e9d9544a1dcd60001d0ed20a6ab77653d5da938f452bb8cc9b55b0630a6743dabd8dc92bfb025abb09ce035",
                "type": "path",
                "description": "Comma separated list of certificates to list."
              }
            ]
          },
          "docs": "Note that the certID path parameter can take a list of certIDs separated with commas (e.g /tyk/certs/certIDOne,certIDTwo).\n If you send a single certID it will return a single CertificateMeta object otherwise if you send more than two certIDs is will return an array of certificateMeta objects."
        }
      ]
    },
    {
      "info": {
        "name": "Debug",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Tyk Test an an Api Definition.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{tenant}/tyk/debug",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Used to test API definition by sending sample request and analysing output of both response and logs."
        }
      ]
    },
    {
      "info": {
        "name": "Keys",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Tyk List Keys.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{tenant}/tyk/keys"
          },
          "docs": "List all the API keys."
        },
        {
          "info": {
            "name": "Tyk Create a Key.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{tenant}/tyk/keys",
            "params": [
              {
                "name": "hashed",
                "value": "true",
                "type": "query",
                "description": "When set to true the key_hash returned will be similar to the un-hashed key name."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Tyk will generate the access token based on the OrgID specified in the API Definition and a random UUID. This ensures that keys can be owned by different API Owners should segmentation be needed at an organisational level.\n <br/><br/>\n  API keys without access_rights data will be written to all APIs on the system (this also means that they will be created across all SessionHandlers and StorageHandlers, it is recommended to always\nembed access_rights data in a key to ensure that only targeted API"
        },
        {
          "info": {
            "name": "Tyk Get a Key With Id.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{tenant}/tyk/keys/:keyID",
            "params": [
              {
                "name": "hashed",
                "value": "true",
                "type": "query",
                "description": "Use the hash of the key as input instead of the full key."
              },
              {
                "name": "keyID",
                "value": "5e9d9544a1dcd60001d0ed20e7f75f9e03534825b7aef9df749582e5",
                "type": "path",
                "description": "The key ID."
              }
            ]
          },
          "docs": "Get session info about the specified key. Should return up to date rate limit and quota usage numbers."
        },
        {
          "info": {
            "name": "Tyk Create Custom Key / Import Key",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{tenant}/tyk/keys/:keyID",
            "params": [
              {
                "name": "suppress_reset",
                "value": "1",
                "type": "query",
                "description": "Adding the suppress_reset parameter and setting it to 1, will cause Tyk not to reset the quota limit that is in the current live quota manager. By default Tyk will reset the quota in the live quota manager (initialising it) when adding a key. Adding the `suppress_reset` flag to the URL parameters will avoid this behaviour."
              },
              {
                "name": "hashed",
                "value": "true",
                "type": "query",
                "description": "When set to true the key_hash returned will be similar to the un-hashed key name."
              },
              {
                "name": "keyID",
                "value": "customKey",
                "type": "path",
                "description": "Name to give the custom key."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "You can use this endpoint to import existing keys into Tyk or to create a new custom key."
        },
        {
          "info": {
            "name": "Tyk Update Key.",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{tenant}/tyk/keys/:keyID",
            "params": [
              {
                "name": "suppress_reset",
                "value": "1",
                "type": "query",
                "description": "Adding the suppress_reset parameter and setting it to 1 will cause Tyk not to reset the quota limit that is in the current live quota manager. By default Tyk will reset the quota in the live quota manager (initialising it) when adding a key. Adding the `suppress_reset` flag to the URL parameters will avoid this behaviour."
              },
              {
                "name": "hashed",
                "value": "true",
                "type": "query",
                "description": "When set to true the key_hash returned will be similar to the un-hashed key name."
              },
              {
                "name": "keyID",
                "value": "5e9d9544a1dcd60001d0ed20766d9a6ec6b4403b93a554feefef4708",
                "type": "path",
                "description": "ID of the key you want to update."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": " You can also manually add keys to Tyk using your own key-generation algorithm. It is recommended that when using this approach to ensure that the OrgID being used in the API Definition and the key data is blank so that Tyk does not try to prepend or manage the key in any way."
        },
        {
          "info": {
            "name": "Tyk Delete a Key.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{tenant}/tyk/keys/:keyID",
            "params": [
              {
                "name": "hashed",
                "value": "false",
                "type": "query",
                "description": "Use the hash of the key as input instead of the full key."
              },
              {
                "name": "keyID",
                "value": "5e9d9544a1dcd60001d0ed20e7f75f9e03534825b7aef9df749582e5",
                "type": "path",
                "description": "The key ID."
              }
            ]
          },
          "docs": "Deleting a key will remove it permanently from the system, however analytics relating to that key will still be available."
        },
        {
          "info": {
            "name": "Tyk Create a Key.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{tenant}/tyk/keys/create",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a key."
        },
        {
          "info": {
            "name": "Tyk Set Policies for a Hashed Key.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{tenant}/tyk/keys/policy/:keyID",
            "params": [
              {
                "name": "keyID",
                "value": "5e9d9544a1dcd60001d0ed207eb558517c3c48fb826c62cc6f6161eb",
                "type": "path",
                "description": "Name to give the custom key."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This will set policies to a hashed key."
        },
        {
          "info": {
            "name": "Tyk This Will Validate a Key Definition.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{tenant}/tyk/keys/preview",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This will check if the body of a key definition is valid. And return a response with how the key would look like if you were to create it."
        }
      ]
    },
    {
      "info": {
        "name": "OAuth",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Tyk List Oauth Clients",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{tenant}/tyk/oauth/clients/:apiID",
            "params": [
              {
                "name": "apiID",
                "value": "1bd5c61b0e694082902cf15ddcc9e6a7",
                "type": "path",
                "description": "The API ID"
              }
            ]
          },
          "docs": "OAuth Clients are organised by API ID, and therefore are queried as such."
        },
        {
          "info": {
            "name": "Tyk Get Oauth Client",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{tenant}/tyk/oauth/clients/:apiID/:keyName",
            "params": [
              {
                "name": "apiID",
                "value": "b84fe1a04e5648927971c0557971565c",
                "type": "path",
                "description": "The API id"
              },
              {
                "name": "keyName",
                "value": "2a06b398c17f46908de3dffcb71ef87df",
                "type": "path",
                "description": "The Client ID"
              }
            ]
          },
          "docs": "Get OAuth client details tied to an api"
        },
        {
          "info": {
            "name": "Tyk Update Oauth Metadata,redirecturi,description and Policy Id",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{tenant}/tyk/oauth/clients/:apiID/:keyName",
            "params": [
              {
                "name": "apiID",
                "value": "b84fe1a04e5648927971c0557971565c",
                "type": "path",
                "description": "The API id"
              },
              {
                "name": "keyName",
                "value": "2a06b398c17f46908de3dffcb71ef87df",
                "type": "path",
                "description": "The Client ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Allows you to update the metadata,redirecturi,description and Policy ID for an OAuth client."
        },
        {
          "info": {
            "name": "Tyk Delete Oauth Client",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{tenant}/tyk/oauth/clients/:apiID/:keyName",
            "params": [
              {
                "name": "apiID",
                "value": "b84fe1a04e5648927971c0557971565c",
                "type": "path",
                "description": "The API id"
              },
              {
                "name": "keyName",
                "value": "2a06b398c17f46908de3dffcb71ef87df",
                "type": "path",
                "description": "The Client ID"
              }
            ]
          },
          "docs": "Please note that tokens issued with the client ID will still be valid until they expire."
        },
        {
          "info": {
            "name": "Tyk Rotate the Oath Client Secret",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{tenant}/tyk/oauth/clients/:apiID/:keyName/rotate",
            "params": [
              {
                "name": "apiID",
                "value": "b84fe1a04e5648927971c0557971565c",
                "type": "path",
                "description": "The API id"
              },
              {
                "name": "keyName",
                "value": "2a06b398c17f46908de3dffcb71ef87df",
                "type": "path",
                "description": "The Client ID"
              }
            ]
          },
          "docs": "Generate a new secret"
        },
        {
          "info": {
            "name": "Tyk List Tokens for a Provided Api Id and Oauth-client Id",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{tenant}/tyk/oauth/clients/:apiID/:keyName/tokens",
            "params": [
              {
                "name": "apiID",
                "value": "b84fe1a04e5648927971c0557971565c",
                "type": "path",
                "description": "The API id"
              },
              {
                "name": "keyName",
                "value": "2a06b398c17f46908de3dffcb71ef87df",
                "type": "path",
                "description": "The Client ID"
              },
              {
                "name": "page",
                "value": "1",
                "type": "query",
                "description": "Use page query parameter to say which page number you want returned."
              }
            ]
          },
          "docs": "This endpoint allows you to retrieve a list of all current tokens and their expiry date for a provided API ID and OAuth-client ID .If page query parameter is sent the tokens will be paginated. This endpoint will work only for newly created tokens.\n        <br/>\n        <br/>\n        You can control how long you want to store expired tokens in this list using `oauth_token_expired_retain_period` gateway option, which specifies retain period for expired tokens stored in\nRedis. By default expired to"
        },
        {
          "info": {
            "name": "Tyk Get Api Ids for Apis That Use the Specified Client_id(appid) for Oauth",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{tenant}/tyk/oauth/clients/apis/:appID",
            "params": [
              {
                "name": "appID",
                "value": "2a06b398c17f46908de3dffcb71ef87df",
                "type": "path",
                "description": "The Client ID"
              },
              {
                "name": "orgID",
                "value": "",
                "type": "query",
                "description": "The Org Id"
              }
            ]
          },
          "docs": "Get all API IDs for APIs that have use_oauth2 enabled and use the client_id (appID) specified in the path parameter for OAuth2. You can use the org_id query parameter to specify from which organization you want the API IDs to be returned. To return APIs from all organizations, send org_id as an empty string."
        },
        {
          "info": {
            "name": "Tyk Create New Oauth Client",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{tenant}/tyk/oauth/clients/create",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Any OAuth keys must be generated with the help of a client ID. These need to be pre-registered with Tyk before they can be used (in a similar vein to how you would register your app with Twitter before attempting to ask user permissions using their API).\n        <br/><br/>\n        <h3>Creating OAuth clients with Access to Multiple APIs</h3>\n        New from Tyk Gateway 2.6.0 is the ability to create OAuth clients with access to more than one API. If you provide the api_id it works the same as in"
        },
        {
          "info": {
            "name": "Tyk Invalidate Oauth Refresh Token",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{tenant}/tyk/oauth/refresh/:keyName",
            "params": [
              {
                "name": "keyName",
                "value": "2a06b398c17f46908de3dffcb71ef87df",
                "type": "path",
                "description": "The Client ID"
              },
              {
                "name": "api_id",
                "value": "b84fe1a04e5648927971c0557971565c",
                "type": "query",
                "description": "The API id"
              }
            ]
          },
          "docs": "It is possible to invalidate refresh tokens in order to manage OAuth client access more robustly."
        },
        {
          "info": {
            "name": "Tyk Revoke Token",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{tenant}/tyk/oauth/revoke",
            "body": {
              "type": "form-urlencoded",
              "data": [
                {
                  "name": "client_id",
                  "value": ""
                },
                {
                  "name": "org_id",
                  "value": ""
                },
                {
                  "name": "token",
                  "value": ""
                },
                {
                  "name": "token_type_hint",
                  "value": ""
                }
              ]
            }
          },
          "docs": "revoke a single token"
        },
        {
          "info": {
            "name": "Tyk Revoke All Client's Tokens",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{tenant}/tyk/oauth/revoke_all",
            "body": {
              "type": "form-urlencoded",
              "data": [
                {
                  "name": "client_id",
                  "value": ""
                },
                {
                  "name": "client_secret",
                  "value": ""
                },
                {
                  "name": "org_id",
                  "value": ""
                }
              ]
            }
          },
          "docs": "Revoke all the tokens for a given oauth client"
        },
        {
          "info": {
            "name": "Tyk Purge Lapsed Oauth Tokens",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{tenant}/tyk/oauth/tokens",
            "params": [
              {
                "name": "scope",
                "value": "lapsed",
                "type": "query",
                "description": "purge lapsed tokens"
              }
            ]
          },
          "docs": "Purge all lapsed OAuth token"
        }
      ]
    },
    {
      "info": {
        "name": "Organisation Quotas",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Tyk List Organisation Keys",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{tenant}/tyk/org/keys",
            "params": [
              {
                "name": "filter",
                "value": "default*",
                "type": "query",
                "description": "Retrieves all keys starting with the specified filter(filter is a prefix - e.g. default* or default will return all keys starting with default  like defaultbd,defaulttwo etc).We don't use filter for hashed keys"
              }
            ]
          },
          "docs": "You can now set rate limits at the organisation level by using the following fields - allowance and rate. These are the number of allowed requests for the specified per value, and need to be set to the same value. If you don't want to have organisation level rate limiting, set 'rate' or 'per' to zero, or don't add them to your request."
        },
        {
          "info": {
            "name": "Tyk Get an Organisation Key",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{tenant}/tyk/org/keys/:keyID",
            "params": [
              {
                "name": "orgID",
                "value": "664a14650619d40001f1f00f",
                "type": "query",
                "description": "The Org ID"
              },
              {
                "name": "keyID",
                "value": "e389ae00a2b145feaf28d6cc11f0f86d",
                "type": "path",
                "description": "The Key ID"
              }
            ]
          },
          "docs": "Get session info about specified organisation key. Should return up to date rate limit and quota usage numbers."
        },
        {
          "info": {
            "name": "Tyk Create an Organisation Key",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{tenant}/tyk/org/keys/:keyID",
            "params": [
              {
                "name": "keyID",
                "value": "e389ae00a2b145feaf28d6cc11f0f86d",
                "type": "path",
                "description": "The Key ID"
              },
              {
                "name": "reset_quota",
                "value": "1",
                "type": "query",
                "description": "Adding the reset_quota parameter and setting it to 1, will cause Tyk reset the organisations quota in the live quota manager, it is recommended to use this mechanism to reset organisation-level access if a monthly subscription is in place."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This work similar to Keys API except that Key ID is always equals Organisation ID"
        },
        {
          "info": {
            "name": "Tyk Update Organisation Key",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{tenant}/tyk/org/keys/:keyID",
            "params": [
              {
                "name": "reset_quota",
                "value": "1",
                "type": "query",
                "description": "Adding the reset_quota parameter and setting it to 1, will cause Tyk reset the organisations quota in the live quota manager, it is recommended to use this mechanism to reset organisation-level access if a monthly subscription is in place."
              },
              {
                "name": "keyID",
                "value": "e389ae00a2b145feaf28d6cc11f0f86d",
                "type": "path",
                "description": "The Key ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This work similar to Keys API except that Key ID is always equals Organisation ID\n\nFor Gateway v2.6.0 onwards, you can now set rate limits at the organisation level by using the following fields - allowance and rate. These are the number of allowed requests for the specified per value, and need to be set to the same value. If you don't want to have organisation level rate limiting, set `rate` or `per` to zero, or don't add them to your request."
        },
        {
          "info": {
            "name": "Tyk Delete Key",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{tenant}/tyk/org/keys/:keyID",
            "params": [
              {
                "name": "keyID",
                "value": "e389ae00a2b145feaf28d6cc11f0f86d",
                "type": "path",
                "description": "The Key ID"
              }
            ]
          },
          "docs": "Deleting a key will remove all limits from organisation. It does not affects regular keys created within organisation."
        }
      ]
    },
    {
      "info": {
        "name": "Policies",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Tyk List Policies.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{tenant}/tyk/policies"
          },
          "docs": "Retrieve all the policies in your Tyk instance. Returns an array policies."
        },
        {
          "info": {
            "name": "Tyk Create a Policy.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{tenant}/tyk/policies",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a policy in your Tyk Instance."
        },
        {
          "info": {
            "name": "Tyk Get a Policy.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{tenant}/tyk/policies/:polID",
            "params": [
              {
                "name": "polID",
                "value": "5ead7120575961000181867e",
                "type": "path",
                "description": "You can retrieve details of a single policy by ID in your Tyk instance."
              }
            ]
          },
          "docs": "You can retrieve details of a single policy by ID in your Tyk instance."
        },
        {
          "info": {
            "name": "Tyk Update a Policy.",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{tenant}/tyk/policies/:polID",
            "params": [
              {
                "name": "polID",
                "value": "5ead7120575961000181867e",
                "type": "path",
                "description": "You can retrieve details of a single policy by ID in your Tyk instance."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "You can update a Policy in your Tyk Instance by ID."
        },
        {
          "info": {
            "name": "Tyk Delete a Policy.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{tenant}/tyk/policies/:polID",
            "params": [
              {
                "name": "polID",
                "value": "5ead7120575961000181867e",
                "type": "path",
                "description": "You can retrieve details of a single policy by ID in your Tyk instance."
              }
            ]
          },
          "docs": "Delete a policy by ID in your Tyk instance."
        }
      ]
    },
    {
      "info": {
        "name": "Hot Reload",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Tyk Hot-reload a Single Node.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{tenant}/tyk/reload",
            "params": [
              {
                "name": "block",
                "value": "false",
                "type": "query",
                "description": "Block a response until the reload is performed. This can be useful in scripting environments like CI/CD workflows."
              }
            ]
          },
          "docs": "Tyk is capable of reloading configurations without having to stop serving requests. This means that API configurations can be added at runtime, or even modified at runtime and those rules applied immediately without any downtime."
        },
        {
          "info": {
            "name": "Hot-reload a Group of Tyk Nodes.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{tenant}/tyk/reload/group"
          },
          "docs": "To reload a whole group of Tyk nodes (without using the Dashboard or host manager). You can send an API request to a single node, this node will then send a notification through the pub/sub infrastructure to all other listening nodes (including the host manager if it is being used to manage Nginx) which will then trigger a global reload."
        }
      ]
    },
    {
      "info": {
        "name": "Batch Requests",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Tyk Run Batch Request.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{tenant}/:listen_path/tyk/batch",
            "params": [
              {
                "name": "listen_path",
                "value": "get",
                "type": "path",
                "description": "API listen path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Endpoint to run batch request."
        }
      ]
    },
    {
      "info": {
        "name": "Schema",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Tyk Get Oas Schema.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{tenant}/tyk/schema",
            "params": [
              {
                "name": "oasVersion",
                "value": "3.0.3",
                "type": "query",
                "description": "The OAS version to fetch."
              }
            ]
          },
          "docs": "Get OAS schema definition using a version."
        }
      ]
    }
  ],
  "bundled": true
}