Create API Definition

POST {{baseUrl}}/api/apis?base_api_id=<string>&base_api_version_name=<string>&new_version_name=<string>&set_default=<boolean>

Create an API Definition in Tyk Classic API format. Note that the response includes the newly created Tyk Classic API Definition containing the unique identifier for the API ( api_id). You can provide a value for the api_id in the request body, otherwise Tyk will automatically generate a value. The id field within the Tyk Classic API Definition is a proprietary field used by Tyk to identify the API within the database and cannot be chosen or modified by the user.

Request Params

KeyDatatypeRequiredDescription
base_api_idstringThe base API which the new version will be linked to.
base_api_version_namestringThe 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_namestringThe version name of the created version.
set_defaultstringIf true, the new version is set as default version.

Request Body

{"tags"=>["<string>", "<string>"], "CORS"=>{"allow_credentials"=>"<boolean>", "allowed_headers"=>["<string>", "<string>"], "allowed_methods"=>["<string>", "<string>"], "allowed_origins"=>["<string>", "<string>"], "debug"=>"<boolean>", "enable"=>"<boolean>", "exposed_headers"=>["<string>", "<string>"], "max_age"=>"<long>", "options_passthrough"=>"<boolean>"}, "active"=>"<boolean>", "allowed_ips"=>["<string>", "<string>"], "api_id"=>"<string>", "auth"=>{"auth_header_name"=>"<string>", "cookie_name"=>"<string>", "param_name"=>"<string>", "signature"=>{"algorithm"=>"<string>", "allowed_clock_skew"=>"<long>", "error_code"=>"<long>", "error_message"=>"<string>", "header"=>"<string>", "secret"=>"<string>"}, "use_certificate"=>"<boolean>", "use_cookie"=>"<boolean>", "use_param"=>"<boolean>", "validate_signature"=>"<boolean>"}, "auth_provider"=>{"name"=>"<string>", "storage_engine"=>"<string>"}, "base_identity_provided_by"=>"<string>", "basic_auth"=>{"body_password_regexp"=>"<string>", "body_user_regexp"=>"<string>", "cache_ttl"=>"<long>", "disable_caching"=>"<boolean>", "extract_from_body"=>"<boolean>"}, "blacklisted_ips"=>["<string>", "<string>"], "cache_options"=>{"cache_all_safe_requests"=>"<boolean>", "cache_control_ttl_header"=>"<string>", "cache_response_codes"=>["<long>", "<long>"], "cache_timeout"=>"<long>", "enable_cache"=>"<boolean>", "enable_upstream_cache_control"=>"<boolean>"}, "certificates"=>["<string>", "<string>"], "client_certificates"=>["<string>", "<string>"], "custom_middleware"=>{"auth_check"=>{"name"=>"<string>", "path"=>"<string>", "require_session"=>"<boolean>"}, "driver"=>"<string>", "id_extractor"=>{"extract_from"=>"<string>", "extract_with"=>"<string>"}, "post"=>[{"name"=>"<string>", "path"=>"<string>", "require_session"=>"<boolean>"}, {"name"=>"<string>", "path"=>"<string>", "require_session"=>"<boolean>"}], "post_key_auth"=>[{"name"=>"<string>", "path"=>"<string>", "require_session"=>"<boolean>"}, {"name"=>"<string>", "path"=>"<string>", "require_session"=>"<boolean>"}], "pre"=>[{"name"=>"<string>", "path"=>"<string>", "require_session"=>"<boolean>"}, {"name"=>"<string>", "path"=>"<string>", "require_session"=>"<boolean>"}], "response"=>[{"name"=>"<string>", "path"=>"<string>", "require_session"=>"<boolean>"}, {"name"=>"<string>", "path"=>"<string>", "require_session"=>"<boolean>"}]}, "custom_middleware_bundle"=>"<string>", "definition"=>{"key"=>"<string>", "location"=>"<string>", "strip_path"=>"<boolean>"}, "disable_quota"=>"<boolean>", "disable_rate_limit"=>"<boolean>", "do_not_track"=>"<boolean>", "domain"=>"<string>", "dont_set_quota_on_create"=>"<boolean>", "enable_batch_request_support"=>"<boolean>", "enable_context_vars"=>"<boolean>", "enable_coprocess_auth"=>"<boolean>", "enable_ip_blacklisting"=>"<boolean>", "enable_ip_whitelisting"=>"<boolean>", "enable_jwt"=>"<boolean>", "enable_signature_checking"=>"<boolean>", "event_handlers"=>{"events"=>{"x-go-name"=>"Events"}}, "expire_analytics_after"=>"<long>", "global_rate_limit"=>{"per"=>"<double>", "rate"=>"<double>"}, "hmac_allowed_algorithms"=>["<string>", "<string>"], "hmac_allowed_clock_skew"=>"<double>", "id"=>"<string>", "internal"=>"<boolean>", "jwt_client_base_field"=>"<string>", "jwt_expires_at_validation_skew"=>"<integer>", "jwt_identity_base_field"=>"<string>", "jwt_issued_at_validation_skew"=>"<integer>", "jwt_not_before_validation_skew"=>"<integer>", "jwt_policy_field_name"=>"<string>", "jwt_scope_claim_name"=>"<string>", "jwt_scope_to_policy_mapping"=>{"est98"=>"<string>"}, "jwt_signing_method"=>"<string>", "jwt_skip_kid"=>"<boolean>", "jwt_source"=>"<string>", "name"=>"<string>", "notifications"=>{"oauth_on_keychange_url"=>"<string>", "shared_secret"=>"<string>"}, "oauth_meta"=>{"allowed_access_types"=>["<string>", "<string>"], "allowed_authorize_types"=>["<string>", "<string>"], "auth_login_redirect"=>"<string>"}, "openid_options"=>{"providers"=>[{"client_ids"=>{"quisf0d"=>"<string>"}, "issuer"=>"<string>"}, {"client_ids"=>{"estd8"=>"<string>"}, "issuer"=>"<string>"}], "segregate_by_client"=>"<boolean>"}, "org_id"=>"<string>", "pinned_public_keys"=>{"ullamco435"=>"<string>"}, "proxy"=>{"check_host_against_uptime_tests"=>"<boolean>", "disable_strip_slash"=>"<boolean>", "enable_load_balancing"=>"<boolean>", "listen_path"=>"<string>", "preserve_host_header"=>"<boolean>", "service_discovery"=>{"cache_timeout"=>"<long>", "data_path"=>"<string>", "endpoint_returns_list"=>"<boolean>", "parent_data_path"=>"<string>", "port_data_path"=>"<string>", "query_endpoint"=>"<string>", "target_path"=>"<string>", "use_discovery_service"=>"<boolean>", "use_nested_query"=>"<boolean>", "use_target_list"=>"<boolean>"}, "strip_listen_path"=>"<boolean>", "target_list"=>["<string>", "<string>"], "target_url"=>"<string>", "transport"=>{"proxy_url"=>"<string>", "ssl_ciphers"=>["<string>", "<string>"], "ssl_insecure_skip_verify"=>"<boolean>", "ssl_min_version"=>"<integer>"}}, "response_processors"=>[{"name"=>"<string>"}, {"name"=>"<string>"}], "session_lifetime"=>"<long>", "session_provider"=>{"name"=>"<string>", "storage_engine"=>"<string>"}, "slug"=>"<string>", "strip_auth_data"=>"<boolean>", "tag_headers"=>["<string>", "<string>"], "upstream_certificates"=>{"proident_6"=>"<string>", "ipsum9"=>"<string>"}, "uptime_tests"=>{"check_list"=>[{"body"=>"<string>", "headers"=>{"pariatur_a"=>"<string>", "consequat_d7c"=>"<string>", "sit_f"=>"<string>"}, "method"=>"<string>", "url"=>"<string>"}, {"body"=>"<string>", "headers"=>{"aliqua_7f"=>"<string>"}, "method"=>"<string>", "url"=>"<string>"}], "config"=>{"expire_utime_after"=>"<long>", "recheck_wait"=>"<long>", "service_discovery"=>{"cache_timeout"=>"<long>", "data_path"=>"<string>", "endpoint_returns_list"=>"<boolean>", "parent_data_path"=>"<string>", "port_data_path"=>"<string>", "query_endpoint"=>"<string>", "target_path"=>"<string>", "use_discovery_service"=>"<boolean>", "use_nested_query"=>"<boolean>", "use_target_list"=>"<boolean>"}}}, "use_basic_auth"=>"<boolean>", "use_keyless"=>"<boolean>", "use_mutual_tls_auth"=>"<boolean>", "use_oauth2"=>"<boolean>", "use_openid"=>"<boolean>", "use_standard_auth"=>"<boolean>", "version_data"=>{"default_version"=>"<string>", "not_versioned"=>"<boolean>", "versions"=>{"officiaac5"=>{"paths"=>{"black_list"=>["<string>", "<string>"], "ignored"=>["<string>", "<string>"], "white_list"=>["<string>", "<string>"]}, "expires"=>"<string>", "extended_paths"=>{"advance_cache_config"=>[{"cache_response_codes"=>["<long>", "<long>"], "cache_key_regex"=>"<string>", "method"=>"<string>", "path"=>"<string>"}, {"cache_response_codes"=>["<long>", "<long>"], "cache_key_regex"=>"<string>", "method"=>"<string>", "path"=>"<string>"}], "black_list"=>[{"method_actions"=>{"magna_83"=>{"action"=>"<string>", "code"=>"<long>", "data"=>"<string>", "headers"=>{"eiusmodf0"=>"<string>"}}, "magna_f_"=>{"action"=>"<string>", "code"=>"<long>", "data"=>"<string>", "headers"=>{"labore35"=>"<string>", "Duis505"=>"<string>"}}, "Duis_35"=>{"action"=>"<string>", "code"=>"<long>", "data"=>"<string>", "headers"=>{"occaecatf"=>"<string>"}}, "incididunt3"=>{"action"=>"<string>", "code"=>"<long>", "data"=>"<string>", "headers"=>{"nostrud2__"=>"<string>", "quis_c"=>"<string>", "consectetur5"=>"<string>"}}, "enim_a"=>{"action"=>"<string>", "code"=>"<long>", "data"=>"<string>", "headers"=>{"cillum9"=>"<string>"}}}, "path"=>"<string>"}, {"method_actions"=>{"do_c"=>{"action"=>"<string>", "code"=>"<long>", "data"=>"<string>", "headers"=>{"Lorem_9"=>"<string>", "eiusmod31"=>"<string>", "sed_b4_"=>"<string>"}}, "ullamcod"=>{"action"=>"<string>", "code"=>"<long>", "data"=>"<string>", "headers"=>{"Duis70"=>"<string>", "cillum_d"=>"<string>"}}, "ea34"=>{"action"=>"<string>", "code"=>"<long>", "data"=>"<string>", "headers"=>{"consequat6d"=>"<string>"}}, "sunt_c"=>{"action"=>"<string>", "code"=>"<long>", "data"=>"<string>", "headers"=>{"sed_2"=>"<string>"}}}, "path"=>"<string>"}], "cache"=>["<string>", "<string>"], "circuit_breakers"=>[{"method"=>"<string>", "path"=>"<string>", "return_to_service_after"=>"<long>", "samples"=>"<long>", "threshold_percent"=>"<double>"}, {"method"=>"<string>", "path"=>"<string>", "return_to_service_after"=>"<long>", "samples"=>"<long>", "threshold_percent"=>"<double>"}], "do_not_track_endpoints"=>[{"method"=>"<string>", "path"=>"<string>"}, {"method"=>"<string>", "path"=>"<string>"}], "hard_timeouts"=>[{"method"=>"<string>", "path"=>"<string>", "timeout"=>"<long>"}, {"method"=>"<string>", "path"=>"<string>", "timeout"=>"<long>"}], "ignored"=>[{"method_actions"=>{"pariatur_54"=>{"action"=>"<string>", "code"=>"<long>", "data"=>"<string>", "headers"=>{"sit_7"=>"<string>"}}}, "path"=>"<string>"}, {"method_actions"=>{"laborum_5b0"=>{"action"=>"<string>", "code"=>"<long>", "data"=>"<string>", "headers"=>{"aliqua_4"=>"<string>", "cupidatatc"=>"<string>", "occaecat_57"=>"<string>", "sit46a"=>"<string>", "Duis0a5"=>"<string>"}}}, "path"=>"<string>"}], "internal"=>[{"method"=>"<string>", "path"=>"<string>"}, {"method"=>"<string>", "path"=>"<string>"}], "method_transforms"=>[{"method"=>"<string>", "path"=>"<string>", "to_method"=>"<string>"}, {"method"=>"<string>", "path"=>"<string>", "to_method"=>"<string>"}], "size_limits"=>[{"method"=>"<string>", "path"=>"<string>", "size_limit"=>"<long>"}, {"method"=>"<string>", "path"=>"<string>", "size_limit"=>"<long>"}], "track_endpoints"=>[{"method"=>"<string>", "path"=>"<string>"}, {"method"=>"<string>", "path"=>"<string>"}], "transform"=>[{"method"=>"<string>", "path"=>"<string>", "template_data"=>{"enable_session"=>"<boolean>", "input_type"=>"<string>", "template_mode"=>"<string>", "template_source"=>"<string>"}}, {"method"=>"<string>", "path"=>"<string>", "template_data"=>{"enable_session"=>"<boolean>", "input_type"=>"<string>", "template_mode"=>"<string>", "template_source"=>"<string>"}}], "transform_headers"=>[{"act_on"=>"<boolean>", "add_headers"=>{"eu_af"=>"<string>", "veniama_0"=>"<string>"}, "delete_headers"=>["<string>", "<string>"], "method"=>"<string>", "path"=>"<string>"}, {"act_on"=>"<boolean>", "add_headers"=>{"Loremc"=>"<string>", "inbeb"=>"<string>"}, "delete_headers"=>["<string>", "<string>"], "method"=>"<string>", "path"=>"<string>"}], "transform_jq"=>[{"filter"=>"<string>", "method"=>"<string>", "path"=>"<string>"}, {"filter"=>"<string>", "method"=>"<string>", "path"=>"<string>"}], "transform_jq_response"=>[{"filter"=>"<string>", "method"=>"<string>", "path"=>"<string>"}, {"filter"=>"<string>", "method"=>"<string>", "path"=>"<string>"}], "transform_response"=>[{"method"=>"<string>", "path"=>"<string>", "template_data"=>{"enable_session"=>"<boolean>", "input_type"=>"<string>", "template_mode"=>"<string>", "template_source"=>"<string>"}}, {"method"=>"<string>", "path"=>"<string>", "template_data"=>{"enable_session"=>"<boolean>", "input_type"=>"<string>", "template_mode"=>"<string>", "template_source"=>"<string>"}}], "transform_response_headers"=>[{"act_on"=>"<boolean>", "add_headers"=>{"veniam2d5"=>"<string>"}, "delete_headers"=>["<string>", "<string>"], "method"=>"<string>", "path"=>"<string>"}, {"act_on"=>"<boolean>", "add_headers"=>{"velit4ae"=>"<string>"}, "delete_headers"=>["<string>", "<string>"], "method"=>"<string>", "path"=>"<string>"}], "url_rewrites"=>[{"MatchRegexp"=>{"FromCache"=>"<boolean>"}, "match_pattern"=>"<string>", "method"=>"<string>", "path"=>"<string>", "rewrite_to"=>"<string>", "triggers"=>[{"on"=>"<string>", "options"=>{"header_matches"=>{"ut_2c"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "dod"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "path_part_matches"=>{"non__8e"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "ad_31"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "dolor9c8"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "payload_matches"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "query_val_matches"=>{"enim_b3"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "request_context_matches"=>{"consequat_24"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "session_meta_matches"=>{"eiusmod_1c"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "est6b"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}}, "rewrite_to"=>"<string>"}, {"on"=>"<string>", "options"=>{"header_matches"=>{"laborum0e"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "labore_3"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "path_part_matches"=>{"laboris6"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "payload_matches"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "query_val_matches"=>{"veniam2"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "request_context_matches"=>{"eiusmod_ebe"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "reprehenderit_643"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "session_meta_matches"=>{"iruree"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}}, "rewrite_to"=>"<string>"}]}, {"MatchRegexp"=>{"FromCache"=>"<boolean>"}, "match_pattern"=>"<string>", "method"=>"<string>", "path"=>"<string>", "rewrite_to"=>"<string>", "triggers"=>[{"on"=>"<string>", "options"=>{"header_matches"=>{"sunt_9"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "eu18a"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "path_part_matches"=>{"magna_a9"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "do_c24"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "voluptate_5b"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "payload_matches"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "query_val_matches"=>{"incididunt_d"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "laborum9b"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "laboris_c13"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "non169"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "request_context_matches"=>{"labore_5"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "session_meta_matches"=>{"incididunt_bb"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "pariatur08"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}}, "rewrite_to"=>"<string>"}, {"on"=>"<string>", "options"=>{"header_matches"=>{"labore_3"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "ind"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "path_part_matches"=>{"anim_c24"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "veniam7"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "labore_ef"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "payload_matches"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "query_val_matches"=>{"eiusmod5"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "non4e"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "request_context_matches"=>{"esse3c"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "session_meta_matches"=>{"qui_046"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "minimf"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}}, "rewrite_to"=>"<string>"}]}], "validate_json"=>[{"error_response_code"=>"<long>", "method"=>"<string>", "path"=>"<string>", "schema_b64"=>"<string>"}, {"error_response_code"=>"<long>", "method"=>"<string>", "path"=>"<string>", "schema_b64"=>"<string>"}], "virtual"=>[{"function_source_type"=>"<string>", "function_source_uri"=>"<string>", "method"=>"<string>", "path"=>"<string>", "proxy_on_error"=>"<boolean>", "response_function_name"=>"<string>", "use_session"=>"<boolean>"}, {"function_source_type"=>"<string>", "function_source_uri"=>"<string>", "method"=>"<string>", "path"=>"<string>", "proxy_on_error"=>"<boolean>", "response_function_name"=>"<string>", "use_session"=>"<boolean>"}], "white_list"=>[{"method_actions"=>{"labore4"=>{"action"=>"<string>", "code"=>"<long>", "data"=>"<string>", "headers"=>{"voluptateee"=>"<string>", "officiac"=>"<string>", "ad93e"=>"<string>", "enim_8"=>"<string>"}}}, "path"=>"<string>"}, {"method_actions"=>{"culpa_2"=>{"action"=>"<string>", "code"=>"<long>", "data"=>"<string>", "headers"=>{"ut0_1"=>"<string>", "laborisb"=>"<string>", "ipsum_07"=>"<string>", "cupidatat_1_3"=>"<string>"}}, "amet_99"=>{"action"=>"<string>", "code"=>"<long>", "data"=>"<string>", "headers"=>{"cillum_e4"=>"<string>"}}}, "path"=>"<string>"}]}, "global_headers"=>{"in6"=>"<string>", "magna_2b6"=>"<string>"}, "global_headers_remove"=>["<string>", "<string>"], "global_size_limit"=>"<long>", "name"=>"<string>", "override_target"=>"<string>", "use_extended_paths"=>"<boolean>"}, "irure7"=>{"paths"=>{"black_list"=>["<string>", "<string>"], "ignored"=>["<string>", "<string>"], "white_list"=>["<string>", "<string>"]}, "expires"=>"<string>", "extended_paths"=>{"advance_cache_config"=>[{"cache_response_codes"=>["<long>", "<long>"], "cache_key_regex"=>"<string>", "method"=>"<string>", "path"=>"<string>"}, {"cache_response_codes"=>["<long>", "<long>"], "cache_key_regex"=>"<string>", "method"=>"<string>", "path"=>"<string>"}], "black_list"=>[{"method_actions"=>{"pariatur_f7"=>{"action"=>"<string>", "code"=>"<long>", "data"=>"<string>", "headers"=>{"Duis_eab"=>"<string>"}}, "aliquip_4"=>{"action"=>"<string>", "code"=>"<long>", "data"=>"<string>", "headers"=>{"esse6"=>"<string>", "velit_339"=>"<string>", "elitec"=>"<string>", "ex_4"=>"<string>"}}}, "path"=>"<string>"}, {"method_actions"=>{"fugiat6b6"=>{"action"=>"<string>", "code"=>"<long>", "data"=>"<string>", "headers"=>{"ipsum38d"=>"<string>", "velit_04"=>"<string>", "laboris_31"=>"<string>"}}}, "path"=>"<string>"}], "cache"=>["<string>", "<string>"], "circuit_breakers"=>[{"method"=>"<string>", "path"=>"<string>", "return_to_service_after"=>"<long>", "samples"=>"<long>", "threshold_percent"=>"<double>"}, {"method"=>"<string>", "path"=>"<string>", "return_to_service_after"=>"<long>", "samples"=>"<long>", "threshold_percent"=>"<double>"}], "do_not_track_endpoints"=>[{"method"=>"<string>", "path"=>"<string>"}, {"method"=>"<string>", "path"=>"<string>"}], "hard_timeouts"=>[{"method"=>"<string>", "path"=>"<string>", "timeout"=>"<long>"}, {"method"=>"<string>", "path"=>"<string>", "timeout"=>"<long>"}], "ignored"=>[{"method_actions"=>{"do36"=>{"action"=>"<string>", "code"=>"<long>", "data"=>"<string>", "headers"=>{"amet_39"=>"<string>"}}, "laborum_144"=>{"action"=>"<string>", "code"=>"<long>", "data"=>"<string>", "headers"=>{"voluptatee63"=>"<string>", "sunt832"=>"<string>", "ullamco1"=>"<string>"}}}, "path"=>"<string>"}, {"method_actions"=>{"adipisicing_b2"=>{"action"=>"<string>", "code"=>"<long>", "data"=>"<string>", "headers"=>{"elit_e"=>"<string>"}}}, "path"=>"<string>"}], "internal"=>[{"method"=>"<string>", "path"=>"<string>"}, {"method"=>"<string>", "path"=>"<string>"}], "method_transforms"=>[{"method"=>"<string>", "path"=>"<string>", "to_method"=>"<string>"}, {"method"=>"<string>", "path"=>"<string>", "to_method"=>"<string>"}], "size_limits"=>[{"method"=>"<string>", "path"=>"<string>", "size_limit"=>"<long>"}, {"method"=>"<string>", "path"=>"<string>", "size_limit"=>"<long>"}], "track_endpoints"=>[{"method"=>"<string>", "path"=>"<string>"}, {"method"=>"<string>", "path"=>"<string>"}], "transform"=>[{"method"=>"<string>", "path"=>"<string>", "template_data"=>{"enable_session"=>"<boolean>", "input_type"=>"<string>", "template_mode"=>"<string>", "template_source"=>"<string>"}}, {"method"=>"<string>", "path"=>"<string>", "template_data"=>{"enable_session"=>"<boolean>", "input_type"=>"<string>", "template_mode"=>"<string>", "template_source"=>"<string>"}}], "transform_headers"=>[{"act_on"=>"<boolean>", "add_headers"=>{"aliquabd"=>"<string>", "cillum_0"=>"<string>", "magna_e63"=>"<string>"}, "delete_headers"=>["<string>", "<string>"], "method"=>"<string>", "path"=>"<string>"}, {"act_on"=>"<boolean>", "add_headers"=>{"consequat2"=>"<string>", "dolorf74"=>"<string>", "eiusmoda3"=>"<string>", "dolor4b"=>"<string>"}, "delete_headers"=>["<string>", "<string>"], "method"=>"<string>", "path"=>"<string>"}], "transform_jq"=>[{"filter"=>"<string>", "method"=>"<string>", "path"=>"<string>"}, {"filter"=>"<string>", "method"=>"<string>", "path"=>"<string>"}], "transform_jq_response"=>[{"filter"=>"<string>", "method"=>"<string>", "path"=>"<string>"}, {"filter"=>"<string>", "method"=>"<string>", "path"=>"<string>"}], "transform_response"=>[{"method"=>"<string>", "path"=>"<string>", "template_data"=>{"enable_session"=>"<boolean>", "input_type"=>"<string>", "template_mode"=>"<string>", "template_source"=>"<string>"}}, {"method"=>"<string>", "path"=>"<string>", "template_data"=>{"enable_session"=>"<boolean>", "input_type"=>"<string>", "template_mode"=>"<string>", "template_source"=>"<string>"}}], "transform_response_headers"=>[{"act_on"=>"<boolean>", "add_headers"=>{"Ut_0"=>"<string>", "in_2"=>"<string>", "eiusmod_8"=>"<string>"}, "delete_headers"=>["<string>", "<string>"], "method"=>"<string>", "path"=>"<string>"}, {"act_on"=>"<boolean>", "add_headers"=>{"quis_a"=>"<string>"}, "delete_headers"=>["<string>", "<string>"], "method"=>"<string>", "path"=>"<string>"}], "url_rewrites"=>[{"MatchRegexp"=>{"FromCache"=>"<boolean>"}, "match_pattern"=>"<string>", "method"=>"<string>", "path"=>"<string>", "rewrite_to"=>"<string>", "triggers"=>[{"on"=>"<string>", "options"=>{"header_matches"=>{"culpa_c"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "path_part_matches"=>{"Lorem82f"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "payload_matches"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "query_val_matches"=>{"infe"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "culpa_c"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "request_context_matches"=>{"fugiat_80"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "eiusmod_9"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "session_meta_matches"=>{"cillum_ac"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "proidente"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}}, "rewrite_to"=>"<string>"}, {"on"=>"<string>", "options"=>{"header_matches"=>{"irure_bf0"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "veniam_a"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "path_part_matches"=>{"quis40"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "eiusmod_b_6"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "payload_matches"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "query_val_matches"=>{"esse_d"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "request_context_matches"=>{"tempor_"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "velit_d"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "incididunt3"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "session_meta_matches"=>{"culpa_8"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "dolore_2"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}}, "rewrite_to"=>"<string>"}]}, {"MatchRegexp"=>{"FromCache"=>"<boolean>"}, "match_pattern"=>"<string>", "method"=>"<string>", "path"=>"<string>", "rewrite_to"=>"<string>", "triggers"=>[{"on"=>"<string>", "options"=>{"header_matches"=>{"veniam_44_"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "path_part_matches"=>{"do_e"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "in6c"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "payload_matches"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "query_val_matches"=>{"non_64"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "ullamco_44"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "Ut_3"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "request_context_matches"=>{"qui55d"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "consectetur_4"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "session_meta_matches"=>{"labore_dc"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}}, "rewrite_to"=>"<string>"}, {"on"=>"<string>", "options"=>{"header_matches"=>{"pariatur4"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "path_part_matches"=>{"aliquab1"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "nisi_b"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "payload_matches"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "query_val_matches"=>{"commodo2"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "request_context_matches"=>{"veniam2f_"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "minim1b"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "session_meta_matches"=>{"ipsum_1_2"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "in_3"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}}, "rewrite_to"=>"<string>"}]}], "validate_json"=>[{"error_response_code"=>"<long>", "method"=>"<string>", "path"=>"<string>", "schema_b64"=>"<string>"}, {"error_response_code"=>"<long>", "method"=>"<string>", "path"=>"<string>", "schema_b64"=>"<string>"}], "virtual"=>[{"function_source_type"=>"<string>", "function_source_uri"=>"<string>", "method"=>"<string>", "path"=>"<string>", "proxy_on_error"=>"<boolean>", "response_function_name"=>"<string>", "use_session"=>"<boolean>"}, {"function_source_type"=>"<string>", "function_source_uri"=>"<string>", "method"=>"<string>", "path"=>"<string>", "proxy_on_error"=>"<boolean>", "response_function_name"=>"<string>", "use_session"=>"<boolean>"}], "white_list"=>[{"method_actions"=>{"ad2"=>{"action"=>"<string>", "code"=>"<long>", "data"=>"<string>", "headers"=>{"deserunt2"=>"<string>", "Excepteur_7"=>"<string>", "occaecat2ed"=>"<string>"}}, "labore_4f"=>{"action"=>"<string>", "code"=>"<long>", "data"=>"<string>", "headers"=>{"magna_f0b"=>"<string>"}}}, "path"=>"<string>"}, {"method_actions"=>{"nullad63"=>{"action"=>"<string>", "code"=>"<long>", "data"=>"<string>", "headers"=>{"non9c"=>"<string>"}}, "Lorem7e"=>{"action"=>"<string>", "code"=>"<long>", "data"=>"<string>", "headers"=>{"consequat_50"=>"<string>"}}}, "path"=>"<string>"}]}, "global_headers"=>{"inb"=>"<string>", "enim_ff3"=>"<string>"}, "global_headers_remove"=>["<string>", "<string>"], "global_size_limit"=>"<long>", "name"=>"<string>", "override_target"=>"<string>", "use_extended_paths"=>"<boolean>"}, "Ut_d1"=>{"paths"=>{"black_list"=>["<string>", "<string>"], "ignored"=>["<string>", "<string>"], "white_list"=>["<string>", "<string>"]}, "expires"=>"<string>", "extended_paths"=>{"advance_cache_config"=>[{"cache_response_codes"=>["<long>", "<long>"], "cache_key_regex"=>"<string>", "method"=>"<string>", "path"=>"<string>"}, {"cache_response_codes"=>["<long>", "<long>"], "cache_key_regex"=>"<string>", "method"=>"<string>", "path"=>"<string>"}], "black_list"=>[{"method_actions"=>{"est_4fc"=>{"action"=>"<string>", "code"=>"<long>", "data"=>"<string>", "headers"=>{"aliquac"=>"<string>"}}, "laborume_"=>{"action"=>"<string>", "code"=>"<long>", "data"=>"<string>", "headers"=>{"irure2"=>"<string>", "dolor_3"=>"<string>", "ut_95"=>"<string>"}}}, "path"=>"<string>"}, {"method_actions"=>{"in_e9"=>{"action"=>"<string>", "code"=>"<long>", "data"=>"<string>", "headers"=>{"magna__cb"=>"<string>", "quis9"=>"<string>", "laborum__23"=>"<string>"}}, "dolore_da"=>{"action"=>"<string>", "code"=>"<long>", "data"=>"<string>", "headers"=>{"labore_d2a"=>"<string>", "deserunt_b"=>"<string>", "aliquad6"=>"<string>"}}}, "path"=>"<string>"}], "cache"=>["<string>", "<string>"], "circuit_breakers"=>[{"method"=>"<string>", "path"=>"<string>", "return_to_service_after"=>"<long>", "samples"=>"<long>", "threshold_percent"=>"<double>"}, {"method"=>"<string>", "path"=>"<string>", "return_to_service_after"=>"<long>", "samples"=>"<long>", "threshold_percent"=>"<double>"}], "do_not_track_endpoints"=>[{"method"=>"<string>", "path"=>"<string>"}, {"method"=>"<string>", "path"=>"<string>"}], "hard_timeouts"=>[{"method"=>"<string>", "path"=>"<string>", "timeout"=>"<long>"}, {"method"=>"<string>", "path"=>"<string>", "timeout"=>"<long>"}], "ignored"=>[{"method_actions"=>{"in37"=>{"action"=>"<string>", "code"=>"<long>", "data"=>"<string>", "headers"=>{"sunt_77"=>"<string>"}}, "utd3"=>{"action"=>"<string>", "code"=>"<long>", "data"=>"<string>", "headers"=>{"sit_3"=>"<string>"}}, "consequat_e9"=>{"action"=>"<string>", "code"=>"<long>", "data"=>"<string>", "headers"=>{"est67"=>"<string>", "nullaa"=>"<string>"}}}, "path"=>"<string>"}, {"method_actions"=>{"sunt_f7"=>{"action"=>"<string>", "code"=>"<long>", "data"=>"<string>", "headers"=>{"incididunt48"=>"<string>", "aliqua_b"=>"<string>"}}}, "path"=>"<string>"}], "internal"=>[{"method"=>"<string>", "path"=>"<string>"}, {"method"=>"<string>", "path"=>"<string>"}], "method_transforms"=>[{"method"=>"<string>", "path"=>"<string>", "to_method"=>"<string>"}, {"method"=>"<string>", "path"=>"<string>", "to_method"=>"<string>"}], "size_limits"=>[{"method"=>"<string>", "path"=>"<string>", "size_limit"=>"<long>"}, {"method"=>"<string>", "path"=>"<string>", "size_limit"=>"<long>"}], "track_endpoints"=>[{"method"=>"<string>", "path"=>"<string>"}, {"method"=>"<string>", "path"=>"<string>"}], "transform"=>[{"method"=>"<string>", "path"=>"<string>", "template_data"=>{"enable_session"=>"<boolean>", "input_type"=>"<string>", "template_mode"=>"<string>", "template_source"=>"<string>"}}, {"method"=>"<string>", "path"=>"<string>", "template_data"=>{"enable_session"=>"<boolean>", "input_type"=>"<string>", "template_mode"=>"<string>", "template_source"=>"<string>"}}], "transform_headers"=>[{"act_on"=>"<boolean>", "add_headers"=>{"inf3"=>"<string>", "inf"=>"<string>", "inc"=>"<string>"}, "delete_headers"=>["<string>", "<string>"], "method"=>"<string>", "path"=>"<string>"}, {"act_on"=>"<boolean>", "add_headers"=>{"ut9"=>"<string>", "incididuntc8"=>"<string>"}, "delete_headers"=>["<string>", "<string>"], "method"=>"<string>", "path"=>"<string>"}], "transform_jq"=>[{"filter"=>"<string>", "method"=>"<string>", "path"=>"<string>"}, {"filter"=>"<string>", "method"=>"<string>", "path"=>"<string>"}], "transform_jq_response"=>[{"filter"=>"<string>", "method"=>"<string>", "path"=>"<string>"}, {"filter"=>"<string>", "method"=>"<string>", "path"=>"<string>"}], "transform_response"=>[{"method"=>"<string>", "path"=>"<string>", "template_data"=>{"enable_session"=>"<boolean>", "input_type"=>"<string>", "template_mode"=>"<string>", "template_source"=>"<string>"}}, {"method"=>"<string>", "path"=>"<string>", "template_data"=>{"enable_session"=>"<boolean>", "input_type"=>"<string>", "template_mode"=>"<string>", "template_source"=>"<string>"}}], "transform_response_headers"=>[{"act_on"=>"<boolean>", "add_headers"=>{"et_57"=>"<string>", "esse_8"=>"<string>", "laborisa"=>"<string>", "nisi_a8f"=>"<string>"}, "delete_headers"=>["<string>", "<string>"], "method"=>"<string>", "path"=>"<string>"}, {"act_on"=>"<boolean>", "add_headers"=>{"sint_7f0"=>"<string>", "in_7f"=>"<string>"}, "delete_headers"=>["<string>", "<string>"], "method"=>"<string>", "path"=>"<string>"}], "url_rewrites"=>[{"MatchRegexp"=>{"FromCache"=>"<boolean>"}, "match_pattern"=>"<string>", "method"=>"<string>", "path"=>"<string>", "rewrite_to"=>"<string>", "triggers"=>[{"on"=>"<string>", "options"=>{"header_matches"=>{"inc"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "dolore_13"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "path_part_matches"=>{"adipisicing_7d1"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "adipisicing_a_"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "payload_matches"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "query_val_matches"=>{"velitc"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "sit_1"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "ut_db"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "request_context_matches"=>{"incididunt_0b5"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "exercitation32"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "laboris_7"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "session_meta_matches"=>{"reprehenderit_eb"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}}, "rewrite_to"=>"<string>"}, {"on"=>"<string>", "options"=>{"header_matches"=>{"anim_8d"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "ullamco_be"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "irure14"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "path_part_matches"=>{"consectetur58e"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "site8"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "payload_matches"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "query_val_matches"=>{"consequat_baf"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "culpa_f2"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "in_b9b"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "request_context_matches"=>{"sed_125"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "minim_497"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "session_meta_matches"=>{"ex4c3"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "exercitatione7a"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}}, "rewrite_to"=>"<string>"}]}, {"MatchRegexp"=>{"FromCache"=>"<boolean>"}, "match_pattern"=>"<string>", "method"=>"<string>", "path"=>"<string>", "rewrite_to"=>"<string>", "triggers"=>[{"on"=>"<string>", "options"=>{"header_matches"=>{"auteab"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "path_part_matches"=>{"nonb"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "commodo_76"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "payload_matches"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "query_val_matches"=>{"aute98"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "non_75"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "cupidatat_3d"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "request_context_matches"=>{"ipsum_3e"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "session_meta_matches"=>{"ea7"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "esse01b"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "dolore_08"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "aute1"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}}, "rewrite_to"=>"<string>"}, {"on"=>"<string>", "options"=>{"header_matches"=>{"Duis_"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "sed_0a"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "aliqua1"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "anim_ab"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "path_part_matches"=>{"in_8"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "ullamcob2"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "payload_matches"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "query_val_matches"=>{"elit71"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "sit60"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "request_context_matches"=>{"deserunt_4"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "session_meta_matches"=>{"commodo_64"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}}, "rewrite_to"=>"<string>"}]}], "validate_json"=>[{"error_response_code"=>"<long>", "method"=>"<string>", "path"=>"<string>", "schema_b64"=>"<string>"}, {"error_response_code"=>"<long>", "method"=>"<string>", "path"=>"<string>", "schema_b64"=>"<string>"}], "virtual"=>[{"function_source_type"=>"<string>", "function_source_uri"=>"<string>", "method"=>"<string>", "path"=>"<string>", "proxy_on_error"=>"<boolean>", "response_function_name"=>"<string>", "use_session"=>"<boolean>"}, {"function_source_type"=>"<string>", "function_source_uri"=>"<string>", "method"=>"<string>", "path"=>"<string>", "proxy_on_error"=>"<boolean>", "response_function_name"=>"<string>", "use_session"=>"<boolean>"}], "white_list"=>[{"method_actions"=>{"officia7c"=>{"action"=>"<string>", "code"=>"<long>", "data"=>"<string>", "headers"=>{"sint_871"=>"<string>", "eiusmod_"=>"<string>"}}}, "path"=>"<string>"}, {"method_actions"=>{"nostrud_f5"=>{"action"=>"<string>", "code"=>"<long>", "data"=>"<string>", "headers"=>{"animf"=>"<string>", "dolore__77"=>"<string>", "tempor59f"=>"<string>", "veniam_44a"=>"<string>"}}, "reprehenderit_ea"=>{"action"=>"<string>", "code"=>"<long>", "data"=>"<string>", "headers"=>{"irure__8c"=>"<string>", "anim_f77"=>"<string>"}}}, "path"=>"<string>"}]}, "global_headers"=>{"Lorem7c"=>"<string>"}, "global_headers_remove"=>["<string>", "<string>"], "global_size_limit"=>"<long>", "name"=>"<string>", "override_target"=>"<string>", "use_extended_paths"=>"<boolean>"}}}}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
Acceptstring

RESPONSES

status: OK

{&quot;action&quot;:&quot;\u003cstring\u003e&quot;,&quot;key&quot;:&quot;\u003cstring\u003e&quot;,&quot;key_hash&quot;:&quot;\u003cstring\u003e&quot;,&quot;status&quot;:&quot;\u003cstring\u003e&quot;}