Dry Run OAS.

Generate a Tyk OAS API definition without saving it to the Dashboard database. This endpoint is used to produce a Tyk OAS API definition without creating the API proxy itself. This provides a dry run functionality for Tyk OAS API creation, showing what would be created in the Dashboard given the set of inputs provided.

POST /api/apis/oas/dry-run

Try it

Dry Run OAS.

cURL

curl --request POST \
  --url https://{tenant}/api/apis/oas/dry-run \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "oas": {},
  "tyk_oas": {
    "x-tyk-api-gateway": {
      "info": {
        "dbId": "<string>",
        "expiration": "<string>",
        "id": "<string>",
        "name": "<string>",
        "orgId": "<string>",
        "state": {
          "active": true,
          "internal": true
        },
        "versioning": {
          "default": "<string>",
          "enabled": true,
          "fallbackToDefault": true,
          "key": "<string>",
          "location": "<string>",
          "name": "<string>",
          "stripVersioningData": true,
          "urlVersioningPattern": "<string>",
          "versions": [
            {
              "id": "<string>",
              "name": "<string>"
            }
          ]
        }
      },
      "middleware": {
        "global": {
          "cache": {
            "cacheAllSafeRequests": true,
            "cacheByHeaders": [
              "<string>"
            ],
            "cacheResponseCodes": [
              123
            ],
            "controlTTLHeaderName": "<string>",
            "enableUpstreamCacheControl": true,
            "enabled": true,
            "timeout": 123
          },
          "contextVariables": {
            "enabled": true
          },
          "cors": {
            "allowCredentials": true,
            "allowedHeaders": [
              "<string>"
            ],
            "allowedMethods": [
              "<string>"
            ],
            "allowedOrigins": [
              "<string>"
            ],
            "debug": true,
            "enabled": true,
            "exposedHeaders": [
              "<string>"
            ],
            "maxAge": 123,
            "optionsPassthrough": true
          },
          "pluginConfig": {
            "bundle": {
              "enabled": true,
              "path": "<string>"
            },
            "data": {
              "enabled": true,
              "value": {}
            },
            "driver": "<string>"
          },
          "postAuthenticationPlugin": {
            "plugins": [
              {
                "enabled": true,
                "functionName": "<string>",
                "path": "<string>",
                "rawBodyOnly": true,
                "requireSession": true
              }
            ]
          },
          "postAuthenticationPlugins": [
            {
              "enabled": true,
              "functionName": "<string>",
              "path": "<string>",
              "rawBodyOnly": true,
              "requireSession": true
            }
          ],
          "postPlugin": {
            "plugins": [
              {
                "enabled": true,
                "functionName": "<string>",
                "path": "<string>",
                "rawBodyOnly": true,
                "requireSession": true
              }
            ]
          },
          "postPlugins": [
            {
              "enabled": true,
              "functionName": "<string>",
              "path": "<string>",
              "rawBodyOnly": true,
              "requireSession": true
            }
          ],
          "prePlugin": {
            "plugins": [
              {
                "enabled": true,
                "functionName": "<string>",
                "path": "<string>",
                "rawBodyOnly": true,
                "requireSession": true
              }
            ]
          },
          "prePlugins": [
            {
              "enabled": true,
              "functionName": "<string>",
              "path": "<string>",
              "rawBodyOnly": true,
              "requireSession": true
            }
          ],
          "responsePlugin": {
            "plugins": [
              {
                "enabled": true,
                "functionName": "<string>",
                "path": "<string>",
                "rawBodyOnly": true,
                "requireSession": true
              }
            ]
          },
          "responsePlugins": [
            {
              "enabled": true,
              "functionName": "<string>",
              "path": "<string>",
              "rawBodyOnly": true,
              "requireSession": true
            }
          ],
          "trafficLogs": {
            "enabled": true
          },
          "transformRequestHeaders": {
            "add": [
              {
                "name": "<string>",
                "value": "<string>"
              }
            ],
            "enabled": true,
            "remove": [
              "<string>"
            ]
          },
          "transformResponseHeaders": {
            "add": [
              {
                "name": "<string>",
                "value": "<string>"
              }
            ],
            "enabled": true,
            "remove": [
              "<string>"
            ]
          }
        },
        "operations": {}
      },
      "server": {
        "authentication": {
          "baseIdentityProvider": "<string>",
          "custom": {
            "AuthSources": {
              "cookie": {
                "enabled": true,
                "name": "<string>"
              },
              "header": {
                "enabled": true,
                "name": "<string>"
              },
              "query": {
                "enabled": true,
                "name": "<string>"
              }
            },
            "config": {
              "enabled": true,
              "functionName": "<string>",
              "idExtractor": {
                "config": {
                  "formParamName": "<string>",
                  "headerName": "<string>",
                  "regexp": "<string>",
                  "regexpMatchIndex": 123,
                  "xPathExp": "<string>"
                },
                "enabled": true,
                "source": "<string>",
                "with": "<string>"
              },
              "path": "<string>",
              "rawBodyOnly": true
            },
            "enabled": true
          },
          "enabled": true,
          "hmac": {
            "AuthSources": {
              "cookie": {
                "enabled": true,
                "name": "<string>"
              },
              "header": {
                "enabled": true,
                "name": "<string>"
              },
              "query": {
                "enabled": true,
                "name": "<string>"
              }
            },
            "allowedAlgorithms": [
              "<string>"
            ],
            "allowedClockSkew": 123,
            "enabled": true
          },
          "oidc": {
            "AuthSources": {
              "cookie": {
                "enabled": true,
                "name": "<string>"
              },
              "header": {
                "enabled": true,
                "name": "<string>"
              },
              "query": {
                "enabled": true,
                "name": "<string>"
              }
            },
            "enabled": true,
            "providers": [
              {
                "clientToPolicyMapping": [
                  {
                    "clientId": "<string>",
                    "policyId": "<string>"
                  }
                ],
                "issuer": "<string>"
              }
            ],
            "scopes": {
              "claimName": "<string>",
              "scopeToPolicyMapping": [
                {
                  "policyId": "<string>",
                  "scope": "<string>"
                }
              ]
            },
            "segregateByClientId": true
          },
          "securitySchemes": {},
          "stripAuthorizationData": true
        },
        "clientCertificates": {
          "allowlist": [
            "<string>"
          ],
          "enabled": true
        },
        "customDomain": {
          "certificates": [
            "<string>"
          ],
          "enabled": true,
          "name": "<string>"
        },
        "detailedActivityLogs": {
          "enabled": true
        },
        "detailedTracing": {
          "enabled": true
        },
        "eventHandlers": [
          {
            "enabled": true,
            "id": "<string>",
            "name": "<string>",
            "trigger": "<string>",
            "type": "<string>"
          }
        ],
        "gatewayTags": {
          "enabled": true,
          "tags": [
            "<string>"
          ]
        },
        "listenPath": {
          "strip": true,
          "value": "<string>"
        }
      },
      "upstream": {
        "certificatePinning": {
          "domainToPublicKeysMapping": [
            {
              "domain": "<string>",
              "publicKeys": [
                "<string>"
              ]
            }
          ],
          "enabled": true
        },
        "mutualTLS": {
          "domainToCertificateMapping": [
            {
              "certificate": "<string>",
              "domain": "<string>"
            }
          ],
          "enabled": true
        },
        "rateLimit": {
          "enabled": true,
          "per": "PT2H30M15S",
          "rate": 123
        },
        "serviceDiscovery": {
          "cache": {
            "enabled": true,
            "timeout": 123
          },
          "cacheTimeout": 123,
          "dataPath": "<string>",
          "enabled": true,
          "endpointReturnsList": true,
          "parentDataPath": "<string>",
          "portDataPath": "<string>",
          "queryEndpoint": "<string>",
          "targetPath": "<string>",
          "useNestedQuery": true,
          "useTargetList": true
        },
        "test": {
          "serviceDiscovery": {
            "cache": {
              "enabled": true,
              "timeout": 123
            },
            "cacheTimeout": 123,
            "dataPath": "<string>",
            "enabled": true,
            "endpointReturnsList": true,
            "parentDataPath": "<string>",
            "portDataPath": "<string>",
            "queryEndpoint": "<string>",
            "targetPath": "<string>",
            "useNestedQuery": true,
            "useTargetList": true
          }
        },
        "url": "<string>"
      }
    }
  }
}
'

200

