openapi: 3.0.0 info: title: Tyk Dashboard Admin Additional Permissions Export API version: 5.3.0 description: 'For Tyk On-Premises installations only, the Dashboard Admin API has two endpoints and is used to set up and provision a Tyk Dashboard instance without the command line. In order to use the Dashboard Admin API, you''ll need to get the `admin_secret` value from your Tyk Dashboard configurations. The secret you set should then be sent along as a header with each Dashboard Admin API Request in order for it to be successful: ``` admin-auth: ```' servers: - url: http://localhost/ - url: https://localhost/ security: - ApiKeyAuth: [] tags: - name: Export description: To make Tyk installations more portable, the Export API enables you to export key configuration objects required to back-up and re-deploy a basic Tyk Pro installation. paths: /admin/organisations/{orgID}: get: summary: Export Organisations description: The organisation object is the most fundamental object in a Tyk setup, all other ownership properties hang off the relationship between an organisation and its APIs, Policies and API Tokens. operationId: exportOrgs tags: - Export parameters: - name: orgID in: path description: ID of organisation required: true schema: type: string responses: '200': description: Organisation exported successfully. content: application/json: schema: properties: apis: type: array items: $ref: '#/components/schemas/APIDefinition' example: id: 53ac07777cbb8c2d53000002 owner_name: Test owner_slug: test cname_enabled: true cname: my.domain.com apis: - api_human_name: API 2 api_id: 5fa2db834e07444f760b7ceb314209fb - api_human_name: API 1 api_id: 7a6ddeca9244448a4233866938a0d6e2 - api_human_name: API 3 api_id: 109eacaa50b24b64651a1d4dce8ec385 developer_quota: 123 developer_count: 21 event_options: key_event: webhook: '' email: '' redis: true key_request_event: webhook: '' email: '' redis: false hybrid_enabled: false ui: languages: {} hide_help: false default_lang: '' login_page: {} nav: {} uptime: {} portal_section: {} designer: {} dont_show_admin_sockets: false dont_allow_license_management: false dont_allow_license_management_view: false '400': description: Back Request. content: application/json: schema: $ref: '#/components/schemas/apiStatusMessage' example: Status: Error Message: Request body malformed '401': description: Unauthorized. content: application/json: schema: $ref: '#/components/schemas/apiStatusMessage' example: Status: Error Message: Not authorised '404': description: Org not found. content: application/json: schema: $ref: '#/components/schemas/apiStatusMessage' example: Status: Error Message: Could not retrieve org detail components: schemas: Regexp: description: Regexp is a wrapper around regexp.Regexp but with caching properties: FromCache: type: boolean type: object x-go-package: github.com/TykTechnologies/tyk/regexp apiStatusMessage: description: apiStatusMessage represents an API status message properties: message: description: Response details type: string x-go-name: Message status: type: string x-go-name: Status type: object x-go-package: github.com/TykTechnologies/tyk MiddlewareDriver: type: string x-go-package: github.com/TykTechnologies/tyk/apidef RoutingTriggerOptions: properties: header_matches: additionalProperties: $ref: '#/components/schemas/StringRegexMap' type: object x-go-name: HeaderMatches path_part_matches: additionalProperties: $ref: '#/components/schemas/StringRegexMap' type: object x-go-name: PathPartMatches payload_matches: $ref: '#/components/schemas/StringRegexMap' query_val_matches: additionalProperties: $ref: '#/components/schemas/StringRegexMap' type: object x-go-name: QueryValMatches request_context_matches: additionalProperties: $ref: '#/components/schemas/StringRegexMap' type: object x-go-name: RequestContextMatches session_meta_matches: additionalProperties: $ref: '#/components/schemas/StringRegexMap' type: object x-go-name: SessionMetaMatches type: object x-go-package: github.com/TykTechnologies/tyk/apidef StorageEngineCode: type: string x-go-package: github.com/TykTechnologies/tyk/apidef MiddlewareDefinition: properties: name: type: string x-go-name: Name path: type: string x-go-name: Path require_session: type: boolean x-go-name: RequireSession type: object x-go-package: github.com/TykTechnologies/tyk/apidef ValidatePathMeta: properties: error_response_code: description: Allows override of default 422 Unprocessible Entity response code for validation errors. format: int64 type: integer x-go-name: ErrorResponseCode method: type: string x-go-name: Method path: type: string x-go-name: Path schema: additionalProperties: type: object type: object x-go-name: Schema schema_b64: type: string x-go-name: SchemaB64 type: object x-go-package: github.com/TykTechnologies/tyk/apidef TransformJQMeta: properties: filter: type: string x-go-name: Filter method: type: string x-go-name: Method path: type: string x-go-name: Path type: object x-go-package: github.com/TykTechnologies/tyk/apidef ObjectId: description: http://www.mongodb.org/display/DOCS/Object+IDs title: ObjectId is a unique ID identifying a BSON value. It must be exactly 12 bytes long. MongoDB objects by default have such a property set in their "_id" property. type: string x-go-package: github.com/TykTechnologies/tyk/vendor/gopkg.in/mgo.v2/bson StringRegexMap: properties: match_rx: type: string x-go-name: MatchPattern reverse: type: boolean x-go-name: Reverse type: object x-go-package: github.com/TykTechnologies/tyk/apidef InternalMeta: properties: method: type: string x-go-name: Method path: type: string x-go-name: Path type: object x-go-package: github.com/TykTechnologies/tyk/apidef ServiceDiscoveryConfiguration: properties: cache_timeout: format: int64 type: integer x-go-name: CacheTimeout data_path: type: string x-go-name: DataPath endpoint_returns_list: type: boolean x-go-name: EndpointReturnsList parent_data_path: type: string x-go-name: ParentDataPath port_data_path: type: string x-go-name: PortDataPath query_endpoint: type: string x-go-name: QueryEndpoint target_path: type: string x-go-name: TargetPath use_discovery_service: type: boolean x-go-name: UseDiscoveryService use_nested_query: type: boolean x-go-name: UseNestedQuery use_target_list: type: boolean x-go-name: UseTargetList type: object x-go-package: github.com/TykTechnologies/tyk/apidef GlobalRateLimit: properties: per: format: double type: number x-go-name: Per rate: format: double type: number x-go-name: Rate type: object x-go-package: github.com/TykTechnologies/tyk/apidef TrackEndpointMeta: properties: method: type: string x-go-name: Method path: type: string x-go-name: Path type: object x-go-package: github.com/TykTechnologies/tyk/apidef HeaderInjectionMeta: properties: act_on: type: boolean x-go-name: ActOnResponse add_headers: additionalProperties: type: string type: object x-go-name: AddHeaders delete_headers: items: type: string type: array x-go-name: DeleteHeaders method: type: string x-go-name: Method path: type: string x-go-name: Path type: object x-go-package: github.com/TykTechnologies/tyk/apidef RequestInputType: type: string x-go-package: github.com/TykTechnologies/tyk/apidef MiddlewareIdExtractor: properties: extract_from: $ref: '#/components/schemas/IdExtractorSource' extract_with: $ref: '#/components/schemas/IdExtractorType' extractor_config: additionalProperties: type: object type: object x-go-name: ExtractorConfig type: object x-go-package: github.com/TykTechnologies/tyk/apidef HostCheckObject: properties: body: type: string x-go-name: Body headers: additionalProperties: type: string type: object x-go-name: Headers method: type: string x-go-name: Method url: type: string x-go-name: CheckURL type: object x-go-package: github.com/TykTechnologies/tyk/apidef ResponseProcessor: properties: name: type: string x-go-name: Name options: type: object x-go-name: Options type: object x-go-package: github.com/TykTechnologies/tyk/apidef MiddlewareSection: properties: auth_check: $ref: '#/components/schemas/MiddlewareDefinition' driver: $ref: '#/components/schemas/MiddlewareDriver' id_extractor: $ref: '#/components/schemas/MiddlewareIdExtractor' post: items: $ref: '#/components/schemas/MiddlewareDefinition' type: array x-go-name: Post post_key_auth: items: $ref: '#/components/schemas/MiddlewareDefinition' type: array x-go-name: PostKeyAuth pre: items: $ref: '#/components/schemas/MiddlewareDefinition' type: array x-go-name: Pre response: items: $ref: '#/components/schemas/MiddlewareDefinition' type: array x-go-name: Response type: object x-go-package: github.com/TykTechnologies/tyk/apidef AccessRequestType: description: AccessRequestType is the type for OAuth param `grant_type` type: string x-go-package: github.com/TykTechnologies/tyk/vendor/github.com/lonelycode/osin RoutingTrigger: properties: 'on': $ref: '#/components/schemas/RoutingTriggerOnType' options: $ref: '#/components/schemas/RoutingTriggerOptions' rewrite_to: type: string x-go-name: RewriteTo type: object x-go-package: github.com/TykTechnologies/tyk/apidef SessionProviderMeta: properties: meta: additionalProperties: type: object type: object x-go-name: Meta name: $ref: '#/components/schemas/SessionProviderCode' storage_engine: $ref: '#/components/schemas/StorageEngineCode' type: object x-go-package: github.com/TykTechnologies/tyk/apidef CacheMeta: properties: cache_response_codes: items: format: int64 type: integer type: array x-go-name: CacheOnlyResponseCodes cache_key_regex: type: string x-go-name: CacheKeyRegex method: type: string x-go-name: Method path: type: string x-go-name: Path type: object x-go-package: github.com/TykTechnologies/tyk/apidef SignatureConfig: properties: algorithm: type: string x-go-name: Algorithm allowed_clock_skew: format: int64 type: integer x-go-name: AllowedClockSkew error_code: format: int64 type: integer x-go-name: ErrorCode error_message: type: string x-go-name: ErrorMessage header: type: string x-go-name: Header secret: type: string x-go-name: Secret type: object x-go-package: github.com/TykTechnologies/tyk/apidef CircuitBreakerMeta: properties: method: type: string x-go-name: Method path: type: string x-go-name: Path return_to_service_after: format: int64 type: integer x-go-name: ReturnToServiceAfter samples: format: int64 type: integer x-go-name: Samples threshold_percent: format: double type: number x-go-name: ThresholdPercent type: object x-go-package: github.com/TykTechnologies/tyk/apidef TemplateMeta: properties: method: type: string x-go-name: Method path: type: string x-go-name: Path template_data: $ref: '#/components/schemas/TemplateData' type: object x-go-package: github.com/TykTechnologies/tyk/apidef EndpointMethodMeta: properties: action: $ref: '#/components/schemas/EndpointMethodAction' code: format: int64 type: integer x-go-name: Code data: type: string x-go-name: Data headers: additionalProperties: type: string type: object x-go-name: Headers type: object x-go-package: github.com/TykTechnologies/tyk/apidef VersionInfo: properties: paths: properties: black_list: items: type: string type: array x-go-name: BlackList ignored: items: type: string type: array x-go-name: Ignored white_list: items: type: string type: array x-go-name: WhiteList type: object x-go-name: Paths expires: type: string x-go-name: Expires extended_paths: $ref: '#/components/schemas/ExtendedPathsSet' global_headers: additionalProperties: type: string type: object x-go-name: GlobalHeaders global_headers_remove: items: type: string type: array x-go-name: GlobalHeadersRemove global_size_limit: format: int64 type: integer x-go-name: GlobalSizeLimit name: type: string x-go-name: Name override_target: type: string x-go-name: OverrideTarget use_extended_paths: type: boolean x-go-name: UseExtendedPaths type: object x-go-package: github.com/TykTechnologies/tyk/apidef HardTimeoutMeta: properties: method: type: string x-go-name: Method path: type: string x-go-name: Path timeout: format: int64 type: integer x-go-name: TimeOut type: object x-go-package: github.com/TykTechnologies/tyk/apidef SessionProviderCode: type: string x-go-package: github.com/TykTechnologies/tyk/apidef EndpointMethodAction: type: string x-go-package: github.com/TykTechnologies/tyk/apidef TemplateData: properties: enable_session: type: boolean x-go-name: EnableSession input_type: $ref: '#/components/schemas/RequestInputType' template_mode: $ref: '#/components/schemas/TemplateMode' template_source: type: string x-go-name: TemplateSource type: object x-go-package: github.com/TykTechnologies/tyk/apidef RequestSizeMeta: properties: method: type: string x-go-name: Method path: type: string x-go-name: Path size_limit: format: int64 type: integer x-go-name: SizeLimit type: object x-go-package: github.com/TykTechnologies/tyk/apidef NotificationsManager: description: 'TODO: Make this more generic' properties: oauth_on_keychange_url: type: string x-go-name: OAuthKeyChangeURL shared_secret: type: string x-go-name: SharedSecret title: NotificationsManager handles sending notifications to OAuth endpoints to notify the provider of key changes. type: object x-go-package: github.com/TykTechnologies/tyk/apidef AuthTypeEnum: type: string x-go-package: github.com/TykTechnologies/tyk/apidef ExtendedPathsSet: properties: advance_cache_config: items: $ref: '#/components/schemas/CacheMeta' type: array x-go-name: AdvanceCacheConfig black_list: items: $ref: '#/components/schemas/EndPointMeta' type: array x-go-name: BlackList cache: items: type: string type: array x-go-name: Cached circuit_breakers: items: $ref: '#/components/schemas/CircuitBreakerMeta' type: array x-go-name: CircuitBreaker do_not_track_endpoints: items: $ref: '#/components/schemas/TrackEndpointMeta' type: array x-go-name: DoNotTrackEndpoints hard_timeouts: items: $ref: '#/components/schemas/HardTimeoutMeta' type: array x-go-name: HardTimeouts ignored: items: $ref: '#/components/schemas/EndPointMeta' type: array x-go-name: Ignored internal: items: $ref: '#/components/schemas/InternalMeta' type: array x-go-name: Internal method_transforms: items: $ref: '#/components/schemas/MethodTransformMeta' type: array x-go-name: MethodTransforms size_limits: items: $ref: '#/components/schemas/RequestSizeMeta' type: array x-go-name: SizeLimit track_endpoints: items: $ref: '#/components/schemas/TrackEndpointMeta' type: array x-go-name: TrackEndpoints transform: items: $ref: '#/components/schemas/TemplateMeta' type: array x-go-name: Transform transform_headers: items: $ref: '#/components/schemas/HeaderInjectionMeta' type: array x-go-name: TransformHeader transform_jq: items: $ref: '#/components/schemas/TransformJQMeta' type: array x-go-name: TransformJQ transform_jq_response: items: $ref: '#/components/schemas/TransformJQMeta' type: array x-go-name: TransformJQResponse transform_response: items: $ref: '#/components/schemas/TemplateMeta' type: array x-go-name: TransformResponse transform_response_headers: items: $ref: '#/components/schemas/HeaderInjectionMeta' type: array x-go-name: TransformResponseHeader url_rewrites: items: $ref: '#/components/schemas/URLRewriteMeta' type: array x-go-name: URLRewrite validate_json: items: $ref: '#/components/schemas/ValidatePathMeta' type: array x-go-name: ValidateJSON virtual: items: $ref: '#/components/schemas/VirtualMeta' type: array x-go-name: Virtual white_list: items: $ref: '#/components/schemas/EndPointMeta' type: array x-go-name: WhiteList type: object x-go-package: github.com/TykTechnologies/tyk/apidef OpenIDOptions: properties: providers: items: $ref: '#/components/schemas/OIDProviderConfig' type: array x-go-name: Providers segregate_by_client: type: boolean x-go-name: SegregateByClient type: object x-go-package: github.com/TykTechnologies/tyk/apidef AuthProviderMeta: properties: meta: additionalProperties: type: object type: object x-go-name: Meta name: $ref: '#/components/schemas/AuthProviderCode' storage_engine: $ref: '#/components/schemas/StorageEngineCode' type: object x-go-package: github.com/TykTechnologies/tyk/apidef TemplateMode: type: string x-go-package: github.com/TykTechnologies/tyk/apidef EndPointMeta: properties: method_actions: additionalProperties: $ref: '#/components/schemas/EndpointMethodMeta' type: object x-go-name: MethodActions path: type: string x-go-name: Path type: object x-go-package: github.com/TykTechnologies/tyk/apidef EventHandlerMetaConfig: properties: events: x-go-name: Events type: object x-go-package: github.com/TykTechnologies/tyk/apidef IdExtractorType: type: string x-go-package: github.com/TykTechnologies/tyk/apidef OIDProviderConfig: properties: client_ids: additionalProperties: type: string type: object x-go-name: ClientIDs issuer: type: string x-go-name: Issuer type: object x-go-package: github.com/TykTechnologies/tyk/apidef Auth: properties: auth_header_name: type: string x-go-name: AuthHeaderName cookie_name: type: string x-go-name: CookieName param_name: type: string x-go-name: ParamName signature: $ref: '#/components/schemas/SignatureConfig' use_certificate: type: boolean x-go-name: UseCertificate use_cookie: type: boolean x-go-name: UseCookie use_param: type: boolean x-go-name: UseParam validate_signature: type: boolean x-go-name: ValidateSignature type: object x-go-package: github.com/TykTechnologies/tyk/apidef RoutingTriggerOnType: type: string x-go-package: github.com/TykTechnologies/tyk/apidef VirtualMeta: properties: function_source_type: type: string x-go-name: FunctionSourceType function_source_uri: type: string x-go-name: FunctionSourceURI method: type: string x-go-name: Method path: type: string x-go-name: Path proxy_on_error: type: boolean x-go-name: ProxyOnError response_function_name: type: string x-go-name: ResponseFunctionName use_session: type: boolean x-go-name: UseSession type: object x-go-package: github.com/TykTechnologies/tyk/apidef APIDefinition: properties: tags: items: type: string type: array x-go-name: Tags CORS: properties: allow_credentials: type: boolean x-go-name: AllowCredentials allowed_headers: items: type: string type: array x-go-name: AllowedHeaders allowed_methods: items: type: string type: array x-go-name: AllowedMethods allowed_origins: items: type: string type: array x-go-name: AllowedOrigins debug: type: boolean x-go-name: Debug enable: type: boolean x-go-name: Enable exposed_headers: items: type: string type: array x-go-name: ExposedHeaders max_age: format: int64 type: integer x-go-name: MaxAge options_passthrough: type: boolean x-go-name: OptionsPassthrough type: object active: type: boolean x-go-name: Active allowed_ips: items: type: string type: array x-go-name: AllowedIPs api_id: type: string x-go-name: APIID auth: $ref: '#/components/schemas/Auth' auth_provider: $ref: '#/components/schemas/AuthProviderMeta' base_identity_provided_by: $ref: '#/components/schemas/AuthTypeEnum' basic_auth: properties: body_password_regexp: type: string x-go-name: BodyPasswordRegexp body_user_regexp: type: string x-go-name: BodyUserRegexp cache_ttl: format: int64 type: integer x-go-name: CacheTTL disable_caching: type: boolean x-go-name: DisableCaching extract_from_body: type: boolean x-go-name: ExtractFromBody type: object x-go-name: BasicAuth blacklisted_ips: items: type: string type: array x-go-name: BlacklistedIPs cache_options: $ref: '#/components/schemas/CacheOptions' certificates: items: type: string type: array x-go-name: Certificates client_certificates: items: type: string type: array x-go-name: ClientCertificates config_data: additionalProperties: type: object type: object x-go-name: ConfigData custom_middleware: $ref: '#/components/schemas/MiddlewareSection' custom_middleware_bundle: type: string x-go-name: CustomMiddlewareBundle definition: properties: key: type: string x-go-name: Key location: type: string x-go-name: Location strip_path: type: boolean x-go-name: StripPath type: object x-go-name: VersionDefinition disable_quota: type: boolean x-go-name: DisableQuota disable_rate_limit: type: boolean x-go-name: DisableRateLimit do_not_track: type: boolean x-go-name: DoNotTrack domain: type: string x-go-name: Domain dont_set_quota_on_create: type: boolean x-go-name: DontSetQuotasOnCreate enable_batch_request_support: type: boolean x-go-name: EnableBatchRequestSupport enable_context_vars: type: boolean x-go-name: EnableContextVars enable_coprocess_auth: type: boolean x-go-name: EnableCoProcessAuth enable_ip_blacklisting: type: boolean x-go-name: EnableIpBlacklisting enable_ip_whitelisting: type: boolean x-go-name: EnableIpWhiteListing enable_jwt: type: boolean x-go-name: EnableJWT enable_signature_checking: type: boolean x-go-name: EnableSignatureChecking event_handlers: $ref: '#/components/schemas/EventHandlerMetaConfig' expire_analytics_after: format: int64 type: integer x-go-name: ExpireAnalyticsAfter global_rate_limit: $ref: '#/components/schemas/GlobalRateLimit' hmac_allowed_algorithms: items: type: string type: array x-go-name: HmacAllowedAlgorithms hmac_allowed_clock_skew: format: double type: number x-go-name: HmacAllowedClockSkew id: $ref: '#/components/schemas/ObjectId' internal: type: boolean x-go-name: Internal jwt_client_base_field: type: string x-go-name: JWTClientIDBaseField jwt_expires_at_validation_skew: format: uint64 type: integer x-go-name: JWTExpiresAtValidationSkew jwt_identity_base_field: type: string x-go-name: JWTIdentityBaseField jwt_issued_at_validation_skew: format: uint64 type: integer x-go-name: JWTIssuedAtValidationSkew jwt_not_before_validation_skew: format: uint64 type: integer x-go-name: JWTNotBeforeValidationSkew jwt_policy_field_name: type: string x-go-name: JWTPolicyFieldName jwt_scope_claim_name: type: string x-go-name: JWTScopeClaimName jwt_scope_to_policy_mapping: additionalProperties: type: string type: object x-go-name: JWTScopeToPolicyMapping jwt_signing_method: type: string x-go-name: JWTSigningMethod jwt_skip_kid: type: boolean x-go-name: JWTSkipKid jwt_source: type: string x-go-name: JWTSource name: type: string x-go-name: Name notifications: $ref: '#/components/schemas/NotificationsManager' oauth_meta: properties: allowed_access_types: items: $ref: '#/components/schemas/AccessRequestType' type: array x-go-name: AllowedAccessTypes allowed_authorize_types: items: $ref: '#/components/schemas/AuthorizeRequestType' type: array x-go-name: AllowedAuthorizeTypes auth_login_redirect: type: string x-go-name: AuthorizeLoginRedirect type: object x-go-name: Oauth2Meta openid_options: $ref: '#/components/schemas/OpenIDOptions' org_id: type: string x-go-name: OrgID pinned_public_keys: additionalProperties: type: string type: object x-go-name: PinnedPublicKeys proxy: properties: check_host_against_uptime_tests: type: boolean x-go-name: CheckHostAgainstUptimeTests disable_strip_slash: type: boolean x-go-name: DisableStripSlash enable_load_balancing: type: boolean x-go-name: EnableLoadBalancing listen_path: type: string x-go-name: ListenPath preserve_host_header: type: boolean x-go-name: PreserveHostHeader service_discovery: $ref: '#/components/schemas/ServiceDiscoveryConfiguration' strip_listen_path: type: boolean x-go-name: StripListenPath target_list: items: type: string type: array x-go-name: Targets target_url: type: string x-go-name: TargetURL transport: properties: proxy_url: type: string x-go-name: ProxyURL ssl_ciphers: items: type: string type: array x-go-name: SSLCipherSuites ssl_insecure_skip_verify: type: boolean x-go-name: SSLInsecureSkipVerify ssl_min_version: format: uint16 type: integer x-go-name: SSLMinVersion type: object x-go-name: Transport type: object x-go-name: Proxy response_processors: items: $ref: '#/components/schemas/ResponseProcessor' type: array x-go-name: ResponseProcessors session_lifetime: format: int64 type: integer x-go-name: SessionLifetime session_provider: $ref: '#/components/schemas/SessionProviderMeta' slug: type: string x-go-name: Slug strip_auth_data: type: boolean x-go-name: StripAuthData tag_headers: items: type: string type: array x-go-name: TagHeaders upstream_certificates: additionalProperties: type: string type: object x-go-name: UpstreamCertificates uptime_tests: properties: check_list: items: $ref: '#/components/schemas/HostCheckObject' type: array x-go-name: CheckList config: properties: expire_utime_after: format: int64 type: integer x-go-name: ExpireUptimeAnalyticsAfter recheck_wait: format: int64 type: integer x-go-name: RecheckWait service_discovery: $ref: '#/components/schemas/ServiceDiscoveryConfiguration' type: object x-go-name: Config type: object x-go-name: UptimeTests use_basic_auth: type: boolean x-go-name: UseBasicAuth use_keyless: type: boolean x-go-name: UseKeylessAccess use_mutual_tls_auth: type: boolean x-go-name: UseMutualTLSAuth use_oauth2: type: boolean x-go-name: UseOauth2 use_openid: type: boolean x-go-name: UseOpenID use_standard_auth: type: boolean x-go-name: UseStandardAuth version_data: properties: default_version: type: string x-go-name: DefaultVersion not_versioned: type: boolean x-go-name: NotVersioned versions: additionalProperties: $ref: '#/components/schemas/VersionInfo' type: object x-go-name: Versions type: object x-go-name: VersionData title: APIDefinition represents the configuration for a single proxied API and it's versions. type: object x-go-package: github.com/TykTechnologies/tyk/apidef MethodTransformMeta: properties: method: type: string x-go-name: Method path: type: string x-go-name: Path to_method: type: string x-go-name: ToMethod type: object x-go-package: github.com/TykTechnologies/tyk/apidef CacheOptions: properties: cache_all_safe_requests: type: boolean x-go-name: CacheAllSafeRequests cache_control_ttl_header: type: string x-go-name: CacheControlTTLHeader cache_response_codes: items: format: int64 type: integer type: array x-go-name: CacheOnlyResponseCodes cache_timeout: format: int64 type: integer x-go-name: CacheTimeout enable_cache: type: boolean x-go-name: EnableCache enable_upstream_cache_control: type: boolean x-go-name: EnableUpstreamCacheControl type: object x-go-package: github.com/TykTechnologies/tyk/apidef AuthProviderCode: type: string x-go-package: github.com/TykTechnologies/tyk/apidef AuthorizeRequestType: description: AuthorizeRequestType is the type for OAuth param `response_type` type: string x-go-package: github.com/TykTechnologies/tyk/vendor/github.com/lonelycode/osin URLRewriteMeta: properties: MatchRegexp: $ref: '#/components/schemas/Regexp' match_pattern: type: string x-go-name: MatchPattern method: type: string x-go-name: Method path: type: string x-go-name: Path rewrite_to: type: string x-go-name: RewriteTo triggers: items: $ref: '#/components/schemas/RoutingTrigger' type: array x-go-name: Triggers type: object x-go-package: github.com/TykTechnologies/tyk/apidef IdExtractorSource: type: string x-go-package: github.com/TykTechnologies/tyk/apidef securitySchemes: ApiKeyAuth: type: apiKey in: header name: Admin-Auth