Get a Tyk OAS API definition.

Get Tyk OAS API definition using an API ID.

GET /tyk/apis/oas/{apiID}

Try it

Get a Tyk OAS API definition.

cURL

curl --request GET \
  --url https://{tenant}/tyk/apis/oas/{apiID} \
  --header 'X-Tyk-Authorization: <api-key>'

200

{
  "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": 123,
      "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

X-Tyk-Authorization · string · header · required

Api key

Path Parameters

apiID · string · required

ID of the API you want to fetch

Query Parameters

mode · enum<string>

By default mode is empty which means it will return the Tyk API OAS spec including the x-tyk-api-gateway part. When mode=public, the Tyk OAS API spec will exclude the x-tyk-api-gateway part in the response.

Available options: public

Response

200

application/json

OK

info · object

Show child attributes

info. dbId · string

info. expiration · string

info. id · string

info. name · string

info. orgId · string

info. state · object

Show child attributes

info.state. active · boolean

info.state. internal · boolean

info. versioning · object

Show child attributes

info.versioning. default · string

info.versioning. enabled · boolean

info.versioning. fallbackToDefault · boolean

info.versioning. key · string

info.versioning. location · string

info.versioning. name · string

info.versioning. stripVersioningData · boolean

info.versioning. urlVersioningPattern · string

info.versioning. versions · object[] | null

Show child attributes

info.versioning.versions. id · string

info.versioning.versions. name · string

middleware · object

Show child attributes

middleware. global · object

Show child attributes

middleware.global. cache · object

Show child attributes

middleware.global.cache. cacheAllSafeRequests · boolean

middleware.global.cache. cacheByHeaders · string[]

middleware.global.cache. cacheResponseCodes · integer[]

middleware.global.cache. controlTTLHeaderName · string

middleware.global.cache. enableUpstreamCacheControl · boolean

middleware.global.cache. enabled · boolean

middleware.global.cache. timeout · integer

middleware.global. contextVariables · object

Show child attributes

middleware.global.contextVariables. enabled · boolean

middleware.global. cors · object

Show child attributes

middleware.global.cors. allowCredentials · boolean

middleware.global.cors. allowedHeaders · string[]

middleware.global.cors. allowedMethods · string[]

middleware.global.cors. allowedOrigins · string[]

middleware.global.cors. debug · boolean

middleware.global.cors. enabled · boolean

middleware.global.cors. exposedHeaders · string[]

middleware.global.cors. maxAge · integer

middleware.global.cors. optionsPassthrough · boolean

middleware.global. pluginConfig · object

Show child attributes

middleware.global.pluginConfig. bundle · object

Show child attributes

middleware.global.pluginConfig.bundle. enabled · boolean

middleware.global.pluginConfig.bundle. path · string

middleware.global.pluginConfig. data · object

Show child attributes

middleware.global.pluginConfig.data. enabled · boolean

middleware.global.pluginConfig.data. value · object

Show child attributes

middleware.global.pluginConfig.data.value. {key} · any

middleware.global.pluginConfig. driver · string

middleware.global. postAuthenticationPlugin · object

Show child attributes

middleware.global.postAuthenticationPlugin. plugins · object[]

Show child attributes

middleware.global.postAuthenticationPlugin.plugins. enabled · boolean

middleware.global.postAuthenticationPlugin.plugins. functionName · string

middleware.global.postAuthenticationPlugin.plugins. path · string

middleware.global.postAuthenticationPlugin.plugins. rawBodyOnly · boolean

middleware.global.postAuthenticationPlugin.plugins. requireSession · boolean

middleware.global. postAuthenticationPlugins · object[]

Show child attributes

middleware.global.postAuthenticationPlugins. enabled · boolean

middleware.global.postAuthenticationPlugins. functionName · string

middleware.global.postAuthenticationPlugins. path · string

middleware.global.postAuthenticationPlugins. rawBodyOnly · boolean

middleware.global.postAuthenticationPlugins. requireSession · boolean

middleware.global. postPlugin · object

Show child attributes

middleware.global.postPlugin. plugins · object[]

Show child attributes

middleware.global.postPlugin.plugins. enabled · boolean

middleware.global.postPlugin.plugins. functionName · string

middleware.global.postPlugin.plugins. path · string

middleware.global.postPlugin.plugins. rawBodyOnly · boolean

middleware.global.postPlugin.plugins. requireSession · boolean

middleware.global. postPlugins · object[]

Show child attributes

middleware.global.postPlugins. enabled · boolean

middleware.global.postPlugins. functionName · string

middleware.global.postPlugins. path · string

middleware.global.postPlugins. rawBodyOnly · boolean

middleware.global.postPlugins. requireSession · boolean

middleware.global. prePlugin · object

Show child attributes

middleware.global.prePlugin. plugins · object[]

Show child attributes

middleware.global.prePlugin.plugins. enabled · boolean

middleware.global.prePlugin.plugins. functionName · string

middleware.global.prePlugin.plugins. path · string

middleware.global.prePlugin.plugins. rawBodyOnly · boolean

middleware.global.prePlugin.plugins. requireSession · boolean

middleware.global. prePlugins · object[]

Show child attributes

middleware.global.prePlugins. enabled · boolean

middleware.global.prePlugins. functionName · string

middleware.global.prePlugins. path · string

middleware.global.prePlugins. rawBodyOnly · boolean

middleware.global.prePlugins. requireSession · boolean

middleware.global. responsePlugin · object

Show child attributes

middleware.global.responsePlugin. plugins · object[]

Show child attributes

middleware.global.responsePlugin.plugins. enabled · boolean

middleware.global.responsePlugin.plugins. functionName · string

middleware.global.responsePlugin.plugins. path · string

middleware.global.responsePlugin.plugins. rawBodyOnly · boolean

middleware.global.responsePlugin.plugins. requireSession · boolean

middleware.global. responsePlugins · object[]

Show child attributes

middleware.global.responsePlugins. enabled · boolean

middleware.global.responsePlugins. functionName · string

middleware.global.responsePlugins. path · string

middleware.global.responsePlugins. rawBodyOnly · boolean

middleware.global.responsePlugins. requireSession · boolean

middleware.global. trafficLogs · object

Show child attributes

middleware.global.trafficLogs. enabled · boolean

middleware.global. transformRequestHeaders · object

Show child attributes

middleware.global.transformRequestHeaders. add · object[]

Show child attributes

middleware.global.transformRequestHeaders.add. name · string

middleware.global.transformRequestHeaders.add. value · string

middleware.global.transformRequestHeaders. enabled · boolean

middleware.global.transformRequestHeaders. remove · string[]

middleware.global. transformResponseHeaders · object

Show child attributes

middleware.global.transformResponseHeaders. add · object[]

Show child attributes

middleware.global.transformResponseHeaders.add. name · string

middleware.global.transformResponseHeaders.add. value · string

middleware.global.transformResponseHeaders. enabled · boolean

middleware.global.transformResponseHeaders. remove · string[]

middleware. operations · object

Show child attributes

middleware.operations. {key} · object

Show child attributes

middleware.operations.{key}. allow · object

Show child attributes

middleware.operations.{key}.allow. enabled · boolean

middleware.operations.{key}.allow. ignoreCase · boolean

middleware.operations.{key}. block · object

Show child attributes

middleware.operations.{key}.block. enabled · boolean

middleware.operations.{key}.block. ignoreCase · boolean

middleware.operations.{key}. cache · object

Show child attributes

middleware.operations.{key}.cache. cacheByRegex · string

middleware.operations.{key}.cache. cacheResponseCodes · integer[]

middleware.operations.{key}.cache. enabled · boolean

middleware.operations.{key}.cache. timeout · integer

middleware.operations.{key}. circuitBreaker · object

Show child attributes

middleware.operations.{key}.circuitBreaker. coolDownPeriod · integer

middleware.operations.{key}.circuitBreaker. enabled · boolean

middleware.operations.{key}.circuitBreaker. halfOpenStateEnabled · boolean

middleware.operations.{key}.circuitBreaker. sampleSize · integer

middleware.operations.{key}.circuitBreaker. threshold · number

middleware.operations.{key}. doNotTrackEndpoint · object

Show child attributes

middleware.operations.{key}.doNotTrackEndpoint. enabled · boolean

middleware.operations.{key}. enforceTimeout · object

Show child attributes

middleware.operations.{key}.enforceTimeout. enabled · boolean

middleware.operations.{key}.enforceTimeout. value · integer

middleware.operations.{key}. ignoreAuthentication · object

Show child attributes

middleware.operations.{key}.ignoreAuthentication. enabled · boolean

middleware.operations.{key}.ignoreAuthentication. ignoreCase · boolean

middleware.operations.{key}. internal · object

Show child attributes

middleware.operations.{key}.internal. enabled · boolean

middleware.operations.{key}. mockResponse · object

Show child attributes

middleware.operations.{key}.mockResponse. body · string

middleware.operations.{key}.mockResponse. code · integer

middleware.operations.{key}.mockResponse. enabled · boolean

middleware.operations.{key}.mockResponse. fromOASExamples · object

Show child attributes

middleware.operations.{key}.mockResponse.fromOASExamples. code · integer

middleware.operations.{key}.mockResponse.fromOASExamples. contentType · string

middleware.operations.{key}.mockResponse.fromOASExamples. enabled · boolean

middleware.operations.{key}.mockResponse.fromOASExamples. exampleName · string

middleware.operations.{key}.mockResponse. headers · object[]

Show child attributes

middleware.operations.{key}.mockResponse.headers. name · string

middleware.operations.{key}.mockResponse.headers. value · string

middleware.operations.{key}. postPlugins · object[]

Show child attributes

middleware.operations.{key}.postPlugins. enabled · boolean

middleware.operations.{key}.postPlugins. functionName · string

middleware.operations.{key}.postPlugins. name · string

middleware.operations.{key}.postPlugins. path · string

middleware.operations.{key}. rateLimit · object

Show child attributes

middleware.operations.{key}.rateLimit. enabled · boolean

middleware.operations.{key}.rateLimit. per · integer

middleware.operations.{key}.rateLimit. rate · integer

middleware.operations.{key}. requestSizeLimit · object

Show child attributes

middleware.operations.{key}.requestSizeLimit. enabled · boolean

middleware.operations.{key}.requestSizeLimit. value · integer

middleware.operations.{key}. trackEndpoint · object

Show child attributes

middleware.operations.{key}.trackEndpoint. enabled · boolean

middleware.operations.{key}. transformRequestBody · object

Show child attributes

middleware.operations.{key}.transformRequestBody. body · string

middleware.operations.{key}.transformRequestBody. enabled · boolean

middleware.operations.{key}.transformRequestBody. format · string

middleware.operations.{key}.transformRequestBody. path · string

middleware.operations.{key}. transformRequestHeaders · object

Show child attributes

middleware.operations.{key}.transformRequestHeaders. add · object[]

Show child attributes

middleware.operations.{key}.transformRequestHeaders.add. name · string

middleware.operations.{key}.transformRequestHeaders.add. value · string

middleware.operations.{key}.transformRequestHeaders. enabled · boolean

middleware.operations.{key}.transformRequestHeaders. remove · string[]

middleware.operations.{key}. transformRequestMethod · object

Show child attributes

middleware.operations.{key}.transformRequestMethod. enabled · boolean

middleware.operations.{key}.transformRequestMethod. toMethod · string

middleware.operations.{key}. transformResponseBody · object

Show child attributes

middleware.operations.{key}.transformResponseBody. body · string

middleware.operations.{key}.transformResponseBody. enabled · boolean

middleware.operations.{key}.transformResponseBody. format · string

middleware.operations.{key}.transformResponseBody. path · string

middleware.operations.{key}. transformResponseHeaders · object

Show child attributes

middleware.operations.{key}.transformResponseHeaders. add · object[]

Show child attributes

middleware.operations.{key}.transformResponseHeaders.add. name · string

middleware.operations.{key}.transformResponseHeaders.add. value · string

middleware.operations.{key}.transformResponseHeaders. enabled · boolean

middleware.operations.{key}.transformResponseHeaders. remove · string[]

middleware.operations.{key}. urlRewrite · object

Show child attributes

middleware.operations.{key}.urlRewrite. enabled · boolean

middleware.operations.{key}.urlRewrite. pattern · string

middleware.operations.{key}.urlRewrite. rewriteTo · string

middleware.operations.{key}.urlRewrite. triggers · object[]

Show child attributes

middleware.operations.{key}.urlRewrite.triggers. condition · string

middleware.operations.{key}.urlRewrite.triggers. rewriteTo · string

middleware.operations.{key}.urlRewrite.triggers. rules · object[]

Show child attributes

middleware.operations.{key}.urlRewrite.triggers.rules. in · string

middleware.operations.{key}.urlRewrite.triggers.rules. name · string

middleware.operations.{key}.urlRewrite.triggers.rules. negate · boolean

middleware.operations.{key}.urlRewrite.triggers.rules. pattern · string

middleware.operations.{key}. validateRequest · object

Show child attributes

middleware.operations.{key}.validateRequest. enabled · boolean

middleware.operations.{key}.validateRequest. errorResponseCode · integer

middleware.operations.{key}. virtualEndpoint · object

Show child attributes

middleware.operations.{key}.virtualEndpoint. body · string

middleware.operations.{key}.virtualEndpoint. enabled · boolean

middleware.operations.{key}.virtualEndpoint. functionName · string

middleware.operations.{key}.virtualEndpoint. name · string

middleware.operations.{key}.virtualEndpoint. path · string

middleware.operations.{key}.virtualEndpoint. proxyOnError · boolean

middleware.operations.{key}.virtualEndpoint. requireSession · boolean

server · object

Show child attributes

server. authentication · object

Show child attributes

server.authentication. baseIdentityProvider · string

server.authentication. custom · object

Show child attributes

server.authentication.custom. AuthSources · object

Show child attributes

server.authentication.custom.AuthSources. cookie · object

Show child attributes

server.authentication.custom.AuthSources.cookie. enabled · boolean

server.authentication.custom.AuthSources.cookie. name · string

server.authentication.custom.AuthSources. header · object

Show child attributes

server.authentication.custom.AuthSources.header. enabled · boolean

server.authentication.custom.AuthSources.header. name · string

server.authentication.custom.AuthSources. query · object

Show child attributes

server.authentication.custom.AuthSources.query. enabled · boolean

server.authentication.custom.AuthSources.query. name · string

server.authentication.custom. config · object

Show child attributes

server.authentication.custom.config. enabled · boolean

server.authentication.custom.config. functionName · string

server.authentication.custom.config. idExtractor · object

Show child attributes

server.authentication.custom.config.idExtractor. config · object

Show child attributes

server.authentication.custom.config.idExtractor.config. formParamName · string

server.authentication.custom.config.idExtractor.config. headerName · string

server.authentication.custom.config.idExtractor.config. regexp · string

server.authentication.custom.config.idExtractor.config. regexpMatchIndex · integer

server.authentication.custom.config.idExtractor.config. xPathExp · string

server.authentication.custom.config.idExtractor. enabled · boolean

server.authentication.custom.config.idExtractor. source · string

server.authentication.custom.config.idExtractor. with · string

server.authentication.custom.config. path · string

server.authentication.custom.config. rawBodyOnly · boolean

server.authentication.custom. enabled · boolean

server.authentication. enabled · boolean

server.authentication. hmac · object

Show child attributes

server.authentication.hmac. AuthSources · object

Show child attributes

server.authentication.hmac.AuthSources. cookie · object

Show child attributes

server.authentication.hmac.AuthSources.cookie. enabled · boolean

server.authentication.hmac.AuthSources.cookie. name · string

server.authentication.hmac.AuthSources. header · object

Show child attributes

server.authentication.hmac.AuthSources.header. enabled · boolean

server.authentication.hmac.AuthSources.header. name · string

server.authentication.hmac.AuthSources. query · object

Show child attributes

server.authentication.hmac.AuthSources.query. enabled · boolean

server.authentication.hmac.AuthSources.query. name · string

server.authentication.hmac. allowedAlgorithms · string[]

server.authentication.hmac. allowedClockSkew · number

server.authentication.hmac. enabled · boolean

server.authentication. oidc · object

Show child attributes

server.authentication.oidc. AuthSources · object

Show child attributes

server.authentication.oidc.AuthSources. cookie · object

Show child attributes

server.authentication.oidc.AuthSources.cookie. enabled · boolean

server.authentication.oidc.AuthSources.cookie. name · string

server.authentication.oidc.AuthSources. header · object

Show child attributes

server.authentication.oidc.AuthSources.header. enabled · boolean

server.authentication.oidc.AuthSources.header. name · string

server.authentication.oidc.AuthSources. query · object

Show child attributes

server.authentication.oidc.AuthSources.query. enabled · boolean

server.authentication.oidc.AuthSources.query. name · string

server.authentication.oidc. enabled · boolean

server.authentication.oidc. providers · object[]

Show child attributes

server.authentication.oidc.providers. clientToPolicyMapping · object[]

Show child attributes

server.authentication.oidc.providers.clientToPolicyMapping. clientId · string

server.authentication.oidc.providers.clientToPolicyMapping. policyId · string

server.authentication.oidc.providers. issuer · string

server.authentication.oidc. scopes · object

Show child attributes

server.authentication.oidc.scopes. claimName · string

server.authentication.oidc.scopes. scopeToPolicyMapping · object[]

Show child attributes

server.authentication.oidc.scopes.scopeToPolicyMapping. policyId · string

server.authentication.oidc.scopes.scopeToPolicyMapping. scope · string

server.authentication.oidc. segregateByClientId · boolean

server.authentication. securitySchemes · object

Show child attributes

server.authentication.securitySchemes. {key} · any

server.authentication. stripAuthorizationData · boolean

server. clientCertificates · object

Show child attributes

server.clientCertificates. allowlist · string[] | null

server.clientCertificates. enabled · boolean

server. customDomain · object

Show child attributes

server.customDomain. certificates · string[]

server.customDomain. enabled · boolean

server.customDomain. name · string

server. detailedActivityLogs · object

Show child attributes

server.detailedActivityLogs. enabled · boolean

server. detailedTracing · object

Show child attributes

server.detailedTracing. enabled · boolean

server. eventHandlers · object[]

Show child attributes

server.eventHandlers. enabled · boolean

server.eventHandlers. id · string

server.eventHandlers. name · string

server.eventHandlers. trigger · string

server.eventHandlers. type · string

server. gatewayTags · object

Show child attributes

server.gatewayTags. enabled · boolean

server.gatewayTags. tags · string[] | null

server. listenPath · object

Show child attributes

server.listenPath. strip · boolean

server.listenPath. value · string

upstream · object

Show child attributes

upstream. certificatePinning · object

Show child attributes

upstream.certificatePinning. domainToPublicKeysMapping · object[] | null

Show child attributes

upstream.certificatePinning.domainToPublicKeysMapping. domain · string

upstream.certificatePinning.domainToPublicKeysMapping. publicKeys · string[] | null

upstream.certificatePinning. enabled · boolean

upstream. mutualTLS · object

Show child attributes

upstream.mutualTLS. domainToCertificateMapping · object[] | null

Show child attributes

upstream.mutualTLS.domainToCertificateMapping. certificate · string

upstream.mutualTLS.domainToCertificateMapping. domain · string

upstream.mutualTLS. enabled · boolean

upstream. rateLimit · object

Show child attributes

upstream.rateLimit. enabled · boolean

upstream.rateLimit. per · integer

upstream.rateLimit. rate · integer

upstream. serviceDiscovery · object

Show child attributes

upstream.serviceDiscovery. cache · object

Show child attributes

upstream.serviceDiscovery.cache. enabled · boolean

upstream.serviceDiscovery.cache. timeout · integer

upstream.serviceDiscovery. cacheTimeout · integer

upstream.serviceDiscovery. dataPath · string

upstream.serviceDiscovery. enabled · boolean

upstream.serviceDiscovery. endpointReturnsList · boolean

upstream.serviceDiscovery. parentDataPath · string

upstream.serviceDiscovery. portDataPath · string

upstream.serviceDiscovery. queryEndpoint · string

upstream.serviceDiscovery. targetPath · string

upstream.serviceDiscovery. useNestedQuery · boolean

upstream.serviceDiscovery. useTargetList · boolean

upstream. test · object

Show child attributes

upstream.test. serviceDiscovery · object

Show child attributes

upstream.test.serviceDiscovery. cache · object

Show child attributes

upstream.test.serviceDiscovery.cache. enabled · boolean

upstream.test.serviceDiscovery.cache. timeout · integer

upstream.test.serviceDiscovery. cacheTimeout · integer

upstream.test.serviceDiscovery. dataPath · string

upstream.test.serviceDiscovery. enabled · boolean

upstream.test.serviceDiscovery. endpointReturnsList · boolean

upstream.test.serviceDiscovery. parentDataPath · string

upstream.test.serviceDiscovery. portDataPath · string

upstream.test.serviceDiscovery. queryEndpoint · string

upstream.test.serviceDiscovery. targetPath · string

upstream.test.serviceDiscovery. useNestedQuery · boolean

upstream.test.serviceDiscovery. useTargetList · boolean

upstream. url · string