{
  "x-tyk-api-gateway": {
    "info": {
      "dbId": "<string>",
      "expiration": "<string>",
      "id": "<string>",
      "name": "<string>",
      "orgId": "<string>",
      "state": {
        "active": true,
        "internal": true
      },
      "versioning": {
        "default": "<string>",
        "enabled": true,
        "fallbackToDefault": true,
        "key": "<string>",
        "location": "<string>",
        "name": "<string>",
        "stripVersioningData": true,
        "urlVersioningPattern": "<string>",
        "versions": [
          {
            "id": "<string>",
            "name": "<string>"
          }
        ]
      }
    },
    "middleware": {
      "global": {
        "cache": {
          "cacheAllSafeRequests": true,
          "cacheByHeaders": [
            "<string>"
          ],
          "cacheResponseCodes": [
            123
          ],
          "controlTTLHeaderName": "<string>",
          "enableUpstreamCacheControl": true,
          "enabled": true,
          "timeout": 123
        },
        "contextVariables": {
          "enabled": true
        },
        "cors": {
          "allowCredentials": true,
          "allowedHeaders": [
            "<string>"
          ],
          "allowedMethods": [
            "<string>"
          ],
          "allowedOrigins": [
            "<string>"
          ],
          "debug": true,
          "enabled": true,
          "exposedHeaders": [
            "<string>"
          ],
          "maxAge": 123,
          "optionsPassthrough": true
        },
        "pluginConfig": {
          "bundle": {
            "enabled": true,
            "path": "<string>"
          },
          "data": {
            "enabled": true,
            "value": {}
          },
          "driver": "<string>"
        },
        "postAuthenticationPlugin": {
          "plugins": [
            {
              "enabled": true,
              "functionName": "<string>",
              "path": "<string>",
              "rawBodyOnly": true,
              "requireSession": true
            }
          ]
        },
        "postAuthenticationPlugins": [
          {
            "enabled": true,
            "functionName": "<string>",
            "path": "<string>",
            "rawBodyOnly": true,
            "requireSession": true
          }
        ],
        "postPlugin": {
          "plugins": [
            {
              "enabled": true,
              "functionName": "<string>",
              "path": "<string>",
              "rawBodyOnly": true,
              "requireSession": true
            }
          ]
        },
        "postPlugins": [
          {
            "enabled": true,
            "functionName": "<string>",
            "path": "<string>",
            "rawBodyOnly": true,
            "requireSession": true
          }
        ],
        "prePlugin": {
          "plugins": [
            {
              "enabled": true,
              "functionName": "<string>",
              "path": "<string>",
              "rawBodyOnly": true,
              "requireSession": true
            }
          ]
        },
        "prePlugins": [
          {
            "enabled": true,
            "functionName": "<string>",
            "path": "<string>",
            "rawBodyOnly": true,
            "requireSession": true
          }
        ],
        "responsePlugin": {
          "plugins": [
            {
              "enabled": true,
              "functionName": "<string>",
              "path": "<string>",
              "rawBodyOnly": true,
              "requireSession": true
            }
          ]
        },
        "responsePlugins": [
          {
            "enabled": true,
            "functionName": "<string>",
            "path": "<string>",
            "rawBodyOnly": true,
            "requireSession": true
          }
        ],
        "trafficLogs": {
          "enabled": true
        },
        "transformRequestHeaders": {
          "add": [
            {
              "name": "<string>",
              "value": "<string>"
            }
          ],
          "enabled": true,
          "remove": [
            "<string>"
          ]
        },
        "transformResponseHeaders": {
          "add": [
            {
              "name": "<string>",
              "value": "<string>"
            }
          ],
          "enabled": true,
          "remove": [
            "<string>"
          ]
        }
      },
      "operations": {}
    },
    "server": {
      "authentication": {
        "baseIdentityProvider": "<string>",
        "custom": {
          "AuthSources": {
            "cookie": {
              "enabled": true,
              "name": "<string>"
            },
            "header": {
              "enabled": true,
              "name": "<string>"
            },
            "query": {
              "enabled": true,
              "name": "<string>"
            }
          },
          "config": {
            "enabled": true,
            "functionName": "<string>",
            "idExtractor": {
              "config": {
                "formParamName": "<string>",
                "headerName": "<string>",
                "regexp": "<string>",
                "regexpMatchIndex": 123,
                "xPathExp": "<string>"
              },
              "enabled": true,
              "source": "<string>",
              "with": "<string>"
            },
            "path": "<string>",
            "rawBodyOnly": true
          },
          "enabled": true
        },
        "enabled": true,
        "hmac": {
          "AuthSources": {
            "cookie": {
              "enabled": true,
              "name": "<string>"
            },
            "header": {
              "enabled": true,
              "name": "<string>"
            },
            "query": {
              "enabled": true,
              "name": "<string>"
            }
          },
          "allowedAlgorithms": [
            "<string>"
          ],
          "allowedClockSkew": 123,
          "enabled": true
        },
        "oidc": {
          "AuthSources": {
            "cookie": {
              "enabled": true,
              "name": "<string>"
            },
            "header": {
              "enabled": true,
              "name": "<string>"
            },
            "query": {
              "enabled": true,
              "name": "<string>"
            }
          },
          "enabled": true,
          "providers": [
            {
              "clientToPolicyMapping": [
                {
                  "clientId": "<string>",
                  "policyId": "<string>"
                }
              ],
              "issuer": "<string>"
            }
          ],
          "scopes": {
            "claimName": "<string>",
            "scopeToPolicyMapping": [
              {
                "policyId": "<string>",
                "scope": "<string>"
              }
            ]
          },
          "segregateByClientId": true
        },
        "securitySchemes": {},
        "stripAuthorizationData": true
      },
      "clientCertificates": {
        "allowlist": [
          "<string>"
        ],
        "enabled": true
      },
      "customDomain": {
        "certificates": [
          "<string>"
        ],
        "enabled": true,
        "name": "<string>"
      },
      "detailedActivityLogs": {
        "enabled": true
      },
      "detailedTracing": {
        "enabled": true
      },
      "eventHandlers": [
        {
          "enabled": true,
          "id": "<string>",
          "name": "<string>",
          "trigger": "<string>",
          "type": "<string>"
        }
      ],
      "gatewayTags": {
        "enabled": true,
        "tags": [
          "<string>"
        ]
      },
      "listenPath": {
        "strip": true,
        "value": "<string>"
      }
    },
    "upstream": {
      "certificatePinning": {
        "domainToPublicKeysMapping": [
          {
            "domain": "<string>",
            "publicKeys": [
              "<string>"
            ]
          }
        ],
        "enabled": true
      },
      "mutualTLS": {
        "domainToCertificateMapping": [
          {
            "certificate": "<string>",
            "domain": "<string>"
          }
        ],
        "enabled": true
      },
      "rateLimit": {
        "enabled": true,
        "per": "PT2H30M15S",
        "rate": 123
      },
      "serviceDiscovery": {
        "cache": {
          "enabled": true,
          "timeout": 123
        },
        "cacheTimeout": 123,
        "dataPath": "<string>",
        "enabled": true,
        "endpointReturnsList": true,
        "parentDataPath": "<string>",
        "portDataPath": "<string>",
        "queryEndpoint": "<string>",
        "targetPath": "<string>",
        "useNestedQuery": true,
        "useTargetList": true
      },
      "test": {
        "serviceDiscovery": {
          "cache": {
            "enabled": true,
            "timeout": 123
          },
          "cacheTimeout": 123,
          "dataPath": "<string>",
          "enabled": true,
          "endpointReturnsList": true,
          "parentDataPath": "<string>",
          "portDataPath": "<string>",
          "queryEndpoint": "<string>",
          "targetPath": "<string>",
          "useNestedQuery": true,
          "useTargetList": true
        }
      },
      "url": "<string>"
    }
  }
}

Authorizations

Authorization · string · header · required

The Tyk Dashboard API Access Credentials

Query Parameters

templateID · string

The Asset ID of template applied while creating or importing an OAS API.

base_api_id · string

The base API which the new version will be linked to.

base_api_version_name · string

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.

new_version_name · string

The version name of the created version.

set_default · boolean

If true, the new version is set as default version.

upstreamURL · string

Upstream URL for the API.

listenPath · string

Listen path for the API.

customDomain · string

Custom domain for the API.

allowList · boolean

Enable allowList middleware for all endpoints.

Example:

true

validateRequest · boolean

Enable validateRequest middleware for all endpoints having a request body with media type application/json.

Example:

true

mockResponse · boolean

Enable mockResponse middleware for all endpoints having responses configured.

Example:

true

authentication · boolean

Enable/disable the authentication mechanism in your Tyk Gateway for your OAS API.

Example:

true

Body

application/json

oas · object

tyk_oas · object

Show child attributes

tyk_oas. x-tyk-api-gateway · object

Show child attributes

tyk_oas.x-tyk-api-gateway. info · object

Show child attributes

tyk_oas.x-tyk-api-gateway.info. dbId · string

tyk_oas.x-tyk-api-gateway.info. expiration · string

tyk_oas.x-tyk-api-gateway.info. id · string

tyk_oas.x-tyk-api-gateway.info. name · string

tyk_oas.x-tyk-api-gateway.info. orgId · string

tyk_oas.x-tyk-api-gateway.info. state · object

Show child attributes

tyk_oas.x-tyk-api-gateway.info.state. active · boolean

tyk_oas.x-tyk-api-gateway.info.state. internal · boolean

tyk_oas.x-tyk-api-gateway.info. versioning · object

Show child attributes

tyk_oas.x-tyk-api-gateway.info.versioning. default · string

tyk_oas.x-tyk-api-gateway.info.versioning. enabled · boolean

tyk_oas.x-tyk-api-gateway.info.versioning. fallbackToDefault · boolean

tyk_oas.x-tyk-api-gateway.info.versioning. key · string

tyk_oas.x-tyk-api-gateway.info.versioning. location · string

tyk_oas.x-tyk-api-gateway.info.versioning. name · string

tyk_oas.x-tyk-api-gateway.info.versioning. stripVersioningData · boolean

tyk_oas.x-tyk-api-gateway.info.versioning. urlVersioningPattern · string

tyk_oas.x-tyk-api-gateway.info.versioning. versions · object[] | null

Show child attributes

tyk_oas.x-tyk-api-gateway.info.versioning.versions. id · string

tyk_oas.x-tyk-api-gateway.info.versioning.versions. name · string

tyk_oas.x-tyk-api-gateway. middleware · object

Show child attributes

tyk_oas.x-tyk-api-gateway.middleware. global · object

Show child attributes

tyk_oas.x-tyk-api-gateway.middleware.global. cache · object

Show child attributes

tyk_oas.x-tyk-api-gateway.middleware.global.cache. cacheAllSafeRequests · boolean

tyk_oas.x-tyk-api-gateway.middleware.global.cache. cacheByHeaders · string[]

tyk_oas.x-tyk-api-gateway.middleware.global.cache. cacheResponseCodes · integer[]

tyk_oas.x-tyk-api-gateway.middleware.global.cache. controlTTLHeaderName · string

tyk_oas.x-tyk-api-gateway.middleware.global.cache. enableUpstreamCacheControl · boolean

tyk_oas.x-tyk-api-gateway.middleware.global.cache. enabled · boolean

tyk_oas.x-tyk-api-gateway.middleware.global.cache. timeout · integer<int64>

tyk_oas.x-tyk-api-gateway.middleware.global. contextVariables · object

Show child attributes

