# Structs
AccessDefinition AccessDefinition defines which versions of an API a key has access to
swagger:model AccessDefinition.
AccessSpec AccessSpecs define what URLS a user has access to an what methods are enabled
swagger:model AccessSpec.
APIDefinition APIDefinition represents the configuration for a single proxied API and it's versions.
APIDefinitionCORS API definition c o r s
swagger:model APIDefinitionCORS.
APILimit APILimit stores quota and rate limit on ACL level (per API)
swagger:model APILimit.
AuthConfig auth config
swagger:model AuthConfig.
AuthProviderMeta auth provider meta
swagger:model AuthProviderMeta.
BasicAuth basic auth
swagger:model BasicAuth.
BasicAuthData basic auth data
swagger:model BasicAuthData.
BundleManifest bundle manifest
swagger:model BundleManifest.
CacheMeta cache meta
swagger:model CacheMeta.
CacheOptions cache options
swagger:model CacheOptions.
CheckCommand check command
swagger:model CheckCommand.
CircuitBreakerMeta circuit breaker meta
swagger:model CircuitBreakerMeta.
Config config
swagger:model Config.
EndPointMeta end point meta
swagger:model EndPointMeta.
EndpointMethodMeta endpoint method meta
swagger:model EndpointMethodMeta.
EventHandlerMetaConfig event handler meta config
swagger:model EventHandlerMetaConfig.
EventHandlerTriggerConfig event handler trigger config
swagger:model EventHandlerTriggerConfig.
ExtendedPathsSet extended paths set
swagger:model ExtendedPathsSet.
File File represents an uploaded file.
FileHeader A FileHeader describes a file part of a multipart request.
GlobalRateLimit global rate limit
swagger:model GlobalRateLimit.
HardTimeoutMeta hard timeout meta
swagger:model HardTimeoutMeta.
HeaderInjectionMeta header injection meta
swagger:model HeaderInjectionMeta.
HostCheckObject host check object
swagger:model HostCheckObject.
HReport h report
swagger:model HReport.
InternalMeta internal meta
swagger:model InternalMeta.
JWTData j w t data
swagger:model JWTData.
MethodTransformMeta method transform meta
swagger:model MethodTransformMeta.
MiddlewareDefinition middleware definition
swagger:model MiddlewareDefinition.
MiddlewareIDExtractor middleware Id extractor
swagger:model MiddlewareIdExtractor.
MiddlewareSection middleware section
swagger:model MiddlewareSection.
MiniRequestObject mini request object
swagger:model MiniRequestObject.
Monitor monitor
swagger:model Monitor.
MW m w
swagger:model MW.
NotificationsManager NotificationsManager handles sending notifications to OAuth endpoints to notify the provider of key changes.
Oauth2Meta oauth2 meta
swagger:model Oauth2Meta.
Object object
swagger:model Object.
OIDProviderConfig o ID provider config
swagger:model OIDProviderConfig.
OpenIDOptions open ID options
swagger:model OpenIDOptions.
Paths paths
swagger:model Paths.
Payload Payload is the default response
swagger:model Payload.
Plugin plugin
swagger:model Plugin.
Proxy proxy
swagger:model Proxy.
RequestSigningMeta request signing meta
swagger:model RequestSigningMeta.
RequestSizeMeta request size meta
swagger:model RequestSizeMeta.
ResponseProcessor response processor
swagger:model ResponseProcessor.
ReturnOverrides return overrides
swagger:model ReturnOverrides.
RoutingTrigger routing trigger
swagger:model RoutingTrigger.
RoutingTriggerOptions routing trigger options
swagger:model RoutingTriggerOptions.
ServiceDiscoveryConfiguration service discovery configuration
swagger:model ServiceDiscoveryConfiguration.
SessionProviderMeta session provider meta
swagger:model SessionProviderMeta.
SessionState SessionState objects represent a current API session, mainly used for rate limiting.
SignatureConfig signature config
swagger:model SignatureConfig.
StringRegexMap string regex map
swagger:model StringRegexMap.
TemplateData template data
swagger:model TemplateData.
TemplateMeta template meta
swagger:model TemplateMeta.
TrackEndpointMeta track endpoint meta
swagger:model TrackEndpointMeta.
TransformJQMeta transform j q meta
swagger:model TransformJQMeta.
Transport transport
swagger:model Transport.
UptimeTests uptime tests
swagger:model UptimeTests.
URLRewriteMeta URL rewrite meta
swagger:model URLRewriteMeta.
ValidatePathMeta validate path meta
swagger:model ValidatePathMeta.
VersionData version data
swagger:model VersionData.
VersionDefinition version definition
swagger:model VersionDefinition.
VersionInfo version info
swagger:model VersionInfo.
VirtualMeta virtual meta
swagger:model VirtualMeta.
# Type aliases
AccessRequestType AccessRequestType is the type for OAuth param `grant_type`
swagger:model AccessRequestType.
AuthorizeRequestType AuthorizeRequestType is the type for OAuth param `response_type`
swagger:model AuthorizeRequestType.
AuthProviderCode auth provider code
swagger:model AuthProviderCode.
AuthTypeEnum auth type enum
swagger:model AuthTypeEnum.
Duration A Duration represents the elapsed time between two instants as an int64 nanosecond count.
EndpointMethodAction endpoint method action
swagger:model EndpointMethodAction.
HashType hash type
swagger:model HashType.
HookType hook type
swagger:model HookType.
IDExtractorSource Id extractor source
swagger:model IdExtractorSource.
IDExtractorType Id extractor type
swagger:model IdExtractorType.
MiddlewareDriver middleware driver
swagger:model MiddlewareDriver.
MIMEHeader A MIMEHeader represents a MIME-style header mapping keys to sets of values.
RequestInputType request input type
swagger:model RequestInputType.
RoutingTriggerOnType routing trigger on type
swagger:model RoutingTriggerOnType.
SessionProviderCode session provider code
swagger:model SessionProviderCode.
StorageEngineCode storage engine code
swagger:model StorageEngineCode.
TemplateMode template mode
swagger:model TemplateMode.
TykEventHandlerName tyk event handler name
swagger:model TykEventHandlerName.