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"=>{"inc4"=>"<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"=>{"velit__1"=>"<string>", "ullamco60"=>"<string>"}, "issuer"=>"<string>"}, {"client_ids"=>{"exercitation7"=>"<string>", "irure__"=>"<string>"}, "issuer"=>"<string>"}], "segregate_by_client"=>"<boolean>"}, "org_id"=>"<string>", "pinned_public_keys"=>{"veniam_1"=>"<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"=>{"sed9"=>"<string>", "in5"=>"<string>"}, "uptime_tests"=>{"check_list"=>[{"body"=>"<string>", "headers"=>{"cillum_0"=>"<string>"}, "method"=>"<string>", "url"=>"<string>"}, {"body"=>"<string>", "headers"=>{"consequat_5"=>"<string>", "Excepteur0"=>"<string>", "dolor019"=>"<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"=>{"fugiat_0"=>{"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"=>{"dolorefc1"=>{"action"=>"<string>", "code"=>"<long>", "data"=>"<string>", "headers"=>{"cillume56"=>"<string>", "sunt_4"=>"<string>"}}}, "path"=>"<string>"}, {"method_actions"=>{"dolor_28d"=>{"action"=>"<string>", "code"=>"<long>", "data"=>"<string>", "headers"=>{"aliquip71b"=>"<string>", "nisi919"=>"<string>", "cupidatat_16"=>"<string>"}}, "occaecateb6"=>{"action"=>"<string>", "code"=>"<long>", "data"=>"<string>", "headers"=>{"dolore637"=>"<string>"}}, "sed_8"=>{"action"=>"<string>", "code"=>"<long>", "data"=>"<string>", "headers"=>{"elit_ed"=>"<string>", "esse_be1"=>"<string>"}}, "ide"=>{"action"=>"<string>", "code"=>"<long>", "data"=>"<string>", "headers"=>{"mollit_c"=>"<string>", "laborum_683"=>"<string>", "proident_d"=>"<string>"}}, "pariatur__"=>{"action"=>"<string>", "code"=>"<long>", "data"=>"<string>", "headers"=>{"pariatur_6e"=>"<string>", "Excepteure5"=>"<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"=>{"laborum4"=>{"action"=>"<string>", "code"=>"<long>", "data"=>"<string>", "headers"=>{"commodo_25"=>"<string>", "in_69"=>"<string>", "sunt_77"=>"<string>"}}, "nisia"=>{"action"=>"<string>", "code"=>"<long>", "data"=>"<string>", "headers"=>{"incididunte1"=>"<string>"}}, "ad_cdb"=>{"action"=>"<string>", "code"=>"<long>", "data"=>"<string>", "headers"=>{"aute5"=>"<string>", "nulla_f"=>"<string>"}}, "aliquip_b7"=>{"action"=>"<string>", "code"=>"<long>", "data"=>"<string>", "headers"=>{"amet690"=>"<string>"}}}, "path"=>"<string>"}, {"method_actions"=>{"culpa8"=>{"action"=>"<string>", "code"=>"<long>", "data"=>"<string>", "headers"=>{"Lorem_e07"=>"<string>", "magna_909"=>"<string>", "irure_891"=>"<string>", "sunt5"=>"<string>"}}, "amet_ea7"=>{"action"=>"<string>", "code"=>"<long>", "data"=>"<string>", "headers"=>{"adipisicing_6ac"=>"<string>"}}, "qui7d5"=>{"action"=>"<string>", "code"=>"<long>", "data"=>"<string>", "headers"=>{"incididunt801"=>"<string>"}}, "anim_0e"=>{"action"=>"<string>", "code"=>"<long>", "data"=>"<string>", "headers"=>{"dolore258"=>"<string>", "Excepteur9f0"=>"<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"=>{"in9"=>"<string>", "eu_54"=>"<string>"}, "delete_headers"=>["<string>", "<string>"], "method"=>"<string>", "path"=>"<string>"}, {"act_on"=>"<boolean>", "add_headers"=>{"deserunt_a1"=>"<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"=>{"in_7_"=>"<string>"}, "delete_headers"=>["<string>", "<string>"], "method"=>"<string>", "path"=>"<string>"}, {"act_on"=>"<boolean>", "add_headers"=>{"eu57"=>"<string>", "dolore_8"=>"<string>", "magna_a"=>"<string>", "officia_5_c"=>"<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"=>{"ipsum_e"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "path_part_matches"=>{"quib_"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "consectetur__73"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "payload_matches"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "query_val_matches"=>{"eu_d"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "Ut_3"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "request_context_matches"=>{"eaf7"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "exercitation6_"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "session_meta_matches"=>{"Excepteur6"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "Duisaa6"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}}, "rewrite_to"=>"<string>"}, {"on"=>"<string>", "options"=>{"header_matches"=>{"anim0"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "laborum19"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "path_part_matches"=>{"cupidatat66e"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "occaecat6"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "payload_matches"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "query_val_matches"=>{"cillumee8"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "sed_2"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "request_context_matches"=>{"non76b"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "session_meta_matches"=>{"occaecat_56"=>{"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"=>{"fugiat3"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "path_part_matches"=>{"irure9f7"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "eiusmod_680"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "payload_matches"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "query_val_matches"=>{"in_3"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "request_context_matches"=>{"ullamcoab0"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "quis_1b"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "session_meta_matches"=>{"in_43a"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "sed_744"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "elit7c4"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "sint_e"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}}, "rewrite_to"=>"<string>"}, {"on"=>"<string>", "options"=>{"header_matches"=>{"amet14"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "path_part_matches"=>{"in8c"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "payload_matches"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "query_val_matches"=>{"irureaf"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "dolor_5d5"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "quis_577"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "request_context_matches"=>{"cupidatat_0"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "non_b09"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "session_meta_matches"=>{"in_09e"=>{"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"=>{"exe0b"=>{"action"=>"<string>", "code"=>"<long>", "data"=>"<string>", "headers"=>{"nisib_"=>"<string>"}}, "aliquip3"=>{"action"=>"<string>", "code"=>"<long>", "data"=>"<string>", "headers"=>{"Ut_b"=>"<string>", "amet_1f5"=>"<string>", "amet__"=>"<string>"}}}, "path"=>"<string>"}, {"method_actions"=>{"in_946"=>{"action"=>"<string>", "code"=>"<long>", "data"=>"<string>", "headers"=>{"Ut_5d"=>"<string>", "velitcc1"=>"<string>"}}}, "path"=>"<string>"}]}, "global_headers"=>{"proident_69d"=>"<string>", "ada"=>"<string>", "sunt_af"=>"<string>"}, "global_headers_remove"=>["<string>", "<string>"], "global_size_limit"=>"<long>", "name"=>"<string>", "override_target"=>"<string>", "use_extended_paths"=>"<boolean>"}, "in___"=>{"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"=>{"proident751"=>{"action"=>"<string>", "code"=>"<long>", "data"=>"<string>", "headers"=>{"esse_6"=>"<string>"}}, "dolore_1d4"=>{"action"=>"<string>", "code"=>"<long>", "data"=>"<string>", "headers"=>{"est0"=>"<string>"}}}, "path"=>"<string>"}, {"method_actions"=>{"ea4c"=>{"action"=>"<string>", "code"=>"<long>", "data"=>"<string>", "headers"=>{"tempor6a7"=>"<string>"}}, "Lorem7ec"=>{"action"=>"<string>", "code"=>"<long>", "data"=>"<string>", "headers"=>{"sint_36"=>"<string>", "mollit80"=>"<string>"}}, "sint3"=>{"action"=>"<string>", "code"=>"<long>", "data"=>"<string>", "headers"=>{"est_97"=>"<string>"}}, "adipisicing_9d"=>{"action"=>"<string>", "code"=>"<long>", "data"=>"<string>", "headers"=>{"ea7"=>"<string>", "reprehenderitcc"=>"<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"=>{"velit_4"=>{"action"=>"<string>", "code"=>"<long>", "data"=>"<string>", "headers"=>{"voluptate02"=>"<string>", "Ute"=>"<string>", "sit2"=>"<string>"}}, "ut9"=>{"action"=>"<string>", "code"=>"<long>", "data"=>"<string>", "headers"=>{"ut1"=>"<string>", "incididunt_3_3"=>"<string>", "dolore1c"=>"<string>"}}}, "path"=>"<string>"}, {"method_actions"=>{"ex_c"=>{"action"=>"<string>", "code"=>"<long>", "data"=>"<string>", "headers"=>{"eiusmod91b"=>"<string>", "minim93"=>"<string>", "Excepteur3f"=>"<string>"}}, "enim_d"=>{"action"=>"<string>", "code"=>"<long>", "data"=>"<string>", "headers"=>{"nisi_6"=>"<string>", "dolor0"=>"<string>", "auted"=>"<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"=>{"officia4d7"=>"<string>", "voluptate_99"=>"<string>"}, "delete_headers"=>["<string>", "<string>"], "method"=>"<string>", "path"=>"<string>"}, {"act_on"=>"<boolean>", "add_headers"=>{"cupidatat_6"=>"<string>", "aliqua9a"=>"<string>", "add"=>"<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"=>{"cillum_849"=>"<string>"}, "delete_headers"=>["<string>", "<string>"], "method"=>"<string>", "path"=>"<string>"}, {"act_on"=>"<boolean>", "add_headers"=>{"consecteturc"=>"<string>", "sed94"=>"<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"=>{"ipsum_8"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "id___a"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "path_part_matches"=>{"fugiatc1"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "payload_matches"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "query_val_matches"=>{"proident0"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "request_context_matches"=>{"pariatur_9a"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "Duis_7"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "eub"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "reprehenderit_9_"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "session_meta_matches"=>{"commodoab7"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "reprehenderite"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}}, "rewrite_to"=>"<string>"}, {"on"=>"<string>", "options"=>{"header_matches"=>{"auteff0"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "fugiat__c3"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "path_part_matches"=>{"sit_f_3"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "officia8"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "payload_matches"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "query_val_matches"=>{"enim94"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "tempor_7"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "request_context_matches"=>{"ad854"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "session_meta_matches"=>{"amet_26"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "Excepteur3c1"=>{"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"=>{"voluptate_b69"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "path_part_matches"=>{"in0"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "payload_matches"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "query_val_matches"=>{"eue_0"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "proident_d"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "proident_d01"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "sit_029"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "culpa5"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "request_context_matches"=>{"officia_5b"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "labore_af"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "session_meta_matches"=>{"ipsumd2c"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "est_7_0"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "ute6"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "officia_8"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}}, "rewrite_to"=>"<string>"}, {"on"=>"<string>", "options"=>{"header_matches"=>{"est_a2b"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "path_part_matches"=>{"aliqua27"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "in1d"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "payload_matches"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "query_val_matches"=>{"exercitation56_"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "esse_5c4"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "dolor_e_"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "request_context_matches"=>{"qui_7b7"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "et_8cf"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}}, "session_meta_matches"=>{"Ut2a"=>{"match_rx"=>"<string>", "reverse"=>"<boolean>"}, "fugiat_53"=>{"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"=>{"mollit_feb"=>{"action"=>"<string>", "code"=>"<long>", "data"=>"<string>", "headers"=>{"laborisa"=>"<string>", "euce5"=>"<string>", "ullamco5"=>"<string>", "incididunt_892"=>"<string>"}}, "officiad"=>{"action"=>"<string>", "code"=>"<long>", "data"=>"<string>", "headers"=>{"Lorem_70b"=>"<string>", "ea31c"=>"<string>", "consectetur_398"=>"<string>"}}}, "path"=>"<string>"}, {"method_actions"=>{"est_c49"=>{"action"=>"<string>", "code"=>"<long>", "data"=>"<string>", "headers"=>{"sint_c4"=>"<string>"}}, "dolore_4"=>{"action"=>"<string>", "code"=>"<long>", "data"=>"<string>", "headers"=>{"magna_12"=>"<string>", "occaecat77"=>"<string>", "pariatur_"=>"<string>"}}}, "path"=>"<string>"}]}, "global_headers"=>{"fugiatb"=>"<string>", "eiusmod_f_"=>"<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;}