tyk_oas.x-tyk-api-gateway.middleware.global.contextVariables. enabled · boolean

tyk_oas.x-tyk-api-gateway.middleware.global. cors · object

Show child attributes

tyk_oas.x-tyk-api-gateway.middleware.global.cors. allowCredentials · boolean

tyk_oas.x-tyk-api-gateway.middleware.global.cors. allowedHeaders · string[]

tyk_oas.x-tyk-api-gateway.middleware.global.cors. allowedMethods · string[]

tyk_oas.x-tyk-api-gateway.middleware.global.cors. allowedOrigins · string[]

tyk_oas.x-tyk-api-gateway.middleware.global.cors. debug · boolean

tyk_oas.x-tyk-api-gateway.middleware.global.cors. enabled · boolean

tyk_oas.x-tyk-api-gateway.middleware.global.cors. exposedHeaders · string[]

tyk_oas.x-tyk-api-gateway.middleware.global.cors. maxAge · integer

tyk_oas.x-tyk-api-gateway.middleware.global.cors. optionsPassthrough · boolean

tyk_oas.x-tyk-api-gateway.middleware.global. pluginConfig · object

Show child attributes

tyk_oas.x-tyk-api-gateway.middleware.global.pluginConfig. bundle · object

Show child attributes

tyk_oas.x-tyk-api-gateway.middleware.global.pluginConfig.bundle. enabled · boolean

tyk_oas.x-tyk-api-gateway.middleware.global.pluginConfig.bundle. path · string

tyk_oas.x-tyk-api-gateway.middleware.global.pluginConfig. data · object

Show child attributes

tyk_oas.x-tyk-api-gateway.middleware.global.pluginConfig.data. enabled · boolean

tyk_oas.x-tyk-api-gateway.middleware.global.pluginConfig.data. value · object

Show child attributes

tyk_oas.x-tyk-api-gateway.middleware.global.pluginConfig.data.value. {key} · any

tyk_oas.x-tyk-api-gateway.middleware.global.pluginConfig. driver · string

tyk_oas.x-tyk-api-gateway.middleware.global. postAuthenticationPlugin · object

Show child attributes

tyk_oas.x-tyk-api-gateway.middleware.global.postAuthenticationPlugin. plugins · object[]

Show child attributes

tyk_oas.x-tyk-api-gateway.middleware.global.postAuthenticationPlugin.plugins. enabled · boolean

tyk_oas.x-tyk-api-gateway.middleware.global.postAuthenticationPlugin.plugins. functionName · string

tyk_oas.x-tyk-api-gateway.middleware.global.postAuthenticationPlugin.plugins. path · string

tyk_oas.x-tyk-api-gateway.middleware.global.postAuthenticationPlugin.plugins. rawBodyOnly · boolean

tyk_oas.x-tyk-api-gateway.middleware.global.postAuthenticationPlugin.plugins. requireSession · boolean

tyk_oas.x-tyk-api-gateway.middleware.global. postAuthenticationPlugins · object[]

Show child attributes

tyk_oas.x-tyk-api-gateway.middleware.global.postAuthenticationPlugins. enabled · boolean

tyk_oas.x-tyk-api-gateway.middleware.global.postAuthenticationPlugins. functionName · string

tyk_oas.x-tyk-api-gateway.middleware.global.postAuthenticationPlugins. path · string

tyk_oas.x-tyk-api-gateway.middleware.global.postAuthenticationPlugins. rawBodyOnly · boolean

tyk_oas.x-tyk-api-gateway.middleware.global.postAuthenticationPlugins. requireSession · boolean

tyk_oas.x-tyk-api-gateway.middleware.global. postPlugin · object

Show child attributes

tyk_oas.x-tyk-api-gateway.middleware.global.postPlugin. plugins · object[]

Show child attributes

tyk_oas.x-tyk-api-gateway.middleware.global.postPlugin.plugins. enabled · boolean

tyk_oas.x-tyk-api-gateway.middleware.global.postPlugin.plugins. functionName · string

tyk_oas.x-tyk-api-gateway.middleware.global.postPlugin.plugins. path · string

tyk_oas.x-tyk-api-gateway.middleware.global.postPlugin.plugins. rawBodyOnly · boolean

tyk_oas.x-tyk-api-gateway.middleware.global.postPlugin.plugins. requireSession · boolean

tyk_oas.x-tyk-api-gateway.middleware.global. postPlugins · object[]

Show child attributes

tyk_oas.x-tyk-api-gateway.middleware.global.postPlugins. enabled · boolean

tyk_oas.x-tyk-api-gateway.middleware.global.postPlugins. functionName · string

tyk_oas.x-tyk-api-gateway.middleware.global.postPlugins. path · string

tyk_oas.x-tyk-api-gateway.middleware.global.postPlugins. rawBodyOnly · boolean

tyk_oas.x-tyk-api-gateway.middleware.global.postPlugins. requireSession · boolean

tyk_oas.x-tyk-api-gateway.middleware.global. prePlugin · object

Show child attributes

tyk_oas.x-tyk-api-gateway.middleware.global.prePlugin. plugins · object[]

Show child attributes

tyk_oas.x-tyk-api-gateway.middleware.global.prePlugin.plugins. enabled · boolean

tyk_oas.x-tyk-api-gateway.middleware.global.prePlugin.plugins. functionName · string

tyk_oas.x-tyk-api-gateway.middleware.global.prePlugin.plugins. path · string

tyk_oas.x-tyk-api-gateway.middleware.global.prePlugin.plugins. rawBodyOnly · boolean

tyk_oas.x-tyk-api-gateway.middleware.global.prePlugin.plugins. requireSession · boolean

tyk_oas.x-tyk-api-gateway.middleware.global. prePlugins · object[]

Show child attributes

tyk_oas.x-tyk-api-gateway.middleware.global.prePlugins. enabled · boolean

tyk_oas.x-tyk-api-gateway.middleware.global.prePlugins. functionName · string

tyk_oas.x-tyk-api-gateway.middleware.global.prePlugins. path · string

tyk_oas.x-tyk-api-gateway.middleware.global.prePlugins. rawBodyOnly · boolean

tyk_oas.x-tyk-api-gateway.middleware.global.prePlugins. requireSession · boolean

tyk_oas.x-tyk-api-gateway.middleware.global. responsePlugin · object

Show child attributes

tyk_oas.x-tyk-api-gateway.middleware.global.responsePlugin. plugins · object[]

Show child attributes

tyk_oas.x-tyk-api-gateway.middleware.global.responsePlugin.plugins. enabled · boolean

tyk_oas.x-tyk-api-gateway.middleware.global.responsePlugin.plugins. functionName · string

tyk_oas.x-tyk-api-gateway.middleware.global.responsePlugin.plugins. path · string

tyk_oas.x-tyk-api-gateway.middleware.global.responsePlugin.plugins. rawBodyOnly · boolean

tyk_oas.x-tyk-api-gateway.middleware.global.responsePlugin.plugins. requireSession · boolean

tyk_oas.x-tyk-api-gateway.middleware.global. responsePlugins · object[]

Show child attributes

tyk_oas.x-tyk-api-gateway.middleware.global.responsePlugins. enabled · boolean

tyk_oas.x-tyk-api-gateway.middleware.global.responsePlugins. functionName · string

tyk_oas.x-tyk-api-gateway.middleware.global.responsePlugins. path · string

tyk_oas.x-tyk-api-gateway.middleware.global.responsePlugins. rawBodyOnly · boolean

tyk_oas.x-tyk-api-gateway.middleware.global.responsePlugins. requireSession · boolean

tyk_oas.x-tyk-api-gateway.middleware.global. trafficLogs · object

Show child attributes

tyk_oas.x-tyk-api-gateway.middleware.global.trafficLogs. enabled · boolean

tyk_oas.x-tyk-api-gateway.middleware.global. transformRequestHeaders · object

Show child attributes

tyk_oas.x-tyk-api-gateway.middleware.global.transformRequestHeaders. add · object[]

Show child attributes

tyk_oas.x-tyk-api-gateway.middleware.global.transformRequestHeaders.add. name · string

tyk_oas.x-tyk-api-gateway.middleware.global.transformRequestHeaders.add. value · string

tyk_oas.x-tyk-api-gateway.middleware.global.transformRequestHeaders. enabled · boolean

tyk_oas.x-tyk-api-gateway.middleware.global.transformRequestHeaders. remove · string[]

tyk_oas.x-tyk-api-gateway.middleware.global. transformResponseHeaders · object

Show child attributes

tyk_oas.x-tyk-api-gateway.middleware.global.transformResponseHeaders. add · object[]

Show child attributes

tyk_oas.x-tyk-api-gateway.middleware.global.transformResponseHeaders.add. name · string

tyk_oas.x-tyk-api-gateway.middleware.global.transformResponseHeaders.add. value · string

tyk_oas.x-tyk-api-gateway.middleware.global.transformResponseHeaders. enabled · boolean

tyk_oas.x-tyk-api-gateway.middleware.global.transformResponseHeaders. remove · string[]

tyk_oas.x-tyk-api-gateway.middleware. operations · object

Show child attributes

tyk_oas.x-tyk-api-gateway.middleware.operations. {key} · object

Show child attributes

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}. allow · object

Show child attributes

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.allow. enabled · boolean

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.allow. ignoreCase · boolean

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}. block · object

Show child attributes

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.block. enabled · boolean

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.block. ignoreCase · boolean

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}. cache · object

Show child attributes

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.cache. cacheByRegex · string

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.cache. cacheResponseCodes · integer[]

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.cache. enabled · boolean

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.cache. timeout · integer<int64>

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}. circuitBreaker · object

Show child attributes

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.circuitBreaker. coolDownPeriod · integer

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.circuitBreaker. enabled · boolean

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.circuitBreaker. halfOpenStateEnabled · boolean

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.circuitBreaker. sampleSize · integer

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.circuitBreaker. threshold · number<double>

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}. doNotTrackEndpoint · object

Show child attributes

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.doNotTrackEndpoint. enabled · boolean

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}. enforceTimeout · object

Show child attributes

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.enforceTimeout. enabled · boolean

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.enforceTimeout. value · integer

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}. ignoreAuthentication · object

Show child attributes

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.ignoreAuthentication. enabled · boolean

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.ignoreAuthentication. ignoreCase · boolean

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}. internal · object

Show child attributes

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.internal. enabled · boolean

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}. mockResponse · object

Show child attributes

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.mockResponse. body · string

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.mockResponse. code · integer

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.mockResponse. enabled · boolean

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.mockResponse. fromOASExamples · object

Show child attributes

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.mockResponse.fromOASExamples. code · integer

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.mockResponse.fromOASExamples. contentType · string

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.mockResponse.fromOASExamples. enabled · boolean

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.mockResponse.fromOASExamples. exampleName · string

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.mockResponse. headers · object[]

Show child attributes

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.mockResponse.headers. name · string

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.mockResponse.headers. value · string

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}. postPlugins · object[]

Show child attributes

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.postPlugins. enabled · boolean

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.postPlugins. functionName · string

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.postPlugins. name · string

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.postPlugins. path · string

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}. rateLimit · object

Show child attributes

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.rateLimit. enabled · boolean

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.rateLimit. per · string<duration>

Example:

"PT2H30M15S"

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.rateLimit. rate · integer

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}. requestSizeLimit · object

Show child attributes

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.requestSizeLimit. enabled · boolean

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.requestSizeLimit. value · integer<int64>

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}. trackEndpoint · object

Show child attributes

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.trackEndpoint. enabled · boolean

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}. transformRequestBody · object

Show child attributes

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.transformRequestBody. body · string

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.transformRequestBody. enabled · boolean

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.transformRequestBody. format · string

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.transformRequestBody. path · string

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}. transformRequestHeaders · object

Show child attributes

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.transformRequestHeaders. add · object[]

Show child attributes

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.transformRequestHeaders.add. name · string

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.transformRequestHeaders.add. value · string

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.transformRequestHeaders. enabled · boolean

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.transformRequestHeaders. remove · string[]

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}. transformRequestMethod · object

Show child attributes

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.transformRequestMethod. enabled · boolean

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.transformRequestMethod. toMethod · string

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}. transformResponseBody · object

Show child attributes

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.transformResponseBody. body · string

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.transformResponseBody. enabled · boolean

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.transformResponseBody. format · string

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.transformResponseBody. path · string

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}. transformResponseHeaders · object

Show child attributes

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.transformResponseHeaders. add · object[]

Show child attributes

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.transformResponseHeaders.add. name · string

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.transformResponseHeaders.add. value · string

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.transformResponseHeaders. enabled · boolean

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.transformResponseHeaders. remove · string[]

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}. urlRewrite · object

Show child attributes

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.urlRewrite. enabled · boolean

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.urlRewrite. pattern · string

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.urlRewrite. rewriteTo · string

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.urlRewrite. triggers · object[]

Show child attributes

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.urlRewrite.triggers. condition · string

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.urlRewrite.triggers. rewriteTo · string

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.urlRewrite.triggers. rules · object[]

Show child attributes

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.urlRewrite.triggers.rules. in · string

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.urlRewrite.triggers.rules. name · string

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.urlRewrite.triggers.rules. negate · boolean

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.urlRewrite.triggers.rules. pattern · string

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}. validateRequest · object

Show child attributes

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.validateRequest. enabled · boolean

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.validateRequest. errorResponseCode · integer

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}. virtualEndpoint · object

Show child attributes

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.virtualEndpoint. body · string

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.virtualEndpoint. enabled · boolean

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.virtualEndpoint. functionName · string

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.virtualEndpoint. name · string

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.virtualEndpoint. path · string

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.virtualEndpoint. proxyOnError · boolean

tyk_oas.x-tyk-api-gateway.middleware.operations.{key}.virtualEndpoint. requireSession · boolean

tyk_oas.x-tyk-api-gateway. server · object

Show child attributes

tyk_oas.x-tyk-api-gateway.server. authentication · object

Show child attributes

tyk_oas.x-tyk-api-gateway.server.authentication. baseIdentityProvider · string

tyk_oas.x-tyk-api-gateway.server.authentication. custom · object

Show child attributes

tyk_oas.x-tyk-api-gateway.server.authentication.custom. AuthSources · object

Show child attributes

tyk_oas.x-tyk-api-gateway.server.authentication.custom.AuthSources. cookie · object

Show child attributes

tyk_oas.x-tyk-api-gateway.server.authentication.custom.AuthSources.cookie. enabled · boolean

tyk_oas.x-tyk-api-gateway.server.authentication.custom.AuthSources.cookie. name · string

tyk_oas.x-tyk-api-gateway.server.authentication.custom.AuthSources. header · object

Show child attributes

tyk_oas.x-tyk-api-gateway.server.authentication.custom.AuthSources.header. enabled · boolean

tyk_oas.x-tyk-api-gateway.server.authentication.custom.AuthSources.header. name · string

tyk_oas.x-tyk-api-gateway.server.authentication.custom.AuthSources. query · object

Show child attributes

tyk_oas.x-tyk-api-gateway.server.authentication.custom.AuthSources.query. enabled · boolean

tyk_oas.x-tyk-api-gateway.server.authentication.custom.AuthSources.query. name · string

tyk_oas.x-tyk-api-gateway.server.authentication.custom. config · object

Show child attributes

tyk_oas.x-tyk-api-gateway.server.authentication.custom.config. enabled · boolean

tyk_oas.x-tyk-api-gateway.server.authentication.custom.config. functionName · string

tyk_oas.x-tyk-api-gateway.server.authentication.custom.config. idExtractor · object

Show child attributes

tyk_oas.x-tyk-api-gateway.server.authentication.custom.config.idExtractor. config · object

Show child attributes

tyk_oas.x-tyk-api-gateway.server.authentication.custom.config.idExtractor.config. formParamName · string

tyk_oas.x-tyk-api-gateway.server.authentication.custom.config.idExtractor.config. headerName · string

tyk_oas.x-tyk-api-gateway.server.authentication.custom.config.idExtractor.config. regexp · string

tyk_oas.x-tyk-api-gateway.server.authentication.custom.config.idExtractor.config. regexpMatchIndex · integer

tyk_oas.x-tyk-api-gateway.server.authentication.custom.config.idExtractor.config. xPathExp · string

tyk_oas.x-tyk-api-gateway.server.authentication.custom.config.idExtractor. enabled · boolean

tyk_oas.x-tyk-api-gateway.server.authentication.custom.config.idExtractor. source · string

tyk_oas.x-tyk-api-gateway.server.authentication.custom.config.idExtractor. with · string

tyk_oas.x-tyk-api-gateway.server.authentication.custom.config. path · string

tyk_oas.x-tyk-api-gateway.server.authentication.custom.config. rawBodyOnly · boolean

tyk_oas.x-tyk-api-gateway.server.authentication.custom. enabled · boolean

tyk_oas.x-tyk-api-gateway.server.authentication. enabled · boolean

tyk_oas.x-tyk-api-gateway.server.authentication. hmac · object

Show child attributes

tyk_oas.x-tyk-api-gateway.server.authentication.hmac. AuthSources · object

Show child attributes

tyk_oas.x-tyk-api-gateway.server.authentication.hmac.AuthSources. cookie · object

Show child attributes

tyk_oas.x-tyk-api-gateway.server.authentication.hmac.AuthSources.cookie. enabled · boolean

tyk_oas.x-tyk-api-gateway.server.authentication.hmac.AuthSources.cookie. name · string

tyk_oas.x-tyk-api-gateway.server.authentication.hmac.AuthSources. header · object

Show child attributes

tyk_oas.x-tyk-api-gateway.server.authentication.hmac.AuthSources.header. enabled · boolean

tyk_oas.x-tyk-api-gateway.server.authentication.hmac.AuthSources.header. name · string

tyk_oas.x-tyk-api-gateway.server.authentication.hmac.AuthSources. query · object

Show child attributes

tyk_oas.x-tyk-api-gateway.server.authentication.hmac.AuthSources.query. enabled · boolean

tyk_oas.x-tyk-api-gateway.server.authentication.hmac.AuthSources.query. name · string

tyk_oas.x-tyk-api-gateway.server.authentication.hmac. allowedAlgorithms · string[]

tyk_oas.x-tyk-api-gateway.server.authentication.hmac. allowedClockSkew · number<double>

tyk_oas.x-tyk-api-gateway.server.authentication.hmac. enabled · boolean

tyk_oas.x-tyk-api-gateway.server.authentication. oidc · object

Show child attributes

tyk_oas.x-tyk-api-gateway.server.authentication.oidc. AuthSources · object

Show child attributes

tyk_oas.x-tyk-api-gateway.server.authentication.oidc.AuthSources. cookie · object

Show child attributes

tyk_oas.x-tyk-api-gateway.server.authentication.oidc.AuthSources.cookie. enabled · boolean

tyk_oas.x-tyk-api-gateway.server.authentication.oidc.AuthSources.cookie. name · string

tyk_oas.x-tyk-api-gateway.server.authentication.oidc.AuthSources. header · object

Show child attributes

tyk_oas.x-tyk-api-gateway.server.authentication.oidc.AuthSources.header. enabled · boolean

tyk_oas.x-tyk-api-gateway.server.authentication.oidc.AuthSources.header. name · string

tyk_oas.x-tyk-api-gateway.server.authentication.oidc.AuthSources. query · object

Show child attributes

tyk_oas.x-tyk-api-gateway.server.authentication.oidc.AuthSources.query. enabled · boolean

tyk_oas.x-tyk-api-gateway.server.authentication.oidc.AuthSources.query. name · string

tyk_oas.x-tyk-api-gateway.server.authentication.oidc. enabled · boolean

tyk_oas.x-tyk-api-gateway.server.authentication.oidc. providers · object[]

Show child attributes

tyk_oas.x-tyk-api-gateway.server.authentication.oidc.providers. clientToPolicyMapping · object[]

Show child attributes

tyk_oas.x-tyk-api-gateway.server.authentication.oidc.providers.clientToPolicyMapping. clientId · string

tyk_oas.x-tyk-api-gateway.server.authentication.oidc.providers.clientToPolicyMapping. policyId · string

tyk_oas.x-tyk-api-gateway.server.authentication.oidc.providers. issuer · string

tyk_oas.x-tyk-api-gateway.server.authentication.oidc. scopes · object

Show child attributes

tyk_oas.x-tyk-api-gateway.server.authentication.oidc.scopes. claimName · string

tyk_oas.x-tyk-api-gateway.server.authentication.oidc.scopes. scopeToPolicyMapping · object[]

Show child attributes

tyk_oas.x-tyk-api-gateway.server.authentication.oidc.scopes.scopeToPolicyMapping. policyId · string

tyk_oas.x-tyk-api-gateway.server.authentication.oidc.scopes.scopeToPolicyMapping. scope · string

tyk_oas.x-tyk-api-gateway.server.authentication.oidc. segregateByClientId · boolean

tyk_oas.x-tyk-api-gateway.server.authentication. securitySchemes · object

Show child attributes

tyk_oas.x-tyk-api-gateway.server.authentication.securitySchemes. {key} · any

tyk_oas.x-tyk-api-gateway.server.authentication. stripAuthorizationData · boolean

tyk_oas.x-tyk-api-gateway.server. clientCertificates · object

Show child attributes

tyk_oas.x-tyk-api-gateway.server.clientCertificates. allowlist · string[] | null

tyk_oas.x-tyk-api-gateway.server.clientCertificates. enabled · boolean

tyk_oas.x-tyk-api-gateway.server. customDomain · object

Show child attributes

tyk_oas.x-tyk-api-gateway.server.customDomain. certificates · string[]

tyk_oas.x-tyk-api-gateway.server.customDomain. enabled · boolean

tyk_oas.x-tyk-api-gateway.server.customDomain. name · string

tyk_oas.x-tyk-api-gateway.server. detailedActivityLogs · object

Show child attributes

tyk_oas.x-tyk-api-gateway.server.detailedActivityLogs. enabled · boolean

tyk_oas.x-tyk-api-gateway.server. detailedTracing · object

Show child attributes

tyk_oas.x-tyk-api-gateway.server.detailedTracing. enabled · boolean

tyk_oas.x-tyk-api-gateway.server. eventHandlers · object[]

Show child attributes

tyk_oas.x-tyk-api-gateway.server.eventHandlers. enabled · boolean

tyk_oas.x-tyk-api-gateway.server.eventHandlers. id · string

tyk_oas.x-tyk-api-gateway.server.eventHandlers. name · string

tyk_oas.x-tyk-api-gateway.server.eventHandlers. trigger · string

tyk_oas.x-tyk-api-gateway.server.eventHandlers. type · string

tyk_oas.x-tyk-api-gateway.server. gatewayTags · object

Show child attributes

tyk_oas.x-tyk-api-gateway.server.gatewayTags. enabled · boolean

tyk_oas.x-tyk-api-gateway.server.gatewayTags. tags · string[] | null

tyk_oas.x-tyk-api-gateway.server. listenPath · object

Show child attributes

tyk_oas.x-tyk-api-gateway.server.listenPath. strip · boolean

tyk_oas.x-tyk-api-gateway.server.listenPath. value · string

tyk_oas.x-tyk-api-gateway. upstream · object

Show child attributes

tyk_oas.x-tyk-api-gateway.upstream. certificatePinning · object

Show child attributes

tyk_oas.x-tyk-api-gateway.upstream.certificatePinning. domainToPublicKeysMapping · object[] | null

Show child attributes

tyk_oas.x-tyk-api-gateway.upstream.certificatePinning.domainToPublicKeysMapping. domain · string

tyk_oas.x-tyk-api-gateway.upstream.certificatePinning.domainToPublicKeysMapping. publicKeys · string[] | null

tyk_oas.x-tyk-api-gateway.upstream.certificatePinning. enabled · boolean

tyk_oas.x-tyk-api-gateway.upstream. mutualTLS · object

Show child attributes

tyk_oas.x-tyk-api-gateway.upstream.mutualTLS. domainToCertificateMapping · object[] | null

Show child attributes

tyk_oas.x-tyk-api-gateway.upstream.mutualTLS.domainToCertificateMapping. certificate · string

tyk_oas.x-tyk-api-gateway.upstream.mutualTLS.domainToCertificateMapping. domain · string

tyk_oas.x-tyk-api-gateway.upstream.mutualTLS. enabled · boolean

tyk_oas.x-tyk-api-gateway.upstream. rateLimit · object

Show child attributes

tyk_oas.x-tyk-api-gateway.upstream.rateLimit. enabled · boolean

tyk_oas.x-tyk-api-gateway.upstream.rateLimit. per · string<duration>

Example:

"PT2H30M15S"

tyk_oas.x-tyk-api-gateway.upstream.rateLimit. rate · integer

tyk_oas.x-tyk-api-gateway.upstream. serviceDiscovery · object

Show child attributes

tyk_oas.x-tyk-api-gateway.upstream.serviceDiscovery. cache · object

Show child attributes

tyk_oas.x-tyk-api-gateway.upstream.serviceDiscovery.cache. enabled · boolean

tyk_oas.x-tyk-api-gateway.upstream.serviceDiscovery.cache. timeout · integer<int64>

tyk_oas.x-tyk-api-gateway.upstream.serviceDiscovery. cacheTimeout · integer<int64>

tyk_oas.x-tyk-api-gateway.upstream.serviceDiscovery. dataPath · string

tyk_oas.x-tyk-api-gateway.upstream.serviceDiscovery. enabled · boolean

tyk_oas.x-tyk-api-gateway.upstream.serviceDiscovery. endpointReturnsList · boolean

tyk_oas.x-tyk-api-gateway.upstream.serviceDiscovery. parentDataPath · string

tyk_oas.x-tyk-api-gateway.upstream.serviceDiscovery. portDataPath · string

tyk_oas.x-tyk-api-gateway.upstream.serviceDiscovery. queryEndpoint · string

tyk_oas.x-tyk-api-gateway.upstream.serviceDiscovery. targetPath · string

tyk_oas.x-tyk-api-gateway.upstream.serviceDiscovery. useNestedQuery · boolean

tyk_oas.x-tyk-api-gateway.upstream.serviceDiscovery. useTargetList · boolean

tyk_oas.x-tyk-api-gateway.upstream. test · object

Show child attributes

tyk_oas.x-tyk-api-gateway.upstream.test. serviceDiscovery · object

Show child attributes

tyk_oas.x-tyk-api-gateway.upstream.test.serviceDiscovery. cache · object

Show child attributes

tyk_oas.x-tyk-api-gateway.upstream.test.serviceDiscovery.cache. enabled · boolean

tyk_oas.x-tyk-api-gateway.upstream.test.serviceDiscovery.cache. timeout · integer<int64>

tyk_oas.x-tyk-api-gateway.upstream.test.serviceDiscovery. cacheTimeout · integer<int64>

tyk_oas.x-tyk-api-gateway.upstream.test.serviceDiscovery. dataPath · string

tyk_oas.x-tyk-api-gateway.upstream.test.serviceDiscovery. enabled · boolean

tyk_oas.x-tyk-api-gateway.upstream.test.serviceDiscovery. endpointReturnsList · boolean

tyk_oas.x-tyk-api-gateway.upstream.test.serviceDiscovery. parentDataPath · string

tyk_oas.x-tyk-api-gateway.upstream.test.serviceDiscovery. portDataPath · string

tyk_oas.x-tyk-api-gateway.upstream.test.serviceDiscovery. queryEndpoint · string

tyk_oas.x-tyk-api-gateway.upstream.test.serviceDiscovery. targetPath · string

tyk_oas.x-tyk-api-gateway.upstream.test.serviceDiscovery. useNestedQuery · boolean

tyk_oas.x-tyk-api-gateway.upstream.test.serviceDiscovery. useTargetList · boolean

tyk_oas.x-tyk-api-gateway.upstream. url · string

Response

200

application/json

Success.

x-tyk-api-gateway · object

Show child attributes

x-tyk-api-gateway. info · object

Show child attributes

x-tyk-api-gateway.info. dbId · string

x-tyk-api-gateway.info. expiration · string

x-tyk-api-gateway.info. id · string

x-tyk-api-gateway.info. name · string

x-tyk-api-gateway.info. orgId · string

x-tyk-api-gateway.info. state · object

Show child attributes

x-tyk-api-gateway.info.state. active · boolean

x-tyk-api-gateway.info.state. internal · boolean

x-tyk-api-gateway.info. versioning · object

Show child attributes

x-tyk-api-gateway.info.versioning. default · string

x-tyk-api-gateway.info.versioning. enabled · boolean

x-tyk-api-gateway.info.versioning. fallbackToDefault · boolean

x-tyk-api-gateway.info.versioning. key · string

x-tyk-api-gateway.info.versioning. location · string

x-tyk-api-gateway.info.versioning. name · string

x-tyk-api-gateway.info.versioning. stripVersioningData · boolean

x-tyk-api-gateway.info.versioning. urlVersioningPattern · string

x-tyk-api-gateway.info.versioning. versions · object[] | null

Show child attributes

x-tyk-api-gateway.info.versioning.versions. id · string

x-tyk-api-gateway.info.versioning.versions. name · string

x-tyk-api-gateway. middleware · object

Show child attributes

x-tyk-api-gateway.middleware. global · object

Show child attributes

x-tyk-api-gateway.middleware.global. cache · object

Show child attributes

x-tyk-api-gateway.middleware.global.cache. cacheAllSafeRequests · boolean

x-tyk-api-gateway.middleware.global.cache. cacheByHeaders · string[]

x-tyk-api-gateway.middleware.global.cache. cacheResponseCodes · integer[]

x-tyk-api-gateway.middleware.global.cache. controlTTLHeaderName · string

x-tyk-api-gateway.middleware.global.cache. enableUpstreamCacheControl · boolean

x-tyk-api-gateway.middleware.global.cache. enabled · boolean

x-tyk-api-gateway.middleware.global.cache. timeout · integer<int64>

x-tyk-api-gateway.middleware.global. contextVariables · object

Show child attributes

x-tyk-api-gateway.middleware.global.contextVariables. enabled · boolean

x-tyk-api-gateway.middleware.global. cors · object

Show child attributes

x-tyk-api-gateway.middleware.global.cors. allowCredentials · boolean

x-tyk-api-gateway.middleware.global.cors. allowedHeaders · string[]

x-tyk-api-gateway.middleware.global.cors. allowedMethods · string[]

x-tyk-api-gateway.middleware.global.cors. allowedOrigins · string[]

x-tyk-api-gateway.middleware.global.cors. debug · boolean

x-tyk-api-gateway.middleware.global.cors. enabled · boolean

x-tyk-api-gateway.middleware.global.cors. exposedHeaders · string[]

x-tyk-api-gateway.middleware.global.cors. maxAge · integer

x-tyk-api-gateway.middleware.global.cors. optionsPassthrough · boolean

x-tyk-api-gateway.middleware.global. pluginConfig · object

Show child attributes

x-tyk-api-gateway.middleware.global.pluginConfig. bundle · object

Show child attributes

x-tyk-api-gateway.middleware.global.pluginConfig.bundle. enabled · boolean

x-tyk-api-gateway.middleware.global.pluginConfig.bundle. path · string

x-tyk-api-gateway.middleware.global.pluginConfig. data · object

Show child attributes

x-tyk-api-gateway.middleware.global.pluginConfig.data. enabled · boolean

x-tyk-api-gateway.middleware.global.pluginConfig.data. value · object

Show child attributes

x-tyk-api-gateway.middleware.global.pluginConfig.data.value. {key} · any

x-tyk-api-gateway.middleware.global.pluginConfig. driver · string

x-tyk-api-gateway.middleware.global. postAuthenticationPlugin · object

Show child attributes

x-tyk-api-gateway.middleware.global.postAuthenticationPlugin. plugins · object[]

Show child attributes

x-tyk-api-gateway.middleware.global.postAuthenticationPlugin.plugins. enabled · boolean

x-tyk-api-gateway.middleware.global.postAuthenticationPlugin.plugins. functionName · string

x-tyk-api-gateway.middleware.global.postAuthenticationPlugin.plugins. path · string

x-tyk-api-gateway.middleware.global.postAuthenticationPlugin.plugins. rawBodyOnly · boolean

x-tyk-api-gateway.middleware.global.postAuthenticationPlugin.plugins. requireSession · boolean

x-tyk-api-gateway.middleware.global. postAuthenticationPlugins · object[]

Show child attributes

x-tyk-api-gateway.middleware.global.postAuthenticationPlugins. enabled · boolean

x-tyk-api-gateway.middleware.global.postAuthenticationPlugins. functionName · string

x-tyk-api-gateway.middleware.global.postAuthenticationPlugins. path · string

x-tyk-api-gateway.middleware.global.postAuthenticationPlugins. rawBodyOnly · boolean

x-tyk-api-gateway.middleware.global.postAuthenticationPlugins. requireSession · boolean

x-tyk-api-gateway.middleware.global. postPlugin · object

Show child attributes

x-tyk-api-gateway.middleware.global.postPlugin. plugins · object[]

Show child attributes

x-tyk-api-gateway.middleware.global.postPlugin.plugins. enabled · boolean

x-tyk-api-gateway.middleware.global.postPlugin.plugins. functionName · string

x-tyk-api-gateway.middleware.global.postPlugin.plugins. path · string

x-tyk-api-gateway.middleware.global.postPlugin.plugins. rawBodyOnly · boolean

x-tyk-api-gateway.middleware.global.postPlugin.plugins. requireSession · boolean

x-tyk-api-gateway.middleware.global. postPlugins · object[]

Show child attributes

x-tyk-api-gateway.middleware.global.postPlugins. enabled · boolean

x-tyk-api-gateway.middleware.global.postPlugins. functionName · string

x-tyk-api-gateway.middleware.global.postPlugins. path · string

x-tyk-api-gateway.middleware.global.postPlugins. rawBodyOnly · boolean

x-tyk-api-gateway.middleware.global.postPlugins. requireSession · boolean

x-tyk-api-gateway.middleware.global. prePlugin · object

Show child attributes

x-tyk-api-gateway.middleware.global.prePlugin. plugins · object[]

Show child attributes

x-tyk-api-gateway.middleware.global.prePlugin.plugins. enabled · boolean

x-tyk-api-gateway.middleware.global.prePlugin.plugins. functionName · string

x-tyk-api-gateway.middleware.global.prePlugin.plugins. path · string

x-tyk-api-gateway.middleware.global.prePlugin.plugins. rawBodyOnly · boolean

x-tyk-api-gateway.middleware.global.prePlugin.plugins. requireSession · boolean

x-tyk-api-gateway.middleware.global. prePlugins · object[]

Show child attributes

x-tyk-api-gateway.middleware.global.prePlugins. enabled · boolean

x-tyk-api-gateway.middleware.global.prePlugins. functionName · string

x-tyk-api-gateway.middleware.global.prePlugins. path · string

x-tyk-api-gateway.middleware.global.prePlugins. rawBodyOnly · boolean

x-tyk-api-gateway.middleware.global.prePlugins. requireSession · boolean

x-tyk-api-gateway.middleware.global. responsePlugin · object

Show child attributes

x-tyk-api-gateway.middleware.global.responsePlugin. plugins · object[]

Show child attributes

x-tyk-api-gateway.middleware.global.responsePlugin.plugins. enabled · boolean

x-tyk-api-gateway.middleware.global.responsePlugin.plugins. functionName · string

x-tyk-api-gateway.middleware.global.responsePlugin.plugins. path · string

x-tyk-api-gateway.middleware.global.responsePlugin.plugins. rawBodyOnly · boolean

x-tyk-api-gateway.middleware.global.responsePlugin.plugins. requireSession · boolean

x-tyk-api-gateway.middleware.global. responsePlugins · object[]

Show child attributes

x-tyk-api-gateway.middleware.global.responsePlugins. enabled · boolean

x-tyk-api-gateway.middleware.global.responsePlugins. functionName · string

x-tyk-api-gateway.middleware.global.responsePlugins. path · string

x-tyk-api-gateway.middleware.global.responsePlugins. rawBodyOnly · boolean

x-tyk-api-gateway.middleware.global.responsePlugins. requireSession · boolean

x-tyk-api-gateway.middleware.global. trafficLogs · object

Show child attributes

x-tyk-api-gateway.middleware.global.trafficLogs. enabled · boolean

x-tyk-api-gateway.middleware.global. transformRequestHeaders · object

Show child attributes

x-tyk-api-gateway.middleware.global.transformRequestHeaders. add · object[]

Show child attributes

x-tyk-api-gateway.middleware.global.transformRequestHeaders.add. name · string

x-tyk-api-gateway.middleware.global.transformRequestHeaders.add. value · string

x-tyk-api-gateway.middleware.global.transformRequestHeaders. enabled · boolean

x-tyk-api-gateway.middleware.global.transformRequestHeaders. remove · string[]

x-tyk-api-gateway.middleware.global. transformResponseHeaders · object

Show child attributes

x-tyk-api-gateway.middleware.global.transformResponseHeaders. add · object[]

Show child attributes

x-tyk-api-gateway.middleware.global.transformResponseHeaders.add. name · string

x-tyk-api-gateway.middleware.global.transformResponseHeaders.add. value · string

x-tyk-api-gateway.middleware.global.transformResponseHeaders. enabled · boolean

x-tyk-api-gateway.middleware.global.transformResponseHeaders. remove · string[]

x-tyk-api-gateway.middleware. operations · object

Show child attributes

x-tyk-api-gateway.middleware.operations. {key} · object

Show child attributes

x-tyk-api-gateway.middleware.operations.{key}. allow · object

Show child attributes

x-tyk-api-gateway.middleware.operations.{key}.allow. enabled · boolean

x-tyk-api-gateway.middleware.operations.{key}.allow. ignoreCase · boolean

x-tyk-api-gateway.middleware.operations.{key}. block · object

Show child attributes

x-tyk-api-gateway.middleware.operations.{key}.block. enabled · boolean

x-tyk-api-gateway.middleware.operations.{key}.block. ignoreCase · boolean

x-tyk-api-gateway.middleware.operations.{key}. cache · object

Show child attributes

x-tyk-api-gateway.middleware.operations.{key}.cache. cacheByRegex · string

x-tyk-api-gateway.middleware.operations.{key}.cache. cacheResponseCodes · integer[]

x-tyk-api-gateway.middleware.operations.{key}.cache. enabled · boolean

x-tyk-api-gateway.middleware.operations.{key}.cache. timeout · integer<int64>

x-tyk-api-gateway.middleware.operations.{key}. circuitBreaker · object

Show child attributes

x-tyk-api-gateway.middleware.operations.{key}.circuitBreaker. coolDownPeriod · integer

x-tyk-api-gateway.middleware.operations.{key}.circuitBreaker. enabled · boolean

x-tyk-api-gateway.middleware.operations.{key}.circuitBreaker. halfOpenStateEnabled · boolean

x-tyk-api-gateway.middleware.operations.{key}.circuitBreaker. sampleSize · integer

x-tyk-api-gateway.middleware.operations.{key}.circuitBreaker. threshold · number<double>

x-tyk-api-gateway.middleware.operations.{key}. doNotTrackEndpoint · object

Show child attributes

x-tyk-api-gateway.middleware.operations.{key}.doNotTrackEndpoint. enabled · boolean

x-tyk-api-gateway.middleware.operations.{key}. enforceTimeout · object

Show child attributes

x-tyk-api-gateway.middleware.operations.{key}.enforceTimeout. enabled · boolean

x-tyk-api-gateway.middleware.operations.{key}.enforceTimeout. value · integer

x-tyk-api-gateway.middleware.operations.{key}. ignoreAuthentication · object

Show child attributes

x-tyk-api-gateway.middleware.operations.{key}.ignoreAuthentication. enabled · boolean

x-tyk-api-gateway.middleware.operations.{key}.ignoreAuthentication. ignoreCase · boolean

x-tyk-api-gateway.middleware.operations.{key}. internal · object

Show child attributes

x-tyk-api-gateway.middleware.operations.{key}.internal. enabled · boolean

x-tyk-api-gateway.middleware.operations.{key}. mockResponse · object

Show child attributes

x-tyk-api-gateway.middleware.operations.{key}.mockResponse. body · string

x-tyk-api-gateway.middleware.operations.{key}.mockResponse. code · integer

x-tyk-api-gateway.middleware.operations.{key}.mockResponse. enabled · boolean

x-tyk-api-gateway.middleware.operations.{key}.mockResponse. fromOASExamples · object

Show child attributes

x-tyk-api-gateway.middleware.operations.{key}.mockResponse.fromOASExamples. code · integer

x-tyk-api-gateway.middleware.operations.{key}.mockResponse.fromOASExamples. contentType · string

x-tyk-api-gateway.middleware.operations.{key}.mockResponse.fromOASExamples. enabled · boolean

x-tyk-api-gateway.middleware.operations.{key}.mockResponse.fromOASExamples. exampleName · string

x-tyk-api-gateway.middleware.operations.{key}.mockResponse. headers · object[]

Show child attributes

x-tyk-api-gateway.middleware.operations.{key}.mockResponse.headers. name · string

x-tyk-api-gateway.middleware.operations.{key}.mockResponse.headers. value · string

x-tyk-api-gateway.middleware.operations.{key}. postPlugins · object[]

Show child attributes

x-tyk-api-gateway.middleware.operations.{key}.postPlugins. enabled · boolean

x-tyk-api-gateway.middleware.operations.{key}.postPlugins. functionName · string

x-tyk-api-gateway.middleware.operations.{key}.postPlugins. name · string

x-tyk-api-gateway.middleware.operations.{key}.postPlugins. path · string

x-tyk-api-gateway.middleware.operations.{key}. rateLimit · object

Show child attributes

x-tyk-api-gateway.middleware.operations.{key}.rateLimit. enabled · boolean

x-tyk-api-gateway.middleware.operations.{key}.rateLimit. per · string<duration>

Example:

"PT2H30M15S"

x-tyk-api-gateway.middleware.operations.{key}.rateLimit. rate · integer

x-tyk-api-gateway.middleware.operations.{key}. requestSizeLimit · object

Show child attributes

x-tyk-api-gateway.middleware.operations.{key}.requestSizeLimit. enabled · boolean

x-tyk-api-gateway.middleware.operations.{key}.requestSizeLimit. value · integer<int64>

x-tyk-api-gateway.middleware.operations.{key}. trackEndpoint · object

Show child attributes

x-tyk-api-gateway.middleware.operations.{key}.trackEndpoint. enabled · boolean

x-tyk-api-gateway.middleware.operations.{key}. transformRequestBody · object

Show child attributes

x-tyk-api-gateway.middleware.operations.{key}.transformRequestBody. body · string

x-tyk-api-gateway.middleware.operations.{key}.transformRequestBody. enabled · boolean

x-tyk-api-gateway.middleware.operations.{key}.transformRequestBody. format · string

x-tyk-api-gateway.middleware.operations.{key}.transformRequestBody. path · string

x-tyk-api-gateway.middleware.operations.{key}. transformRequestHeaders · object

Show child attributes

x-tyk-api-gateway.middleware.operations.{key}.transformRequestHeaders. add · object[]

Show child attributes

x-tyk-api-gateway.middleware.operations.{key}.transformRequestHeaders.add. name · string

x-tyk-api-gateway.middleware.operations.{key}.transformRequestHeaders.add. value · string

x-tyk-api-gateway.middleware.operations.{key}.transformRequestHeaders. enabled · boolean

x-tyk-api-gateway.middleware.operations.{key}.transformRequestHeaders. remove · string[]

x-tyk-api-gateway.middleware.operations.{key}. transformRequestMethod · object

Show child attributes

x-tyk-api-gateway.middleware.operations.{key}.transformRequestMethod. enabled · boolean

x-tyk-api-gateway.middleware.operations.{key}.transformRequestMethod. toMethod · string

x-tyk-api-gateway.middleware.operations.{key}. transformResponseBody · object

Show child attributes

x-tyk-api-gateway.middleware.operations.{key}.transformResponseBody. body · string

x-tyk-api-gateway.middleware.operations.{key}.transformResponseBody. enabled · boolean

x-tyk-api-gateway.middleware.operations.{key}.transformResponseBody. format · string

x-tyk-api-gateway.middleware.operations.{key}.transformResponseBody. path · string

x-tyk-api-gateway.middleware.operations.{key}. transformResponseHeaders · object

Show child attributes

x-tyk-api-gateway.middleware.operations.{key}.transformResponseHeaders. add · object[]

Show child attributes

x-tyk-api-gateway.middleware.operations.{key}.transformResponseHeaders.add. name · string

x-tyk-api-gateway.middleware.operations.{key}.transformResponseHeaders.add. value · string

x-tyk-api-gateway.middleware.operations.{key}.transformResponseHeaders. enabled · boolean

x-tyk-api-gateway.middleware.operations.{key}.transformResponseHeaders. remove · string[]

x-tyk-api-gateway.middleware.operations.{key}. urlRewrite · object

Show child attributes

x-tyk-api-gateway.middleware.operations.{key}.urlRewrite. enabled · boolean

x-tyk-api-gateway.middleware.operations.{key}.urlRewrite. pattern · string

x-tyk-api-gateway.middleware.operations.{key}.urlRewrite. rewriteTo · string

x-tyk-api-gateway.middleware.operations.{key}.urlRewrite. triggers · object[]

Show child attributes

x-tyk-api-gateway.middleware.operations.{key}.urlRewrite.triggers. condition · string

x-tyk-api-gateway.middleware.operations.{key}.urlRewrite.triggers. rewriteTo · string

x-tyk-api-gateway.middleware.operations.{key}.urlRewrite.triggers. rules · object[]

Show child attributes

x-tyk-api-gateway.middleware.operations.{key}.urlRewrite.triggers.rules. in · string

x-tyk-api-gateway.middleware.operations.{key}.urlRewrite.triggers.rules. name · string

x-tyk-api-gateway.middleware.operations.{key}.urlRewrite.triggers.rules. negate · boolean

x-tyk-api-gateway.middleware.operations.{key}.urlRewrite.triggers.rules. pattern · string

x-tyk-api-gateway.middleware.operations.{key}. validateRequest · object

Show child attributes

x-tyk-api-gateway.middleware.operations.{key}.validateRequest. enabled · boolean

x-tyk-api-gateway.middleware.operations.{key}.validateRequest. errorResponseCode · integer

x-tyk-api-gateway.middleware.operations.{key}. virtualEndpoint · object

Show child attributes

x-tyk-api-gateway.middleware.operations.{key}.virtualEndpoint. body · string

x-tyk-api-gateway.middleware.operations.{key}.virtualEndpoint. enabled · boolean

x-tyk-api-gateway.middleware.operations.{key}.virtualEndpoint. functionName · string

x-tyk-api-gateway.middleware.operations.{key}.virtualEndpoint. name · string

x-tyk-api-gateway.middleware.operations.{key}.virtualEndpoint. path · string

x-tyk-api-gateway.middleware.operations.{key}.virtualEndpoint. proxyOnError · boolean

x-tyk-api-gateway.middleware.operations.{key}.virtualEndpoint. requireSession · boolean

x-tyk-api-gateway. server · object

Show child attributes

x-tyk-api-gateway.server. authentication · object

Show child attributes

x-tyk-api-gateway.server.authentication. baseIdentityProvider · string

x-tyk-api-gateway.server.authentication. custom · object

Show child attributes

x-tyk-api-gateway.server.authentication.custom. AuthSources · object

Show child attributes

x-tyk-api-gateway.server.authentication.custom.AuthSources. cookie · object

Show child attributes

x-tyk-api-gateway.server.authentication.custom.AuthSources.cookie. enabled · boolean

x-tyk-api-gateway.server.authentication.custom.AuthSources.cookie. name · string

x-tyk-api-gateway.server.authentication.custom.AuthSources. header · object

Show child attributes

x-tyk-api-gateway.server.authentication.custom.AuthSources.header. enabled · boolean

x-tyk-api-gateway.server.authentication.custom.AuthSources.header. name · string

x-tyk-api-gateway.server.authentication.custom.AuthSources. query · object

Show child attributes

x-tyk-api-gateway.server.authentication.custom.AuthSources.query. enabled · boolean

x-tyk-api-gateway.server.authentication.custom.AuthSources.query. name · string

x-tyk-api-gateway.server.authentication.custom. config · object

Show child attributes

x-tyk-api-gateway.server.authentication.custom.config. enabled · boolean

x-tyk-api-gateway.server.authentication.custom.config. functionName · string

x-tyk-api-gateway.server.authentication.custom.config. idExtractor · object

Show child attributes

x-tyk-api-gateway.server.authentication.custom.config.idExtractor. config · object

Show child attributes

x-tyk-api-gateway.server.authentication.custom.config.idExtractor.config. formParamName · string

x-tyk-api-gateway.server.authentication.custom.config.idExtractor.config. headerName · string

x-tyk-api-gateway.server.authentication.custom.config.idExtractor.config. regexp · string

x-tyk-api-gateway.server.authentication.custom.config.idExtractor.config. regexpMatchIndex · integer

x-tyk-api-gateway.server.authentication.custom.config.idExtractor.config. xPathExp · string

x-tyk-api-gateway.server.authentication.custom.config.idExtractor. enabled · boolean

x-tyk-api-gateway.server.authentication.custom.config.idExtractor. source · string

x-tyk-api-gateway.server.authentication.custom.config.idExtractor. with · string

x-tyk-api-gateway.server.authentication.custom.config. path · string

x-tyk-api-gateway.server.authentication.custom.config. rawBodyOnly · boolean

x-tyk-api-gateway.server.authentication.custom. enabled · boolean

x-tyk-api-gateway.server.authentication. enabled · boolean

x-tyk-api-gateway.server.authentication. hmac · object

Show child attributes

x-tyk-api-gateway.server.authentication.hmac. AuthSources · object

Show child attributes

x-tyk-api-gateway.server.authentication.hmac.AuthSources. cookie · object

Show child attributes

x-tyk-api-gateway.server.authentication.hmac.AuthSources.cookie. enabled · boolean

x-tyk-api-gateway.server.authentication.hmac.AuthSources.cookie. name · string

x-tyk-api-gateway.server.authentication.hmac.AuthSources. header · object

Show child attributes

x-tyk-api-gateway.server.authentication.hmac.AuthSources.header. enabled · boolean

x-tyk-api-gateway.server.authentication.hmac.AuthSources.header. name · string

x-tyk-api-gateway.server.authentication.hmac.AuthSources. query · object

Show child attributes

x-tyk-api-gateway.server.authentication.hmac.AuthSources.query. enabled · boolean

x-tyk-api-gateway.server.authentication.hmac.AuthSources.query. name · string

x-tyk-api-gateway.server.authentication.hmac. allowedAlgorithms · string[]

x-tyk-api-gateway.server.authentication.hmac. allowedClockSkew · number<double>

x-tyk-api-gateway.server.authentication.hmac. enabled · boolean

x-tyk-api-gateway.server.authentication. oidc · object

Show child attributes

x-tyk-api-gateway.server.authentication.oidc. AuthSources · object

Show child attributes

x-tyk-api-gateway.server.authentication.oidc.AuthSources. cookie · object

Show child attributes

x-tyk-api-gateway.server.authentication.oidc.AuthSources.cookie. enabled · boolean

x-tyk-api-gateway.server.authentication.oidc.AuthSources.cookie. name · string

x-tyk-api-gateway.server.authentication.oidc.AuthSources. header · object

Show child attributes

x-tyk-api-gateway.server.authentication.oidc.AuthSources.header. enabled · boolean

x-tyk-api-gateway.server.authentication.oidc.AuthSources.header. name · string

x-tyk-api-gateway.server.authentication.oidc.AuthSources. query · object

Show child attributes

x-tyk-api-gateway.server.authentication.oidc.AuthSources.query. enabled · boolean

x-tyk-api-gateway.server.authentication.oidc.AuthSources.query. name · string

x-tyk-api-gateway.server.authentication.oidc. enabled · boolean

x-tyk-api-gateway.server.authentication.oidc. providers · object[]

Show child attributes

x-tyk-api-gateway.server.authentication.oidc.providers. clientToPolicyMapping · object[]

Show child attributes

x-tyk-api-gateway.server.authentication.oidc.providers.clientToPolicyMapping. clientId · string

x-tyk-api-gateway.server.authentication.oidc.providers.clientToPolicyMapping. policyId · string

x-tyk-api-gateway.server.authentication.oidc.providers. issuer · string

x-tyk-api-gateway.server.authentication.oidc. scopes · object

Show child attributes

x-tyk-api-gateway.server.authentication.oidc.scopes. claimName · string

x-tyk-api-gateway.server.authentication.oidc.scopes. scopeToPolicyMapping · object[]

Show child attributes

x-tyk-api-gateway.server.authentication.oidc.scopes.scopeToPolicyMapping. policyId · string

x-tyk-api-gateway.server.authentication.oidc.scopes.scopeToPolicyMapping. scope · string

x-tyk-api-gateway.server.authentication.oidc. segregateByClientId · boolean

x-tyk-api-gateway.server.authentication. securitySchemes · object

Show child attributes

x-tyk-api-gateway.server.authentication.securitySchemes. {key} · any

x-tyk-api-gateway.server.authentication. stripAuthorizationData · boolean

x-tyk-api-gateway.server. clientCertificates · object

Show child attributes

x-tyk-api-gateway.server.clientCertificates. allowlist · string[] | null

x-tyk-api-gateway.server.clientCertificates. enabled · boolean

x-tyk-api-gateway.server. customDomain · object

Show child attributes

x-tyk-api-gateway.server.customDomain. certificates · string[]

x-tyk-api-gateway.server.customDomain. enabled · boolean

x-tyk-api-gateway.server.customDomain. name · string

x-tyk-api-gateway.server. detailedActivityLogs · object

Show child attributes

x-tyk-api-gateway.server.detailedActivityLogs. enabled · boolean

x-tyk-api-gateway.server. detailedTracing · object

Show child attributes

x-tyk-api-gateway.server.detailedTracing. enabled · boolean

x-tyk-api-gateway.server. eventHandlers · object[]

Show child attributes

x-tyk-api-gateway.server.eventHandlers. enabled · boolean

x-tyk-api-gateway.server.eventHandlers. id · string

x-tyk-api-gateway.server.eventHandlers. name · string

x-tyk-api-gateway.server.eventHandlers. trigger · string

x-tyk-api-gateway.server.eventHandlers. type · string

x-tyk-api-gateway.server. gatewayTags · object

Show child attributes

x-tyk-api-gateway.server.gatewayTags. enabled · boolean

x-tyk-api-gateway.server.gatewayTags. tags · string[] | null

x-tyk-api-gateway.server. listenPath · object

Show child attributes

x-tyk-api-gateway.server.listenPath. strip · boolean

x-tyk-api-gateway.server.listenPath. value · string

x-tyk-api-gateway. upstream · object

Show child attributes

x-tyk-api-gateway.upstream. certificatePinning · object

Show child attributes

x-tyk-api-gateway.upstream.certificatePinning. domainToPublicKeysMapping · object[] | null

Show child attributes

x-tyk-api-gateway.upstream.certificatePinning.domainToPublicKeysMapping. domain · string

x-tyk-api-gateway.upstream.certificatePinning.domainToPublicKeysMapping. publicKeys · string[] | null

x-tyk-api-gateway.upstream.certificatePinning. enabled · boolean

x-tyk-api-gateway.upstream. mutualTLS · object

Show child attributes

x-tyk-api-gateway.upstream.mutualTLS. domainToCertificateMapping · object[] | null

Show child attributes

x-tyk-api-gateway.upstream.mutualTLS.domainToCertificateMapping. certificate · string

x-tyk-api-gateway.upstream.mutualTLS.domainToCertificateMapping. domain · string

x-tyk-api-gateway.upstream.mutualTLS. enabled · boolean

x-tyk-api-gateway.upstream. rateLimit · object

Show child attributes

x-tyk-api-gateway.upstream.rateLimit. enabled · boolean

x-tyk-api-gateway.upstream.rateLimit. per · string<duration>

Example:

"PT2H30M15S"

x-tyk-api-gateway.upstream.rateLimit. rate · integer

x-tyk-api-gateway.upstream. serviceDiscovery · object

Show child attributes

x-tyk-api-gateway.upstream.serviceDiscovery. cache · object

Show child attributes

x-tyk-api-gateway.upstream.serviceDiscovery.cache. enabled · boolean

x-tyk-api-gateway.upstream.serviceDiscovery.cache. timeout · integer<int64>

x-tyk-api-gateway.upstream.serviceDiscovery. cacheTimeout · integer<int64>

x-tyk-api-gateway.upstream.serviceDiscovery. dataPath · string

x-tyk-api-gateway.upstream.serviceDiscovery. enabled · boolean

x-tyk-api-gateway.upstream.serviceDiscovery. endpointReturnsList · boolean

x-tyk-api-gateway.upstream.serviceDiscovery. parentDataPath · string

x-tyk-api-gateway.upstream.serviceDiscovery. portDataPath · string

x-tyk-api-gateway.upstream.serviceDiscovery. queryEndpoint · string

x-tyk-api-gateway.upstream.serviceDiscovery. targetPath · string

x-tyk-api-gateway.upstream.serviceDiscovery. useNestedQuery · boolean

x-tyk-api-gateway.upstream.serviceDiscovery. useTargetList · boolean

x-tyk-api-gateway.upstream. test · object

Show child attributes

x-tyk-api-gateway.upstream.test. serviceDiscovery · object

Show child attributes

x-tyk-api-gateway.upstream.test.serviceDiscovery. cache · object

Show child attributes

x-tyk-api-gateway.upstream.test.serviceDiscovery.cache. enabled · boolean

x-tyk-api-gateway.upstream.test.serviceDiscovery.cache. timeout · integer<int64>

x-tyk-api-gateway.upstream.test.serviceDiscovery. cacheTimeout · integer<int64>

x-tyk-api-gateway.upstream.test.serviceDiscovery. dataPath · string

x-tyk-api-gateway.upstream.test.serviceDiscovery. enabled · boolean

x-tyk-api-gateway.upstream.test.serviceDiscovery. endpointReturnsList · boolean

x-tyk-api-gateway.upstream.test.serviceDiscovery. parentDataPath · string

x-tyk-api-gateway.upstream.test.serviceDiscovery. portDataPath · string

x-tyk-api-gateway.upstream.test.serviceDiscovery. queryEndpoint · string

x-tyk-api-gateway.upstream.test.serviceDiscovery. targetPath · string

x-tyk-api-gateway.upstream.test.serviceDiscovery. useNestedQuery · boolean

x-tyk-api-gateway.upstream.test.serviceDiscovery. useTargetList · boolean

x-tyk-api-gateway.upstream. url · string