From 4a884221cb836f870dfe3bd1741393374e536e82 Mon Sep 17 00:00:00 2001 From: Mason Johnson Date: Tue, 21 Jan 2025 11:35:13 -0700 Subject: [PATCH] remove extraneous examples folder --- .../examples/_abuse_reports_create_request.md | 13 ---- .../_abuse_reports_create_response.md | 20 ----- .../examples/_abuse_reports_get_request.md | 11 --- .../examples/_abuse_reports_get_response.md | 20 ----- .../_agent_ingresses_create_request.md | 13 ---- .../_agent_ingresses_create_response.md | 22 ------ .../_agent_ingresses_delete_request.md | 11 --- .../_agent_ingresses_delete_response.md | 0 .../examples/_agent_ingresses_get_request.md | 11 --- .../examples/_agent_ingresses_get_response.md | 23 ------ .../examples/_agent_ingresses_list_request.md | 11 --- .../_agent_ingresses_list_response.md | 28 ------- .../_agent_ingresses_update_request.md | 13 ---- .../_agent_ingresses_update_response.md | 23 ------ docs/api/examples/_api_keys_create_request.md | 13 ---- .../api/examples/_api_keys_create_response.md | 15 ---- docs/api/examples/_api_keys_delete_request.md | 11 --- .../api/examples/_api_keys_delete_response.md | 0 docs/api/examples/_api_keys_get_request.md | 11 --- docs/api/examples/_api_keys_get_response.md | 15 ---- docs/api/examples/_api_keys_list_request.md | 11 --- docs/api/examples/_api_keys_list_response.md | 29 -------- docs/api/examples/_api_keys_update_request.md | 13 ---- .../api/examples/_api_keys_update_response.md | 15 ---- .../api/examples/_bot_users_create_request.md | 13 ---- .../examples/_bot_users_create_response.md | 13 ---- .../api/examples/_bot_users_delete_request.md | 11 --- .../examples/_bot_users_delete_response.md | 0 docs/api/examples/_bot_users_get_request.md | 11 --- docs/api/examples/_bot_users_get_response.md | 13 ---- docs/api/examples/_bot_users_list_request.md | 11 --- docs/api/examples/_bot_users_list_response.md | 19 ----- .../api/examples/_bot_users_update_request.md | 13 ---- .../examples/_bot_users_update_response.md | 13 ---- ..._certificate_authorities_create_request.md | 13 ---- ...certificate_authorities_create_response.md | 19 ----- ..._certificate_authorities_delete_request.md | 11 --- ...certificate_authorities_delete_response.md | 0 .../_certificate_authorities_get_request.md | 11 --- .../_certificate_authorities_get_response.md | 19 ----- .../_certificate_authorities_list_request.md | 11 --- .../_certificate_authorities_list_response.md | 48 ------------ ..._certificate_authorities_update_request.md | 13 ---- ...certificate_authorities_update_response.md | 19 ----- .../examples/_credentials_create_request.md | 13 ---- .../examples/_credentials_create_response.md | 15 ---- .../examples/_credentials_delete_request.md | 11 --- .../examples/_credentials_delete_response.md | 0 docs/api/examples/_credentials_get_request.md | 11 --- .../api/examples/_credentials_get_response.md | 16 ---- .../api/examples/_credentials_list_request.md | 11 --- .../examples/_credentials_list_response.md | 39 ---------- .../examples/_credentials_update_request.md | 13 ---- .../examples/_credentials_update_response.md | 16 ---- ...dge_route_backend_module_delete_request.md | 11 --- ...ge_route_backend_module_delete_response.md | 0 .../_edge_route_backend_module_get_request.md | 11 --- ..._edge_route_backend_module_get_response.md | 13 ---- ...ge_route_backend_module_replace_request.md | 13 ---- ...e_route_backend_module_replace_response.md | 13 ---- ...e_circuit_breaker_module_delete_request.md | 11 --- ..._circuit_breaker_module_delete_response.md | 0 ...oute_circuit_breaker_module_get_request.md | 11 --- ...ute_circuit_breaker_module_get_response.md | 14 ---- ..._circuit_breaker_module_replace_request.md | 13 ---- ...circuit_breaker_module_replace_response.md | 14 ---- ...route_compression_module_delete_request.md | 11 --- ...oute_compression_module_delete_response.md | 0 ...ge_route_compression_module_get_request.md | 11 --- ...e_route_compression_module_get_response.md | 9 --- ...oute_compression_module_replace_request.md | 13 ---- ...ute_compression_module_replace_response.md | 9 --- ...te_ip_restriction_module_delete_request.md | 11 --- ...e_ip_restriction_module_delete_response.md | 0 ...route_ip_restriction_module_get_request.md | 11 --- ...oute_ip_restriction_module_get_response.md | 19 ----- ...e_ip_restriction_module_replace_request.md | 13 ---- ..._ip_restriction_module_replace_response.md | 19 ----- ...edge_route_o_auth_module_delete_request.md | 11 --- ...dge_route_o_auth_module_delete_response.md | 0 .../_edge_route_o_auth_module_get_request.md | 11 --- .../_edge_route_o_auth_module_get_response.md | 34 --------- ...dge_route_o_auth_module_replace_request.md | 13 ---- ...ge_route_o_auth_module_replace_response.md | 34 --------- .../_edge_route_oidc_module_delete_request.md | 11 --- ..._edge_route_oidc_module_delete_response.md | 0 .../_edge_route_oidc_module_get_request.md | 11 --- .../_edge_route_oidc_module_get_response.md | 17 ----- ..._edge_route_oidc_module_replace_request.md | 13 ---- ...edge_route_oidc_module_replace_response.md | 17 ----- ...e_request_headers_module_delete_request.md | 11 --- ..._request_headers_module_delete_response.md | 0 ...oute_request_headers_module_get_request.md | 11 --- ...ute_request_headers_module_get_response.md | 13 ---- ..._request_headers_module_replace_request.md | 13 ---- ...request_headers_module_replace_response.md | 13 ---- ..._response_headers_module_delete_request.md | 11 --- ...response_headers_module_delete_response.md | 0 ...ute_response_headers_module_get_request.md | 11 --- ...te_response_headers_module_get_response.md | 14 ---- ...response_headers_module_replace_request.md | 13 ---- ...esponse_headers_module_replace_response.md | 14 ---- .../_edge_route_saml_module_delete_request.md | 11 --- ..._edge_route_saml_module_delete_response.md | 0 .../_edge_route_saml_module_get_request.md | 11 --- .../_edge_route_saml_module_get_response.md | 24 ------ ..._edge_route_saml_module_replace_request.md | 13 ---- ...edge_route_saml_module_replace_response.md | 24 ------ ...te_traffic_policy_module_delete_request.md | 11 --- ...e_traffic_policy_module_delete_response.md | 0 ...route_traffic_policy_module_get_request.md | 11 --- ...oute_traffic_policy_module_get_response.md | 10 --- ...e_traffic_policy_module_replace_request.md | 13 ---- ..._traffic_policy_module_replace_response.md | 10 --- ...user_agent_filter_module_delete_request.md | 11 --- ...ser_agent_filter_module_delete_response.md | 0 ...te_user_agent_filter_module_get_request.md | 11 --- ...e_user_agent_filter_module_get_response.md | 11 --- ...ser_agent_filter_module_replace_request.md | 13 ---- ...er_agent_filter_module_replace_response.md | 11 --- ...hook_verification_module_delete_request.md | 11 --- ...ook_verification_module_delete_response.md | 0 ...webhook_verification_module_get_request.md | 11 --- ...ebhook_verification_module_get_response.md | 11 --- ...ook_verification_module_replace_request.md | 13 ---- ...ok_verification_module_replace_response.md | 11 --- ...ket_tcp_converter_module_delete_request.md | 11 --- ...et_tcp_converter_module_delete_response.md | 0 ...socket_tcp_converter_module_get_request.md | 11 --- ...ocket_tcp_converter_module_get_response.md | 9 --- ...et_tcp_converter_module_replace_request.md | 13 ---- ...t_tcp_converter_module_replace_response.md | 9 --- .../examples/_edges_https_create_request.md | 13 ---- .../examples/_edges_https_create_response.md | 17 ----- .../examples/_edges_https_delete_request.md | 11 --- .../examples/_edges_https_delete_response.md | 0 docs/api/examples/_edges_https_get_request.md | 11 --- .../api/examples/_edges_https_get_response.md | 17 ----- .../api/examples/_edges_https_list_request.md | 11 --- .../examples/_edges_https_list_response.md | 23 ------ .../_edges_https_routes_create_request.md | 13 ---- .../_edges_https_routes_create_response.md | 30 -------- .../_edges_https_routes_delete_request.md | 11 --- .../_edges_https_routes_delete_response.md | 0 .../_edges_https_routes_get_request.md | 11 --- .../_edges_https_routes_get_response.md | 30 -------- .../_edges_https_routes_update_request.md | 13 ---- .../_edges_https_routes_update_response.md | 30 -------- .../examples/_edges_https_update_request.md | 13 ---- .../examples/_edges_https_update_response.md | 17 ----- .../api/examples/_edges_tcp_create_request.md | 13 ---- .../examples/_edges_tcp_create_response.md | 18 ----- .../api/examples/_edges_tcp_delete_request.md | 11 --- .../examples/_edges_tcp_delete_response.md | 0 docs/api/examples/_edges_tcp_get_request.md | 11 --- docs/api/examples/_edges_tcp_get_response.md | 18 ----- docs/api/examples/_edges_tcp_list_request.md | 11 --- docs/api/examples/_edges_tcp_list_response.md | 24 ------ .../api/examples/_edges_tcp_update_request.md | 13 ---- .../examples/_edges_tcp_update_response.md | 18 ----- .../api/examples/_edges_tls_create_request.md | 13 ---- .../examples/_edges_tls_create_response.md | 20 ----- .../api/examples/_edges_tls_delete_request.md | 11 --- .../examples/_edges_tls_delete_response.md | 0 docs/api/examples/_edges_tls_get_request.md | 11 --- docs/api/examples/_edges_tls_get_response.md | 20 ----- docs/api/examples/_edges_tls_list_request.md | 11 --- docs/api/examples/_edges_tls_list_response.md | 45 ----------- .../api/examples/_edges_tls_update_request.md | 13 ---- .../examples/_edges_tls_update_response.md | 20 ----- ...dpoint_basic_auth_module_delete_request.md | 11 --- ...point_basic_auth_module_delete_response.md | 0 ..._endpoint_basic_auth_module_get_request.md | 11 --- ...endpoint_basic_auth_module_get_response.md | 12 --- ...point_basic_auth_module_replace_request.md | 13 ---- ...oint_basic_auth_module_replace_response.md | 12 --- ...t_circuit_breaker_module_delete_request.md | 11 --- ..._circuit_breaker_module_delete_response.md | 0 ...oint_circuit_breaker_module_get_request.md | 11 --- ...int_circuit_breaker_module_get_response.md | 14 ---- ..._circuit_breaker_module_replace_request.md | 13 ---- ...circuit_breaker_module_replace_response.md | 14 ---- ...point_compression_module_delete_request.md | 11 --- ...oint_compression_module_delete_response.md | 0 ...endpoint_compression_module_get_request.md | 11 --- ...ndpoint_compression_module_get_response.md | 9 --- ...oint_compression_module_replace_request.md | 13 ---- ...int_compression_module_replace_response.md | 9 --- ..._endpoint_configurations_create_request.md | 13 ---- ...endpoint_configurations_create_response.md | 32 -------- ..._endpoint_configurations_delete_request.md | 11 --- ...endpoint_configurations_delete_response.md | 0 .../_endpoint_configurations_get_request.md | 11 --- .../_endpoint_configurations_get_response.md | 40 ---------- .../_endpoint_configurations_list_request.md | 11 --- .../_endpoint_configurations_list_response.md | 74 ------------------- ..._endpoint_configurations_update_request.md | 13 ---- ...endpoint_configurations_update_response.md | 40 ---------- ...ndpoint_ip_policy_module_delete_request.md | 11 --- ...dpoint_ip_policy_module_delete_response.md | 0 .../_endpoint_ip_policy_module_get_request.md | 11 --- ..._endpoint_ip_policy_module_get_response.md | 15 ---- ...dpoint_ip_policy_module_replace_request.md | 13 ---- ...point_ip_policy_module_replace_response.md | 15 ---- ...dpoint_mutual_tls_module_delete_request.md | 11 --- ...point_mutual_tls_module_delete_response.md | 0 ..._endpoint_mutual_tls_module_get_request.md | 11 --- ...endpoint_mutual_tls_module_get_response.md | 15 ---- ...point_mutual_tls_module_replace_request.md | 13 ---- ...oint_mutual_tls_module_replace_response.md | 15 ---- .../_endpoint_o_auth_module_delete_request.md | 11 --- ..._endpoint_o_auth_module_delete_response.md | 0 .../_endpoint_o_auth_module_get_request.md | 11 --- .../_endpoint_o_auth_module_get_response.md | 34 --------- ..._endpoint_o_auth_module_replace_request.md | 13 ---- ...endpoint_o_auth_module_replace_response.md | 34 --------- .../_endpoint_oidc_module_delete_request.md | 11 --- .../_endpoint_oidc_module_delete_response.md | 0 .../_endpoint_oidc_module_get_request.md | 11 --- .../_endpoint_oidc_module_get_response.md | 17 ----- .../_endpoint_oidc_module_replace_request.md | 13 ---- .../_endpoint_oidc_module_replace_response.md | 17 ----- ...t_request_headers_module_delete_request.md | 11 --- ..._request_headers_module_delete_response.md | 0 ...oint_request_headers_module_get_request.md | 11 --- ...int_request_headers_module_get_response.md | 14 ---- ..._request_headers_module_replace_request.md | 13 ---- ...request_headers_module_replace_response.md | 14 ---- ..._response_headers_module_delete_request.md | 11 --- ...response_headers_module_delete_response.md | 0 ...int_response_headers_module_get_request.md | 11 --- ...nt_response_headers_module_get_response.md | 14 ---- ...response_headers_module_replace_request.md | 13 ---- ...esponse_headers_module_replace_response.md | 14 ---- .../_endpoint_saml_module_delete_request.md | 11 --- .../_endpoint_saml_module_delete_response.md | 0 .../_endpoint_saml_module_get_request.md | 11 --- .../_endpoint_saml_module_get_response.md | 24 ------ .../_endpoint_saml_module_replace_request.md | 13 ---- .../_endpoint_saml_module_replace_response.md | 24 ------ ...t_tls_termination_module_delete_request.md | 11 --- ..._tls_termination_module_delete_response.md | 0 ...oint_tls_termination_module_get_request.md | 11 --- ...int_tls_termination_module_get_response.md | 11 --- ..._tls_termination_module_replace_request.md | 13 ---- ...tls_termination_module_replace_response.md | 11 --- ...ebhook_validation_module_delete_request.md | 11 --- ...bhook_validation_module_delete_response.md | 0 ...t_webhook_validation_module_get_request.md | 11 --- ..._webhook_validation_module_get_response.md | 11 --- ...bhook_validation_module_replace_request.md | 13 ---- ...hook_validation_module_replace_response.md | 11 --- .../api/examples/_endpoints_create_request.md | 13 ---- .../examples/_endpoints_create_response.md | 25 ------- .../api/examples/_endpoints_delete_request.md | 11 --- .../examples/_endpoints_delete_response.md | 0 docs/api/examples/_endpoints_get_request.md | 11 --- docs/api/examples/_endpoints_get_response.md | 27 ------- docs/api/examples/_endpoints_list_request.md | 11 --- docs/api/examples/_endpoints_list_response.md | 55 -------------- .../api/examples/_endpoints_update_request.md | 13 ---- .../examples/_endpoints_update_response.md | 25 ------- .../_event_destinations_create_request.md | 13 ---- .../_event_destinations_create_response.md | 29 -------- .../_event_destinations_delete_request.md | 11 --- .../_event_destinations_delete_response.md | 0 .../_event_destinations_get_request.md | 11 --- .../_event_destinations_get_response.md | 29 -------- .../_event_destinations_list_request.md | 11 --- .../_event_destinations_list_response.md | 35 --------- .../_event_destinations_update_request.md | 13 ---- .../_event_destinations_update_response.md | 29 -------- .../examples/_event_sources_create_request.md | 13 ---- .../_event_sources_create_response.md | 10 --- .../examples/_event_sources_delete_request.md | 11 --- .../_event_sources_delete_response.md | 0 .../examples/_event_sources_get_request.md | 11 --- .../examples/_event_sources_get_response.md | 10 --- .../examples/_event_sources_list_request.md | 11 --- .../examples/_event_sources_list_response.md | 19 ----- .../examples/_event_sources_update_request.md | 13 ---- .../_event_sources_update_response.md | 10 --- .../_event_subscriptions_create_request.md | 13 ---- .../_event_subscriptions_create_response.md | 25 ------- .../_event_subscriptions_delete_request.md | 11 --- .../_event_subscriptions_delete_response.md | 0 .../_event_subscriptions_get_request.md | 11 --- .../_event_subscriptions_get_response.md | 25 ------- .../_event_subscriptions_list_request.md | 11 --- .../_event_subscriptions_list_response.md | 31 -------- .../_event_subscriptions_update_request.md | 13 ---- .../_event_subscriptions_update_response.md | 25 ------- .../_failover_backends_create_request.md | 13 ---- .../_failover_backends_create_response.md | 14 ---- .../_failover_backends_delete_request.md | 11 --- .../_failover_backends_delete_response.md | 0 .../_failover_backends_get_request.md | 11 --- .../_failover_backends_get_response.md | 14 ---- .../_failover_backends_list_request.md | 11 --- .../_failover_backends_list_response.md | 20 ----- .../_failover_backends_update_request.md | 13 ---- .../_failover_backends_update_response.md | 14 ---- .../_http_response_backends_create_request.md | 13 ---- ..._http_response_backends_create_response.md | 18 ----- .../_http_response_backends_delete_request.md | 11 --- ..._http_response_backends_delete_response.md | 0 .../_http_response_backends_get_request.md | 11 --- .../_http_response_backends_get_response.md | 18 ----- .../_http_response_backends_list_request.md | 11 --- .../_http_response_backends_list_response.md | 40 ---------- .../_http_response_backends_update_request.md | 13 ---- ..._http_response_backends_update_response.md | 18 ----- ...s_edge_mutual_tls_module_delete_request.md | 11 --- ..._edge_mutual_tls_module_delete_response.md | 0 ...ttps_edge_mutual_tls_module_get_request.md | 11 --- ...tps_edge_mutual_tls_module_get_response.md | 15 ---- ..._edge_mutual_tls_module_replace_request.md | 13 ---- ...edge_mutual_tls_module_replace_response.md | 15 ---- ...e_tls_termination_module_delete_request.md | 11 --- ..._tls_termination_module_delete_response.md | 0 ...edge_tls_termination_module_get_request.md | 11 --- ...dge_tls_termination_module_get_response.md | 11 --- ..._tls_termination_module_replace_request.md | 13 ---- ...tls_termination_module_replace_response.md | 11 --- .../examples/_ip_policies_create_request.md | 13 ---- .../examples/_ip_policies_create_response.md | 12 --- .../examples/_ip_policies_delete_request.md | 11 --- .../examples/_ip_policies_delete_response.md | 0 docs/api/examples/_ip_policies_get_request.md | 11 --- .../api/examples/_ip_policies_get_response.md | 13 ---- .../api/examples/_ip_policies_list_request.md | 11 --- .../examples/_ip_policies_list_response.md | 24 ------ .../examples/_ip_policies_update_request.md | 13 ---- .../examples/_ip_policies_update_response.md | 13 ---- .../_ip_policy_rules_create_request.md | 13 ---- .../_ip_policy_rules_create_response.md | 18 ----- .../_ip_policy_rules_delete_request.md | 11 --- .../_ip_policy_rules_delete_response.md | 0 .../examples/_ip_policy_rules_get_request.md | 11 --- .../examples/_ip_policy_rules_get_response.md | 18 ----- .../examples/_ip_policy_rules_list_request.md | 11 --- .../_ip_policy_rules_list_response.md | 48 ------------ .../_ip_policy_rules_update_request.md | 13 ---- .../_ip_policy_rules_update_response.md | 18 ----- .../_ip_restrictions_create_request.md | 13 ---- .../_ip_restrictions_create_response.md | 19 ----- .../_ip_restrictions_delete_request.md | 11 --- .../_ip_restrictions_delete_response.md | 0 .../examples/_ip_restrictions_get_request.md | 11 --- .../examples/_ip_restrictions_get_response.md | 23 ------ .../examples/_ip_restrictions_list_request.md | 11 --- .../_ip_restrictions_list_response.md | 25 ------- .../_ip_restrictions_update_request.md | 13 ---- .../_ip_restrictions_update_response.md | 23 ------ .../_reserved_addrs_create_request.md | 13 ---- .../_reserved_addrs_create_response.md | 15 ---- ...ed_addrs_delete_endpoint_config_request.md | 11 --- ...d_addrs_delete_endpoint_config_response.md | 0 .../_reserved_addrs_delete_request.md | 11 --- .../_reserved_addrs_delete_response.md | 0 .../examples/_reserved_addrs_get_request.md | 11 --- .../examples/_reserved_addrs_get_response.md | 19 ----- .../examples/_reserved_addrs_list_request.md | 11 --- .../examples/_reserved_addrs_list_response.md | 21 ------ .../_reserved_addrs_update_request.md | 13 ---- .../_reserved_addrs_update_response.md | 19 ----- .../_reserved_domains_create_request.md | 13 ---- .../_reserved_domains_create_response.md | 24 ------ ...e_certificate_management_policy_request.md | 11 --- ..._certificate_management_policy_response.md | 0 ...rved_domains_delete_certificate_request.md | 11 --- ...ved_domains_delete_certificate_response.md | 0 ...ins_delete_http_endpoint_config_request.md | 11 --- ...ns_delete_http_endpoint_config_response.md | 0 ...ns_delete_https_endpoint_config_request.md | 11 --- ...s_delete_https_endpoint_config_response.md | 0 .../_reserved_domains_delete_request.md | 11 --- .../_reserved_domains_delete_response.md | 0 .../examples/_reserved_domains_get_request.md | 11 --- .../_reserved_domains_get_response.md | 32 -------- .../_reserved_domains_list_request.md | 11 --- .../_reserved_domains_list_response.md | 58 --------------- .../_reserved_domains_update_request.md | 13 ---- .../_reserved_domains_update_response.md | 32 -------- docs/api/examples/_self_request.md | 11 --- docs/api/examples/_self_response.md | 28 ------- ..._certificate_authorities_create_request.md | 13 ---- ...certificate_authorities_create_response.md | 14 ---- ..._certificate_authorities_delete_request.md | 11 --- ...certificate_authorities_delete_response.md | 0 ...ssh_certificate_authorities_get_request.md | 11 --- ...sh_certificate_authorities_get_response.md | 15 ---- ...sh_certificate_authorities_list_request.md | 11 --- ...h_certificate_authorities_list_response.md | 20 ----- ..._certificate_authorities_update_request.md | 13 ---- ...certificate_authorities_update_response.md | 15 ---- .../_ssh_credentials_create_request.md | 13 ---- .../_ssh_credentials_create_response.md | 15 ---- .../_ssh_credentials_delete_request.md | 11 --- .../_ssh_credentials_delete_response.md | 0 .../examples/_ssh_credentials_get_request.md | 11 --- .../examples/_ssh_credentials_get_response.md | 16 ---- .../examples/_ssh_credentials_list_request.md | 11 --- .../_ssh_credentials_list_response.md | 21 ------ .../_ssh_credentials_update_request.md | 13 ---- .../_ssh_credentials_update_response.md | 16 ---- .../_ssh_host_certificates_create_request.md | 13 ---- .../_ssh_host_certificates_create_response.md | 19 ----- .../_ssh_host_certificates_delete_request.md | 11 --- .../_ssh_host_certificates_delete_response.md | 0 .../_ssh_host_certificates_get_request.md | 11 --- .../_ssh_host_certificates_get_response.md | 20 ----- .../_ssh_host_certificates_list_request.md | 11 --- .../_ssh_host_certificates_list_response.md | 25 ------- .../_ssh_host_certificates_update_request.md | 13 ---- .../_ssh_host_certificates_update_response.md | 20 ----- .../_ssh_user_certificates_create_request.md | 13 ---- .../_ssh_user_certificates_create_response.md | 24 ------ .../_ssh_user_certificates_delete_request.md | 11 --- .../_ssh_user_certificates_delete_response.md | 0 .../_ssh_user_certificates_get_request.md | 11 --- .../_ssh_user_certificates_get_response.md | 25 ------- .../_ssh_user_certificates_list_request.md | 11 --- .../_ssh_user_certificates_list_response.md | 30 -------- .../_ssh_user_certificates_update_request.md | 13 ---- .../_ssh_user_certificates_update_response.md | 25 ------- .../_static_backends_create_request.md | 13 ---- .../_static_backends_create_response.md | 17 ----- .../_static_backends_delete_request.md | 11 --- .../_static_backends_delete_response.md | 0 .../examples/_static_backends_get_request.md | 13 ---- .../examples/_static_backends_get_response.md | 17 ----- .../examples/_static_backends_list_request.md | 11 --- .../_static_backends_list_response.md | 45 ----------- .../_static_backends_update_request.md | 13 ---- .../_static_backends_update_response.md | 17 ----- ..._tcp_edge_backend_module_delete_request.md | 11 --- ...tcp_edge_backend_module_delete_response.md | 0 .../_tcp_edge_backend_module_get_request.md | 11 --- .../_tcp_edge_backend_module_get_response.md | 13 ---- ...tcp_edge_backend_module_replace_request.md | 13 ---- ...cp_edge_backend_module_replace_response.md | 13 ---- ...ge_ip_restriction_module_delete_request.md | 11 --- ...e_ip_restriction_module_delete_response.md | 0 ..._edge_ip_restriction_module_get_request.md | 11 --- ...edge_ip_restriction_module_get_response.md | 15 ---- ...e_ip_restriction_module_replace_request.md | 13 ---- ..._ip_restriction_module_replace_response.md | 15 ---- ...ge_traffic_policy_module_delete_request.md | 11 --- ...e_traffic_policy_module_delete_response.md | 0 ..._edge_traffic_policy_module_get_request.md | 11 --- ...edge_traffic_policy_module_get_response.md | 10 --- ...e_traffic_policy_module_replace_request.md | 13 ---- ..._traffic_policy_module_replace_response.md | 10 --- .../_tls_certificates_create_request.md | 13 ---- .../_tls_certificates_create_response.md | 30 -------- .../_tls_certificates_delete_request.md | 11 --- .../_tls_certificates_delete_response.md | 0 .../examples/_tls_certificates_get_request.md | 11 --- .../_tls_certificates_get_response.md | 31 -------- .../_tls_certificates_list_request.md | 11 --- .../_tls_certificates_list_response.md | 60 --------------- .../_tls_certificates_update_request.md | 13 ---- .../_tls_certificates_update_response.md | 31 -------- ..._tls_edge_backend_module_delete_request.md | 11 --- ...tls_edge_backend_module_delete_response.md | 0 .../_tls_edge_backend_module_get_request.md | 11 --- .../_tls_edge_backend_module_get_response.md | 13 ---- ...tls_edge_backend_module_replace_request.md | 13 ---- ...ls_edge_backend_module_replace_response.md | 13 ---- ...ge_ip_restriction_module_delete_request.md | 11 --- ...e_ip_restriction_module_delete_response.md | 0 ..._edge_ip_restriction_module_get_request.md | 11 --- ...edge_ip_restriction_module_get_response.md | 19 ----- ...e_ip_restriction_module_replace_request.md | 13 ---- ..._ip_restriction_module_replace_response.md | 19 ----- ...s_edge_mutual_tls_module_delete_request.md | 11 --- ..._edge_mutual_tls_module_delete_response.md | 0 ..._tls_edge_mutual_tls_module_get_request.md | 11 --- ...tls_edge_mutual_tls_module_get_response.md | 15 ---- ..._edge_mutual_tls_module_replace_request.md | 13 ---- ...edge_mutual_tls_module_replace_response.md | 15 ---- ...e_tls_termination_module_delete_request.md | 11 --- ..._tls_termination_module_delete_response.md | 0 ...edge_tls_termination_module_get_request.md | 11 --- ...dge_tls_termination_module_get_response.md | 11 --- ..._tls_termination_module_replace_request.md | 13 ---- ...tls_termination_module_replace_response.md | 11 --- ...ge_traffic_policy_module_delete_request.md | 11 --- ...e_traffic_policy_module_delete_response.md | 0 ..._edge_traffic_policy_module_get_request.md | 11 --- ...edge_traffic_policy_module_get_response.md | 10 --- ...e_traffic_policy_module_replace_request.md | 13 ---- ..._traffic_policy_module_replace_response.md | 10 --- .../_tunnel_group_backends_create_request.md | 13 ---- .../_tunnel_group_backends_create_response.md | 18 ----- .../_tunnel_group_backends_delete_request.md | 11 --- .../_tunnel_group_backends_delete_response.md | 0 .../_tunnel_group_backends_get_request.md | 11 --- .../_tunnel_group_backends_get_response.md | 18 ----- .../_tunnel_group_backends_list_request.md | 11 --- .../_tunnel_group_backends_list_response.md | 24 ------ .../_tunnel_group_backends_update_request.md | 13 ---- .../_tunnel_group_backends_update_response.md | 18 ----- .../examples/_tunnel_sessions_get_request.md | 11 --- .../examples/_tunnel_sessions_get_response.md | 20 ----- .../examples/_tunnel_sessions_list_request.md | 11 --- .../_tunnel_sessions_list_response.md | 26 ------- .../_tunnel_sessions_restart_request.md | 13 ---- .../_tunnel_sessions_restart_response.md | 13 ---- .../examples/_tunnel_sessions_stop_request.md | 13 ---- .../_tunnel_sessions_stop_response.md | 13 ---- .../_tunnel_sessions_update_request.md | 13 ---- .../_tunnel_sessions_update_response.md | 13 ---- docs/api/examples/_tunnels_get_request.md | 11 --- docs/api/examples/_tunnels_get_response.md | 22 ------ docs/api/examples/_tunnels_list_request.md | 11 --- docs/api/examples/_tunnels_list_response.md | 42 ----------- .../_weighted_backends_create_request.md | 13 ---- .../_weighted_backends_create_response.md | 17 ----- .../_weighted_backends_delete_request.md | 11 --- .../_weighted_backends_delete_response.md | 0 .../_weighted_backends_get_request.md | 11 --- .../_weighted_backends_get_response.md | 17 ----- .../_weighted_backends_list_request.md | 11 --- .../_weighted_backends_list_response.md | 23 ------ .../_weighted_backends_update_request.md | 13 ---- .../_weighted_backends_update_response.md | 14 ---- 528 files changed, 7065 deletions(-) delete mode 100644 docs/api/examples/_abuse_reports_create_request.md delete mode 100644 docs/api/examples/_abuse_reports_create_response.md delete mode 100644 docs/api/examples/_abuse_reports_get_request.md delete mode 100644 docs/api/examples/_abuse_reports_get_response.md delete mode 100644 docs/api/examples/_agent_ingresses_create_request.md delete mode 100644 docs/api/examples/_agent_ingresses_create_response.md delete mode 100644 docs/api/examples/_agent_ingresses_delete_request.md delete mode 100644 docs/api/examples/_agent_ingresses_delete_response.md delete mode 100644 docs/api/examples/_agent_ingresses_get_request.md delete mode 100644 docs/api/examples/_agent_ingresses_get_response.md delete mode 100644 docs/api/examples/_agent_ingresses_list_request.md delete mode 100644 docs/api/examples/_agent_ingresses_list_response.md delete mode 100644 docs/api/examples/_agent_ingresses_update_request.md delete mode 100644 docs/api/examples/_agent_ingresses_update_response.md delete mode 100644 docs/api/examples/_api_keys_create_request.md delete mode 100644 docs/api/examples/_api_keys_create_response.md delete mode 100644 docs/api/examples/_api_keys_delete_request.md delete mode 100644 docs/api/examples/_api_keys_delete_response.md delete mode 100644 docs/api/examples/_api_keys_get_request.md delete mode 100644 docs/api/examples/_api_keys_get_response.md delete mode 100644 docs/api/examples/_api_keys_list_request.md delete mode 100644 docs/api/examples/_api_keys_list_response.md delete mode 100644 docs/api/examples/_api_keys_update_request.md delete mode 100644 docs/api/examples/_api_keys_update_response.md delete mode 100644 docs/api/examples/_bot_users_create_request.md delete mode 100644 docs/api/examples/_bot_users_create_response.md delete mode 100644 docs/api/examples/_bot_users_delete_request.md delete mode 100644 docs/api/examples/_bot_users_delete_response.md delete mode 100644 docs/api/examples/_bot_users_get_request.md delete mode 100644 docs/api/examples/_bot_users_get_response.md delete mode 100644 docs/api/examples/_bot_users_list_request.md delete mode 100644 docs/api/examples/_bot_users_list_response.md delete mode 100644 docs/api/examples/_bot_users_update_request.md delete mode 100644 docs/api/examples/_bot_users_update_response.md delete mode 100644 docs/api/examples/_certificate_authorities_create_request.md delete mode 100644 docs/api/examples/_certificate_authorities_create_response.md delete mode 100644 docs/api/examples/_certificate_authorities_delete_request.md delete mode 100644 docs/api/examples/_certificate_authorities_delete_response.md delete mode 100644 docs/api/examples/_certificate_authorities_get_request.md delete mode 100644 docs/api/examples/_certificate_authorities_get_response.md delete mode 100644 docs/api/examples/_certificate_authorities_list_request.md delete mode 100644 docs/api/examples/_certificate_authorities_list_response.md delete mode 100644 docs/api/examples/_certificate_authorities_update_request.md delete mode 100644 docs/api/examples/_certificate_authorities_update_response.md delete mode 100644 docs/api/examples/_credentials_create_request.md delete mode 100644 docs/api/examples/_credentials_create_response.md delete mode 100644 docs/api/examples/_credentials_delete_request.md delete mode 100644 docs/api/examples/_credentials_delete_response.md delete mode 100644 docs/api/examples/_credentials_get_request.md delete mode 100644 docs/api/examples/_credentials_get_response.md delete mode 100644 docs/api/examples/_credentials_list_request.md delete mode 100644 docs/api/examples/_credentials_list_response.md delete mode 100644 docs/api/examples/_credentials_update_request.md delete mode 100644 docs/api/examples/_credentials_update_response.md delete mode 100644 docs/api/examples/_edge_route_backend_module_delete_request.md delete mode 100644 docs/api/examples/_edge_route_backend_module_delete_response.md delete mode 100644 docs/api/examples/_edge_route_backend_module_get_request.md delete mode 100644 docs/api/examples/_edge_route_backend_module_get_response.md delete mode 100644 docs/api/examples/_edge_route_backend_module_replace_request.md delete mode 100644 docs/api/examples/_edge_route_backend_module_replace_response.md delete mode 100644 docs/api/examples/_edge_route_circuit_breaker_module_delete_request.md delete mode 100644 docs/api/examples/_edge_route_circuit_breaker_module_delete_response.md delete mode 100644 docs/api/examples/_edge_route_circuit_breaker_module_get_request.md delete mode 100644 docs/api/examples/_edge_route_circuit_breaker_module_get_response.md delete mode 100644 docs/api/examples/_edge_route_circuit_breaker_module_replace_request.md delete mode 100644 docs/api/examples/_edge_route_circuit_breaker_module_replace_response.md delete mode 100644 docs/api/examples/_edge_route_compression_module_delete_request.md delete mode 100644 docs/api/examples/_edge_route_compression_module_delete_response.md delete mode 100644 docs/api/examples/_edge_route_compression_module_get_request.md delete mode 100644 docs/api/examples/_edge_route_compression_module_get_response.md delete mode 100644 docs/api/examples/_edge_route_compression_module_replace_request.md delete mode 100644 docs/api/examples/_edge_route_compression_module_replace_response.md delete mode 100644 docs/api/examples/_edge_route_ip_restriction_module_delete_request.md delete mode 100644 docs/api/examples/_edge_route_ip_restriction_module_delete_response.md delete mode 100644 docs/api/examples/_edge_route_ip_restriction_module_get_request.md delete mode 100644 docs/api/examples/_edge_route_ip_restriction_module_get_response.md delete mode 100644 docs/api/examples/_edge_route_ip_restriction_module_replace_request.md delete mode 100644 docs/api/examples/_edge_route_ip_restriction_module_replace_response.md delete mode 100644 docs/api/examples/_edge_route_o_auth_module_delete_request.md delete mode 100644 docs/api/examples/_edge_route_o_auth_module_delete_response.md delete mode 100644 docs/api/examples/_edge_route_o_auth_module_get_request.md delete mode 100644 docs/api/examples/_edge_route_o_auth_module_get_response.md delete mode 100644 docs/api/examples/_edge_route_o_auth_module_replace_request.md delete mode 100644 docs/api/examples/_edge_route_o_auth_module_replace_response.md delete mode 100644 docs/api/examples/_edge_route_oidc_module_delete_request.md delete mode 100644 docs/api/examples/_edge_route_oidc_module_delete_response.md delete mode 100644 docs/api/examples/_edge_route_oidc_module_get_request.md delete mode 100644 docs/api/examples/_edge_route_oidc_module_get_response.md delete mode 100644 docs/api/examples/_edge_route_oidc_module_replace_request.md delete mode 100644 docs/api/examples/_edge_route_oidc_module_replace_response.md delete mode 100644 docs/api/examples/_edge_route_request_headers_module_delete_request.md delete mode 100644 docs/api/examples/_edge_route_request_headers_module_delete_response.md delete mode 100644 docs/api/examples/_edge_route_request_headers_module_get_request.md delete mode 100644 docs/api/examples/_edge_route_request_headers_module_get_response.md delete mode 100644 docs/api/examples/_edge_route_request_headers_module_replace_request.md delete mode 100644 docs/api/examples/_edge_route_request_headers_module_replace_response.md delete mode 100644 docs/api/examples/_edge_route_response_headers_module_delete_request.md delete mode 100644 docs/api/examples/_edge_route_response_headers_module_delete_response.md delete mode 100644 docs/api/examples/_edge_route_response_headers_module_get_request.md delete mode 100644 docs/api/examples/_edge_route_response_headers_module_get_response.md delete mode 100644 docs/api/examples/_edge_route_response_headers_module_replace_request.md delete mode 100644 docs/api/examples/_edge_route_response_headers_module_replace_response.md delete mode 100644 docs/api/examples/_edge_route_saml_module_delete_request.md delete mode 100644 docs/api/examples/_edge_route_saml_module_delete_response.md delete mode 100644 docs/api/examples/_edge_route_saml_module_get_request.md delete mode 100644 docs/api/examples/_edge_route_saml_module_get_response.md delete mode 100644 docs/api/examples/_edge_route_saml_module_replace_request.md delete mode 100644 docs/api/examples/_edge_route_saml_module_replace_response.md delete mode 100644 docs/api/examples/_edge_route_traffic_policy_module_delete_request.md delete mode 100644 docs/api/examples/_edge_route_traffic_policy_module_delete_response.md delete mode 100644 docs/api/examples/_edge_route_traffic_policy_module_get_request.md delete mode 100644 docs/api/examples/_edge_route_traffic_policy_module_get_response.md delete mode 100644 docs/api/examples/_edge_route_traffic_policy_module_replace_request.md delete mode 100644 docs/api/examples/_edge_route_traffic_policy_module_replace_response.md delete mode 100644 docs/api/examples/_edge_route_user_agent_filter_module_delete_request.md delete mode 100644 docs/api/examples/_edge_route_user_agent_filter_module_delete_response.md delete mode 100644 docs/api/examples/_edge_route_user_agent_filter_module_get_request.md delete mode 100644 docs/api/examples/_edge_route_user_agent_filter_module_get_response.md delete mode 100644 docs/api/examples/_edge_route_user_agent_filter_module_replace_request.md delete mode 100644 docs/api/examples/_edge_route_user_agent_filter_module_replace_response.md delete mode 100644 docs/api/examples/_edge_route_webhook_verification_module_delete_request.md delete mode 100644 docs/api/examples/_edge_route_webhook_verification_module_delete_response.md delete mode 100644 docs/api/examples/_edge_route_webhook_verification_module_get_request.md delete mode 100644 docs/api/examples/_edge_route_webhook_verification_module_get_response.md delete mode 100644 docs/api/examples/_edge_route_webhook_verification_module_replace_request.md delete mode 100644 docs/api/examples/_edge_route_webhook_verification_module_replace_response.md delete mode 100644 docs/api/examples/_edge_route_websocket_tcp_converter_module_delete_request.md delete mode 100644 docs/api/examples/_edge_route_websocket_tcp_converter_module_delete_response.md delete mode 100644 docs/api/examples/_edge_route_websocket_tcp_converter_module_get_request.md delete mode 100644 docs/api/examples/_edge_route_websocket_tcp_converter_module_get_response.md delete mode 100644 docs/api/examples/_edge_route_websocket_tcp_converter_module_replace_request.md delete mode 100644 docs/api/examples/_edge_route_websocket_tcp_converter_module_replace_response.md delete mode 100644 docs/api/examples/_edges_https_create_request.md delete mode 100644 docs/api/examples/_edges_https_create_response.md delete mode 100644 docs/api/examples/_edges_https_delete_request.md delete mode 100644 docs/api/examples/_edges_https_delete_response.md delete mode 100644 docs/api/examples/_edges_https_get_request.md delete mode 100644 docs/api/examples/_edges_https_get_response.md delete mode 100644 docs/api/examples/_edges_https_list_request.md delete mode 100644 docs/api/examples/_edges_https_list_response.md delete mode 100644 docs/api/examples/_edges_https_routes_create_request.md delete mode 100644 docs/api/examples/_edges_https_routes_create_response.md delete mode 100644 docs/api/examples/_edges_https_routes_delete_request.md delete mode 100644 docs/api/examples/_edges_https_routes_delete_response.md delete mode 100644 docs/api/examples/_edges_https_routes_get_request.md delete mode 100644 docs/api/examples/_edges_https_routes_get_response.md delete mode 100644 docs/api/examples/_edges_https_routes_update_request.md delete mode 100644 docs/api/examples/_edges_https_routes_update_response.md delete mode 100644 docs/api/examples/_edges_https_update_request.md delete mode 100644 docs/api/examples/_edges_https_update_response.md delete mode 100644 docs/api/examples/_edges_tcp_create_request.md delete mode 100644 docs/api/examples/_edges_tcp_create_response.md delete mode 100644 docs/api/examples/_edges_tcp_delete_request.md delete mode 100644 docs/api/examples/_edges_tcp_delete_response.md delete mode 100644 docs/api/examples/_edges_tcp_get_request.md delete mode 100644 docs/api/examples/_edges_tcp_get_response.md delete mode 100644 docs/api/examples/_edges_tcp_list_request.md delete mode 100644 docs/api/examples/_edges_tcp_list_response.md delete mode 100644 docs/api/examples/_edges_tcp_update_request.md delete mode 100644 docs/api/examples/_edges_tcp_update_response.md delete mode 100644 docs/api/examples/_edges_tls_create_request.md delete mode 100644 docs/api/examples/_edges_tls_create_response.md delete mode 100644 docs/api/examples/_edges_tls_delete_request.md delete mode 100644 docs/api/examples/_edges_tls_delete_response.md delete mode 100644 docs/api/examples/_edges_tls_get_request.md delete mode 100644 docs/api/examples/_edges_tls_get_response.md delete mode 100644 docs/api/examples/_edges_tls_list_request.md delete mode 100644 docs/api/examples/_edges_tls_list_response.md delete mode 100644 docs/api/examples/_edges_tls_update_request.md delete mode 100644 docs/api/examples/_edges_tls_update_response.md delete mode 100644 docs/api/examples/_endpoint_basic_auth_module_delete_request.md delete mode 100644 docs/api/examples/_endpoint_basic_auth_module_delete_response.md delete mode 100644 docs/api/examples/_endpoint_basic_auth_module_get_request.md delete mode 100644 docs/api/examples/_endpoint_basic_auth_module_get_response.md delete mode 100644 docs/api/examples/_endpoint_basic_auth_module_replace_request.md delete mode 100644 docs/api/examples/_endpoint_basic_auth_module_replace_response.md delete mode 100644 docs/api/examples/_endpoint_circuit_breaker_module_delete_request.md delete mode 100644 docs/api/examples/_endpoint_circuit_breaker_module_delete_response.md delete mode 100644 docs/api/examples/_endpoint_circuit_breaker_module_get_request.md delete mode 100644 docs/api/examples/_endpoint_circuit_breaker_module_get_response.md delete mode 100644 docs/api/examples/_endpoint_circuit_breaker_module_replace_request.md delete mode 100644 docs/api/examples/_endpoint_circuit_breaker_module_replace_response.md delete mode 100644 docs/api/examples/_endpoint_compression_module_delete_request.md delete mode 100644 docs/api/examples/_endpoint_compression_module_delete_response.md delete mode 100644 docs/api/examples/_endpoint_compression_module_get_request.md delete mode 100644 docs/api/examples/_endpoint_compression_module_get_response.md delete mode 100644 docs/api/examples/_endpoint_compression_module_replace_request.md delete mode 100644 docs/api/examples/_endpoint_compression_module_replace_response.md delete mode 100644 docs/api/examples/_endpoint_configurations_create_request.md delete mode 100644 docs/api/examples/_endpoint_configurations_create_response.md delete mode 100644 docs/api/examples/_endpoint_configurations_delete_request.md delete mode 100644 docs/api/examples/_endpoint_configurations_delete_response.md delete mode 100644 docs/api/examples/_endpoint_configurations_get_request.md delete mode 100644 docs/api/examples/_endpoint_configurations_get_response.md delete mode 100644 docs/api/examples/_endpoint_configurations_list_request.md delete mode 100644 docs/api/examples/_endpoint_configurations_list_response.md delete mode 100644 docs/api/examples/_endpoint_configurations_update_request.md delete mode 100644 docs/api/examples/_endpoint_configurations_update_response.md delete mode 100644 docs/api/examples/_endpoint_ip_policy_module_delete_request.md delete mode 100644 docs/api/examples/_endpoint_ip_policy_module_delete_response.md delete mode 100644 docs/api/examples/_endpoint_ip_policy_module_get_request.md delete mode 100644 docs/api/examples/_endpoint_ip_policy_module_get_response.md delete mode 100644 docs/api/examples/_endpoint_ip_policy_module_replace_request.md delete mode 100644 docs/api/examples/_endpoint_ip_policy_module_replace_response.md delete mode 100644 docs/api/examples/_endpoint_mutual_tls_module_delete_request.md delete mode 100644 docs/api/examples/_endpoint_mutual_tls_module_delete_response.md delete mode 100644 docs/api/examples/_endpoint_mutual_tls_module_get_request.md delete mode 100644 docs/api/examples/_endpoint_mutual_tls_module_get_response.md delete mode 100644 docs/api/examples/_endpoint_mutual_tls_module_replace_request.md delete mode 100644 docs/api/examples/_endpoint_mutual_tls_module_replace_response.md delete mode 100644 docs/api/examples/_endpoint_o_auth_module_delete_request.md delete mode 100644 docs/api/examples/_endpoint_o_auth_module_delete_response.md delete mode 100644 docs/api/examples/_endpoint_o_auth_module_get_request.md delete mode 100644 docs/api/examples/_endpoint_o_auth_module_get_response.md delete mode 100644 docs/api/examples/_endpoint_o_auth_module_replace_request.md delete mode 100644 docs/api/examples/_endpoint_o_auth_module_replace_response.md delete mode 100644 docs/api/examples/_endpoint_oidc_module_delete_request.md delete mode 100644 docs/api/examples/_endpoint_oidc_module_delete_response.md delete mode 100644 docs/api/examples/_endpoint_oidc_module_get_request.md delete mode 100644 docs/api/examples/_endpoint_oidc_module_get_response.md delete mode 100644 docs/api/examples/_endpoint_oidc_module_replace_request.md delete mode 100644 docs/api/examples/_endpoint_oidc_module_replace_response.md delete mode 100644 docs/api/examples/_endpoint_request_headers_module_delete_request.md delete mode 100644 docs/api/examples/_endpoint_request_headers_module_delete_response.md delete mode 100644 docs/api/examples/_endpoint_request_headers_module_get_request.md delete mode 100644 docs/api/examples/_endpoint_request_headers_module_get_response.md delete mode 100644 docs/api/examples/_endpoint_request_headers_module_replace_request.md delete mode 100644 docs/api/examples/_endpoint_request_headers_module_replace_response.md delete mode 100644 docs/api/examples/_endpoint_response_headers_module_delete_request.md delete mode 100644 docs/api/examples/_endpoint_response_headers_module_delete_response.md delete mode 100644 docs/api/examples/_endpoint_response_headers_module_get_request.md delete mode 100644 docs/api/examples/_endpoint_response_headers_module_get_response.md delete mode 100644 docs/api/examples/_endpoint_response_headers_module_replace_request.md delete mode 100644 docs/api/examples/_endpoint_response_headers_module_replace_response.md delete mode 100644 docs/api/examples/_endpoint_saml_module_delete_request.md delete mode 100644 docs/api/examples/_endpoint_saml_module_delete_response.md delete mode 100644 docs/api/examples/_endpoint_saml_module_get_request.md delete mode 100644 docs/api/examples/_endpoint_saml_module_get_response.md delete mode 100644 docs/api/examples/_endpoint_saml_module_replace_request.md delete mode 100644 docs/api/examples/_endpoint_saml_module_replace_response.md delete mode 100644 docs/api/examples/_endpoint_tls_termination_module_delete_request.md delete mode 100644 docs/api/examples/_endpoint_tls_termination_module_delete_response.md delete mode 100644 docs/api/examples/_endpoint_tls_termination_module_get_request.md delete mode 100644 docs/api/examples/_endpoint_tls_termination_module_get_response.md delete mode 100644 docs/api/examples/_endpoint_tls_termination_module_replace_request.md delete mode 100644 docs/api/examples/_endpoint_tls_termination_module_replace_response.md delete mode 100644 docs/api/examples/_endpoint_webhook_validation_module_delete_request.md delete mode 100644 docs/api/examples/_endpoint_webhook_validation_module_delete_response.md delete mode 100644 docs/api/examples/_endpoint_webhook_validation_module_get_request.md delete mode 100644 docs/api/examples/_endpoint_webhook_validation_module_get_response.md delete mode 100644 docs/api/examples/_endpoint_webhook_validation_module_replace_request.md delete mode 100644 docs/api/examples/_endpoint_webhook_validation_module_replace_response.md delete mode 100644 docs/api/examples/_endpoints_create_request.md delete mode 100644 docs/api/examples/_endpoints_create_response.md delete mode 100644 docs/api/examples/_endpoints_delete_request.md delete mode 100644 docs/api/examples/_endpoints_delete_response.md delete mode 100644 docs/api/examples/_endpoints_get_request.md delete mode 100644 docs/api/examples/_endpoints_get_response.md delete mode 100644 docs/api/examples/_endpoints_list_request.md delete mode 100644 docs/api/examples/_endpoints_list_response.md delete mode 100644 docs/api/examples/_endpoints_update_request.md delete mode 100644 docs/api/examples/_endpoints_update_response.md delete mode 100644 docs/api/examples/_event_destinations_create_request.md delete mode 100644 docs/api/examples/_event_destinations_create_response.md delete mode 100644 docs/api/examples/_event_destinations_delete_request.md delete mode 100644 docs/api/examples/_event_destinations_delete_response.md delete mode 100644 docs/api/examples/_event_destinations_get_request.md delete mode 100644 docs/api/examples/_event_destinations_get_response.md delete mode 100644 docs/api/examples/_event_destinations_list_request.md delete mode 100644 docs/api/examples/_event_destinations_list_response.md delete mode 100644 docs/api/examples/_event_destinations_update_request.md delete mode 100644 docs/api/examples/_event_destinations_update_response.md delete mode 100644 docs/api/examples/_event_sources_create_request.md delete mode 100644 docs/api/examples/_event_sources_create_response.md delete mode 100644 docs/api/examples/_event_sources_delete_request.md delete mode 100644 docs/api/examples/_event_sources_delete_response.md delete mode 100644 docs/api/examples/_event_sources_get_request.md delete mode 100644 docs/api/examples/_event_sources_get_response.md delete mode 100644 docs/api/examples/_event_sources_list_request.md delete mode 100644 docs/api/examples/_event_sources_list_response.md delete mode 100644 docs/api/examples/_event_sources_update_request.md delete mode 100644 docs/api/examples/_event_sources_update_response.md delete mode 100644 docs/api/examples/_event_subscriptions_create_request.md delete mode 100644 docs/api/examples/_event_subscriptions_create_response.md delete mode 100644 docs/api/examples/_event_subscriptions_delete_request.md delete mode 100644 docs/api/examples/_event_subscriptions_delete_response.md delete mode 100644 docs/api/examples/_event_subscriptions_get_request.md delete mode 100644 docs/api/examples/_event_subscriptions_get_response.md delete mode 100644 docs/api/examples/_event_subscriptions_list_request.md delete mode 100644 docs/api/examples/_event_subscriptions_list_response.md delete mode 100644 docs/api/examples/_event_subscriptions_update_request.md delete mode 100644 docs/api/examples/_event_subscriptions_update_response.md delete mode 100644 docs/api/examples/_failover_backends_create_request.md delete mode 100644 docs/api/examples/_failover_backends_create_response.md delete mode 100644 docs/api/examples/_failover_backends_delete_request.md delete mode 100644 docs/api/examples/_failover_backends_delete_response.md delete mode 100644 docs/api/examples/_failover_backends_get_request.md delete mode 100644 docs/api/examples/_failover_backends_get_response.md delete mode 100644 docs/api/examples/_failover_backends_list_request.md delete mode 100644 docs/api/examples/_failover_backends_list_response.md delete mode 100644 docs/api/examples/_failover_backends_update_request.md delete mode 100644 docs/api/examples/_failover_backends_update_response.md delete mode 100644 docs/api/examples/_http_response_backends_create_request.md delete mode 100644 docs/api/examples/_http_response_backends_create_response.md delete mode 100644 docs/api/examples/_http_response_backends_delete_request.md delete mode 100644 docs/api/examples/_http_response_backends_delete_response.md delete mode 100644 docs/api/examples/_http_response_backends_get_request.md delete mode 100644 docs/api/examples/_http_response_backends_get_response.md delete mode 100644 docs/api/examples/_http_response_backends_list_request.md delete mode 100644 docs/api/examples/_http_response_backends_list_response.md delete mode 100644 docs/api/examples/_http_response_backends_update_request.md delete mode 100644 docs/api/examples/_http_response_backends_update_response.md delete mode 100644 docs/api/examples/_https_edge_mutual_tls_module_delete_request.md delete mode 100644 docs/api/examples/_https_edge_mutual_tls_module_delete_response.md delete mode 100644 docs/api/examples/_https_edge_mutual_tls_module_get_request.md delete mode 100644 docs/api/examples/_https_edge_mutual_tls_module_get_response.md delete mode 100644 docs/api/examples/_https_edge_mutual_tls_module_replace_request.md delete mode 100644 docs/api/examples/_https_edge_mutual_tls_module_replace_response.md delete mode 100644 docs/api/examples/_https_edge_tls_termination_module_delete_request.md delete mode 100644 docs/api/examples/_https_edge_tls_termination_module_delete_response.md delete mode 100644 docs/api/examples/_https_edge_tls_termination_module_get_request.md delete mode 100644 docs/api/examples/_https_edge_tls_termination_module_get_response.md delete mode 100644 docs/api/examples/_https_edge_tls_termination_module_replace_request.md delete mode 100644 docs/api/examples/_https_edge_tls_termination_module_replace_response.md delete mode 100644 docs/api/examples/_ip_policies_create_request.md delete mode 100644 docs/api/examples/_ip_policies_create_response.md delete mode 100644 docs/api/examples/_ip_policies_delete_request.md delete mode 100644 docs/api/examples/_ip_policies_delete_response.md delete mode 100644 docs/api/examples/_ip_policies_get_request.md delete mode 100644 docs/api/examples/_ip_policies_get_response.md delete mode 100644 docs/api/examples/_ip_policies_list_request.md delete mode 100644 docs/api/examples/_ip_policies_list_response.md delete mode 100644 docs/api/examples/_ip_policies_update_request.md delete mode 100644 docs/api/examples/_ip_policies_update_response.md delete mode 100644 docs/api/examples/_ip_policy_rules_create_request.md delete mode 100644 docs/api/examples/_ip_policy_rules_create_response.md delete mode 100644 docs/api/examples/_ip_policy_rules_delete_request.md delete mode 100644 docs/api/examples/_ip_policy_rules_delete_response.md delete mode 100644 docs/api/examples/_ip_policy_rules_get_request.md delete mode 100644 docs/api/examples/_ip_policy_rules_get_response.md delete mode 100644 docs/api/examples/_ip_policy_rules_list_request.md delete mode 100644 docs/api/examples/_ip_policy_rules_list_response.md delete mode 100644 docs/api/examples/_ip_policy_rules_update_request.md delete mode 100644 docs/api/examples/_ip_policy_rules_update_response.md delete mode 100644 docs/api/examples/_ip_restrictions_create_request.md delete mode 100644 docs/api/examples/_ip_restrictions_create_response.md delete mode 100644 docs/api/examples/_ip_restrictions_delete_request.md delete mode 100644 docs/api/examples/_ip_restrictions_delete_response.md delete mode 100644 docs/api/examples/_ip_restrictions_get_request.md delete mode 100644 docs/api/examples/_ip_restrictions_get_response.md delete mode 100644 docs/api/examples/_ip_restrictions_list_request.md delete mode 100644 docs/api/examples/_ip_restrictions_list_response.md delete mode 100644 docs/api/examples/_ip_restrictions_update_request.md delete mode 100644 docs/api/examples/_ip_restrictions_update_response.md delete mode 100644 docs/api/examples/_reserved_addrs_create_request.md delete mode 100644 docs/api/examples/_reserved_addrs_create_response.md delete mode 100644 docs/api/examples/_reserved_addrs_delete_endpoint_config_request.md delete mode 100644 docs/api/examples/_reserved_addrs_delete_endpoint_config_response.md delete mode 100644 docs/api/examples/_reserved_addrs_delete_request.md delete mode 100644 docs/api/examples/_reserved_addrs_delete_response.md delete mode 100644 docs/api/examples/_reserved_addrs_get_request.md delete mode 100644 docs/api/examples/_reserved_addrs_get_response.md delete mode 100644 docs/api/examples/_reserved_addrs_list_request.md delete mode 100644 docs/api/examples/_reserved_addrs_list_response.md delete mode 100644 docs/api/examples/_reserved_addrs_update_request.md delete mode 100644 docs/api/examples/_reserved_addrs_update_response.md delete mode 100644 docs/api/examples/_reserved_domains_create_request.md delete mode 100644 docs/api/examples/_reserved_domains_create_response.md delete mode 100644 docs/api/examples/_reserved_domains_delete_certificate_management_policy_request.md delete mode 100644 docs/api/examples/_reserved_domains_delete_certificate_management_policy_response.md delete mode 100644 docs/api/examples/_reserved_domains_delete_certificate_request.md delete mode 100644 docs/api/examples/_reserved_domains_delete_certificate_response.md delete mode 100644 docs/api/examples/_reserved_domains_delete_http_endpoint_config_request.md delete mode 100644 docs/api/examples/_reserved_domains_delete_http_endpoint_config_response.md delete mode 100644 docs/api/examples/_reserved_domains_delete_https_endpoint_config_request.md delete mode 100644 docs/api/examples/_reserved_domains_delete_https_endpoint_config_response.md delete mode 100644 docs/api/examples/_reserved_domains_delete_request.md delete mode 100644 docs/api/examples/_reserved_domains_delete_response.md delete mode 100644 docs/api/examples/_reserved_domains_get_request.md delete mode 100644 docs/api/examples/_reserved_domains_get_response.md delete mode 100644 docs/api/examples/_reserved_domains_list_request.md delete mode 100644 docs/api/examples/_reserved_domains_list_response.md delete mode 100644 docs/api/examples/_reserved_domains_update_request.md delete mode 100644 docs/api/examples/_reserved_domains_update_response.md delete mode 100644 docs/api/examples/_self_request.md delete mode 100644 docs/api/examples/_self_response.md delete mode 100644 docs/api/examples/_ssh_certificate_authorities_create_request.md delete mode 100644 docs/api/examples/_ssh_certificate_authorities_create_response.md delete mode 100644 docs/api/examples/_ssh_certificate_authorities_delete_request.md delete mode 100644 docs/api/examples/_ssh_certificate_authorities_delete_response.md delete mode 100644 docs/api/examples/_ssh_certificate_authorities_get_request.md delete mode 100644 docs/api/examples/_ssh_certificate_authorities_get_response.md delete mode 100644 docs/api/examples/_ssh_certificate_authorities_list_request.md delete mode 100644 docs/api/examples/_ssh_certificate_authorities_list_response.md delete mode 100644 docs/api/examples/_ssh_certificate_authorities_update_request.md delete mode 100644 docs/api/examples/_ssh_certificate_authorities_update_response.md delete mode 100644 docs/api/examples/_ssh_credentials_create_request.md delete mode 100644 docs/api/examples/_ssh_credentials_create_response.md delete mode 100644 docs/api/examples/_ssh_credentials_delete_request.md delete mode 100644 docs/api/examples/_ssh_credentials_delete_response.md delete mode 100644 docs/api/examples/_ssh_credentials_get_request.md delete mode 100644 docs/api/examples/_ssh_credentials_get_response.md delete mode 100644 docs/api/examples/_ssh_credentials_list_request.md delete mode 100644 docs/api/examples/_ssh_credentials_list_response.md delete mode 100644 docs/api/examples/_ssh_credentials_update_request.md delete mode 100644 docs/api/examples/_ssh_credentials_update_response.md delete mode 100644 docs/api/examples/_ssh_host_certificates_create_request.md delete mode 100644 docs/api/examples/_ssh_host_certificates_create_response.md delete mode 100644 docs/api/examples/_ssh_host_certificates_delete_request.md delete mode 100644 docs/api/examples/_ssh_host_certificates_delete_response.md delete mode 100644 docs/api/examples/_ssh_host_certificates_get_request.md delete mode 100644 docs/api/examples/_ssh_host_certificates_get_response.md delete mode 100644 docs/api/examples/_ssh_host_certificates_list_request.md delete mode 100644 docs/api/examples/_ssh_host_certificates_list_response.md delete mode 100644 docs/api/examples/_ssh_host_certificates_update_request.md delete mode 100644 docs/api/examples/_ssh_host_certificates_update_response.md delete mode 100644 docs/api/examples/_ssh_user_certificates_create_request.md delete mode 100644 docs/api/examples/_ssh_user_certificates_create_response.md delete mode 100644 docs/api/examples/_ssh_user_certificates_delete_request.md delete mode 100644 docs/api/examples/_ssh_user_certificates_delete_response.md delete mode 100644 docs/api/examples/_ssh_user_certificates_get_request.md delete mode 100644 docs/api/examples/_ssh_user_certificates_get_response.md delete mode 100644 docs/api/examples/_ssh_user_certificates_list_request.md delete mode 100644 docs/api/examples/_ssh_user_certificates_list_response.md delete mode 100644 docs/api/examples/_ssh_user_certificates_update_request.md delete mode 100644 docs/api/examples/_ssh_user_certificates_update_response.md delete mode 100644 docs/api/examples/_static_backends_create_request.md delete mode 100644 docs/api/examples/_static_backends_create_response.md delete mode 100644 docs/api/examples/_static_backends_delete_request.md delete mode 100644 docs/api/examples/_static_backends_delete_response.md delete mode 100644 docs/api/examples/_static_backends_get_request.md delete mode 100644 docs/api/examples/_static_backends_get_response.md delete mode 100644 docs/api/examples/_static_backends_list_request.md delete mode 100644 docs/api/examples/_static_backends_list_response.md delete mode 100644 docs/api/examples/_static_backends_update_request.md delete mode 100644 docs/api/examples/_static_backends_update_response.md delete mode 100644 docs/api/examples/_tcp_edge_backend_module_delete_request.md delete mode 100644 docs/api/examples/_tcp_edge_backend_module_delete_response.md delete mode 100644 docs/api/examples/_tcp_edge_backend_module_get_request.md delete mode 100644 docs/api/examples/_tcp_edge_backend_module_get_response.md delete mode 100644 docs/api/examples/_tcp_edge_backend_module_replace_request.md delete mode 100644 docs/api/examples/_tcp_edge_backend_module_replace_response.md delete mode 100644 docs/api/examples/_tcp_edge_ip_restriction_module_delete_request.md delete mode 100644 docs/api/examples/_tcp_edge_ip_restriction_module_delete_response.md delete mode 100644 docs/api/examples/_tcp_edge_ip_restriction_module_get_request.md delete mode 100644 docs/api/examples/_tcp_edge_ip_restriction_module_get_response.md delete mode 100644 docs/api/examples/_tcp_edge_ip_restriction_module_replace_request.md delete mode 100644 docs/api/examples/_tcp_edge_ip_restriction_module_replace_response.md delete mode 100644 docs/api/examples/_tcp_edge_traffic_policy_module_delete_request.md delete mode 100644 docs/api/examples/_tcp_edge_traffic_policy_module_delete_response.md delete mode 100644 docs/api/examples/_tcp_edge_traffic_policy_module_get_request.md delete mode 100644 docs/api/examples/_tcp_edge_traffic_policy_module_get_response.md delete mode 100644 docs/api/examples/_tcp_edge_traffic_policy_module_replace_request.md delete mode 100644 docs/api/examples/_tcp_edge_traffic_policy_module_replace_response.md delete mode 100644 docs/api/examples/_tls_certificates_create_request.md delete mode 100644 docs/api/examples/_tls_certificates_create_response.md delete mode 100644 docs/api/examples/_tls_certificates_delete_request.md delete mode 100644 docs/api/examples/_tls_certificates_delete_response.md delete mode 100644 docs/api/examples/_tls_certificates_get_request.md delete mode 100644 docs/api/examples/_tls_certificates_get_response.md delete mode 100644 docs/api/examples/_tls_certificates_list_request.md delete mode 100644 docs/api/examples/_tls_certificates_list_response.md delete mode 100644 docs/api/examples/_tls_certificates_update_request.md delete mode 100644 docs/api/examples/_tls_certificates_update_response.md delete mode 100644 docs/api/examples/_tls_edge_backend_module_delete_request.md delete mode 100644 docs/api/examples/_tls_edge_backend_module_delete_response.md delete mode 100644 docs/api/examples/_tls_edge_backend_module_get_request.md delete mode 100644 docs/api/examples/_tls_edge_backend_module_get_response.md delete mode 100644 docs/api/examples/_tls_edge_backend_module_replace_request.md delete mode 100644 docs/api/examples/_tls_edge_backend_module_replace_response.md delete mode 100644 docs/api/examples/_tls_edge_ip_restriction_module_delete_request.md delete mode 100644 docs/api/examples/_tls_edge_ip_restriction_module_delete_response.md delete mode 100644 docs/api/examples/_tls_edge_ip_restriction_module_get_request.md delete mode 100644 docs/api/examples/_tls_edge_ip_restriction_module_get_response.md delete mode 100644 docs/api/examples/_tls_edge_ip_restriction_module_replace_request.md delete mode 100644 docs/api/examples/_tls_edge_ip_restriction_module_replace_response.md delete mode 100644 docs/api/examples/_tls_edge_mutual_tls_module_delete_request.md delete mode 100644 docs/api/examples/_tls_edge_mutual_tls_module_delete_response.md delete mode 100644 docs/api/examples/_tls_edge_mutual_tls_module_get_request.md delete mode 100644 docs/api/examples/_tls_edge_mutual_tls_module_get_response.md delete mode 100644 docs/api/examples/_tls_edge_mutual_tls_module_replace_request.md delete mode 100644 docs/api/examples/_tls_edge_mutual_tls_module_replace_response.md delete mode 100644 docs/api/examples/_tls_edge_tls_termination_module_delete_request.md delete mode 100644 docs/api/examples/_tls_edge_tls_termination_module_delete_response.md delete mode 100644 docs/api/examples/_tls_edge_tls_termination_module_get_request.md delete mode 100644 docs/api/examples/_tls_edge_tls_termination_module_get_response.md delete mode 100644 docs/api/examples/_tls_edge_tls_termination_module_replace_request.md delete mode 100644 docs/api/examples/_tls_edge_tls_termination_module_replace_response.md delete mode 100644 docs/api/examples/_tls_edge_traffic_policy_module_delete_request.md delete mode 100644 docs/api/examples/_tls_edge_traffic_policy_module_delete_response.md delete mode 100644 docs/api/examples/_tls_edge_traffic_policy_module_get_request.md delete mode 100644 docs/api/examples/_tls_edge_traffic_policy_module_get_response.md delete mode 100644 docs/api/examples/_tls_edge_traffic_policy_module_replace_request.md delete mode 100644 docs/api/examples/_tls_edge_traffic_policy_module_replace_response.md delete mode 100644 docs/api/examples/_tunnel_group_backends_create_request.md delete mode 100644 docs/api/examples/_tunnel_group_backends_create_response.md delete mode 100644 docs/api/examples/_tunnel_group_backends_delete_request.md delete mode 100644 docs/api/examples/_tunnel_group_backends_delete_response.md delete mode 100644 docs/api/examples/_tunnel_group_backends_get_request.md delete mode 100644 docs/api/examples/_tunnel_group_backends_get_response.md delete mode 100644 docs/api/examples/_tunnel_group_backends_list_request.md delete mode 100644 docs/api/examples/_tunnel_group_backends_list_response.md delete mode 100644 docs/api/examples/_tunnel_group_backends_update_request.md delete mode 100644 docs/api/examples/_tunnel_group_backends_update_response.md delete mode 100644 docs/api/examples/_tunnel_sessions_get_request.md delete mode 100644 docs/api/examples/_tunnel_sessions_get_response.md delete mode 100644 docs/api/examples/_tunnel_sessions_list_request.md delete mode 100644 docs/api/examples/_tunnel_sessions_list_response.md delete mode 100644 docs/api/examples/_tunnel_sessions_restart_request.md delete mode 100644 docs/api/examples/_tunnel_sessions_restart_response.md delete mode 100644 docs/api/examples/_tunnel_sessions_stop_request.md delete mode 100644 docs/api/examples/_tunnel_sessions_stop_response.md delete mode 100644 docs/api/examples/_tunnel_sessions_update_request.md delete mode 100644 docs/api/examples/_tunnel_sessions_update_response.md delete mode 100644 docs/api/examples/_tunnels_get_request.md delete mode 100644 docs/api/examples/_tunnels_get_response.md delete mode 100644 docs/api/examples/_tunnels_list_request.md delete mode 100644 docs/api/examples/_tunnels_list_response.md delete mode 100644 docs/api/examples/_weighted_backends_create_request.md delete mode 100644 docs/api/examples/_weighted_backends_create_response.md delete mode 100644 docs/api/examples/_weighted_backends_delete_request.md delete mode 100644 docs/api/examples/_weighted_backends_delete_response.md delete mode 100644 docs/api/examples/_weighted_backends_get_request.md delete mode 100644 docs/api/examples/_weighted_backends_get_response.md delete mode 100644 docs/api/examples/_weighted_backends_list_request.md delete mode 100644 docs/api/examples/_weighted_backends_list_response.md delete mode 100644 docs/api/examples/_weighted_backends_update_request.md delete mode 100644 docs/api/examples/_weighted_backends_update_response.md diff --git a/docs/api/examples/_abuse_reports_create_request.md b/docs/api/examples/_abuse_reports_create_request.md deleted file mode 100644 index 8223534ea0..0000000000 --- a/docs/api/examples/_abuse_reports_create_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X POST \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"metadata":"{\"incident_id\":1233122}","urls":["http://legit-facebook-login.ngrok.io/login"]}' \ -https://api.ngrok.com/abuse_reports -``` diff --git a/docs/api/examples/_abuse_reports_create_response.md b/docs/api/examples/_abuse_reports_create_response.md deleted file mode 100644 index 49d09115f4..0000000000 --- a/docs/api/examples/_abuse_reports_create_response.md +++ /dev/null @@ -1,20 +0,0 @@ - - -#### Example Response - -```json -{ - "created_at": "2025-01-14T10:06:42Z", - "hostnames": [ - { - "hostname": "legit-facebook-login.ngrok.io", - "status": "PENDING" - } - ], - "id": "abrp_2rcCuzWvsTkicfE6OIjydvsig4C", - "metadata": "{\"incident_id\":1233122}", - "status": "PENDING", - "uri": "https://api.ngrok.com/abuse_reports/abrp_2rcCuzWvsTkicfE6OIjydvsig4C", - "urls": ["http://legit-facebook-login.ngrok.io/login"] -} -``` diff --git a/docs/api/examples/_abuse_reports_get_request.md b/docs/api/examples/_abuse_reports_get_request.md deleted file mode 100644 index 8aa99c0977..0000000000 --- a/docs/api/examples/_abuse_reports_get_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/abuse_reports/abrp_2rcCuzWvsTkicfE6OIjydvsig4C -``` diff --git a/docs/api/examples/_abuse_reports_get_response.md b/docs/api/examples/_abuse_reports_get_response.md deleted file mode 100644 index 49d09115f4..0000000000 --- a/docs/api/examples/_abuse_reports_get_response.md +++ /dev/null @@ -1,20 +0,0 @@ - - -#### Example Response - -```json -{ - "created_at": "2025-01-14T10:06:42Z", - "hostnames": [ - { - "hostname": "legit-facebook-login.ngrok.io", - "status": "PENDING" - } - ], - "id": "abrp_2rcCuzWvsTkicfE6OIjydvsig4C", - "metadata": "{\"incident_id\":1233122}", - "status": "PENDING", - "uri": "https://api.ngrok.com/abuse_reports/abrp_2rcCuzWvsTkicfE6OIjydvsig4C", - "urls": ["http://legit-facebook-login.ngrok.io/login"] -} -``` diff --git a/docs/api/examples/_agent_ingresses_create_request.md b/docs/api/examples/_agent_ingresses_create_request.md deleted file mode 100644 index 99122ffea5..0000000000 --- a/docs/api/examples/_agent_ingresses_create_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X POST \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"description":"acme devices","domain":"connect.acme.com"}' \ -https://api.ngrok.com/agent_ingresses -``` diff --git a/docs/api/examples/_agent_ingresses_create_response.md b/docs/api/examples/_agent_ingresses_create_response.md deleted file mode 100644 index 1033e9ebb5..0000000000 --- a/docs/api/examples/_agent_ingresses_create_response.md +++ /dev/null @@ -1,22 +0,0 @@ - - -#### Example Response - -```json -{ - "certificate_management_policy": null, - "certificate_management_status": null, - "created_at": "2025-01-14T10:06:43Z", - "description": "acme devices", - "domain": "connect.acme.com", - "id": "agin_2rcCv7Y5zd3kAkFFDZAftd060kl", - "ns_targets": [ - "1.kube-dns.kube-system.svc.cluster.local.", - "2.kube-dns.kube-system.svc.cluster.local.", - "3.kube-dns.kube-system.svc.cluster.local.", - "4.kube-dns.kube-system.svc.cluster.local." - ], - "region_domains": ["tunnel.us.connect.acme.com"], - "uri": "/agent_ingresses/agin_2rcCv7Y5zd3kAkFFDZAftd060kl" -} -``` diff --git a/docs/api/examples/_agent_ingresses_delete_request.md b/docs/api/examples/_agent_ingresses_delete_request.md deleted file mode 100644 index d139f19f4d..0000000000 --- a/docs/api/examples/_agent_ingresses_delete_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X DELETE \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/agent_ingresses/agin_2rcCv7Y5zd3kAkFFDZAftd060kl -``` diff --git a/docs/api/examples/_agent_ingresses_delete_response.md b/docs/api/examples/_agent_ingresses_delete_response.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/api/examples/_agent_ingresses_get_request.md b/docs/api/examples/_agent_ingresses_get_request.md deleted file mode 100644 index 67bc9f5212..0000000000 --- a/docs/api/examples/_agent_ingresses_get_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/agent_ingresses/agin_2rcCv7Y5zd3kAkFFDZAftd060kl -``` diff --git a/docs/api/examples/_agent_ingresses_get_response.md b/docs/api/examples/_agent_ingresses_get_response.md deleted file mode 100644 index e3447241ca..0000000000 --- a/docs/api/examples/_agent_ingresses_get_response.md +++ /dev/null @@ -1,23 +0,0 @@ - - -#### Example Response - -```json -{ - "certificate_management_policy": null, - "certificate_management_status": null, - "created_at": "2025-01-14T10:06:43Z", - "description": "ACME Co. Device Ingress", - "domain": "connect.acme.com", - "id": "agin_2rcCv7Y5zd3kAkFFDZAftd060kl", - "metadata": "{\"device_sku\": \"824JS4RZ1F8X\"}", - "ns_targets": [ - "1.kube-dns.kube-system.svc.cluster.local.", - "2.kube-dns.kube-system.svc.cluster.local.", - "3.kube-dns.kube-system.svc.cluster.local.", - "4.kube-dns.kube-system.svc.cluster.local." - ], - "region_domains": ["tunnel.us.connect.acme.com"], - "uri": "/agent_ingresses/agin_2rcCv7Y5zd3kAkFFDZAftd060kl" -} -``` diff --git a/docs/api/examples/_agent_ingresses_list_request.md b/docs/api/examples/_agent_ingresses_list_request.md deleted file mode 100644 index 7c39bcd63a..0000000000 --- a/docs/api/examples/_agent_ingresses_list_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/agent_ingresses -``` diff --git a/docs/api/examples/_agent_ingresses_list_response.md b/docs/api/examples/_agent_ingresses_list_response.md deleted file mode 100644 index 90d92f3a94..0000000000 --- a/docs/api/examples/_agent_ingresses_list_response.md +++ /dev/null @@ -1,28 +0,0 @@ - - -#### Example Response - -```json -{ - "ingresses": [ - { - "certificate_management_policy": null, - "certificate_management_status": null, - "created_at": "2025-01-14T10:06:43Z", - "description": "acme devices", - "domain": "connect.acme.com", - "id": "agin_2rcCv7Y5zd3kAkFFDZAftd060kl", - "ns_targets": [ - "1.kube-dns.kube-system.svc.cluster.local.", - "2.kube-dns.kube-system.svc.cluster.local.", - "3.kube-dns.kube-system.svc.cluster.local.", - "4.kube-dns.kube-system.svc.cluster.local." - ], - "region_domains": ["tunnel.us.connect.acme.com"], - "uri": "/agent_ingresses/agin_2rcCv7Y5zd3kAkFFDZAftd060kl" - } - ], - "next_page_uri": null, - "uri": "https://api.ngrok.com/agent_ingresses" -} -``` diff --git a/docs/api/examples/_agent_ingresses_update_request.md b/docs/api/examples/_agent_ingresses_update_request.md deleted file mode 100644 index b8481fab17..0000000000 --- a/docs/api/examples/_agent_ingresses_update_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X PATCH \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"description":"ACME Co. Device Ingress","metadata":"{\"device_sku\": \"824JS4RZ1F8X\"}"}' \ -https://api.ngrok.com/agent_ingresses/agin_2rcCv7Y5zd3kAkFFDZAftd060kl -``` diff --git a/docs/api/examples/_agent_ingresses_update_response.md b/docs/api/examples/_agent_ingresses_update_response.md deleted file mode 100644 index e3447241ca..0000000000 --- a/docs/api/examples/_agent_ingresses_update_response.md +++ /dev/null @@ -1,23 +0,0 @@ - - -#### Example Response - -```json -{ - "certificate_management_policy": null, - "certificate_management_status": null, - "created_at": "2025-01-14T10:06:43Z", - "description": "ACME Co. Device Ingress", - "domain": "connect.acme.com", - "id": "agin_2rcCv7Y5zd3kAkFFDZAftd060kl", - "metadata": "{\"device_sku\": \"824JS4RZ1F8X\"}", - "ns_targets": [ - "1.kube-dns.kube-system.svc.cluster.local.", - "2.kube-dns.kube-system.svc.cluster.local.", - "3.kube-dns.kube-system.svc.cluster.local.", - "4.kube-dns.kube-system.svc.cluster.local." - ], - "region_domains": ["tunnel.us.connect.acme.com"], - "uri": "/agent_ingresses/agin_2rcCv7Y5zd3kAkFFDZAftd060kl" -} -``` diff --git a/docs/api/examples/_api_keys_create_request.md b/docs/api/examples/_api_keys_create_request.md deleted file mode 100644 index 6c604e6cec..0000000000 --- a/docs/api/examples/_api_keys_create_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X POST \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"description":"ad-hoc dev testing","metadata":"{\"environment\":\"dev\"}"}' \ -https://api.ngrok.com/api_keys -``` diff --git a/docs/api/examples/_api_keys_create_response.md b/docs/api/examples/_api_keys_create_response.md deleted file mode 100644 index ee448b533f..0000000000 --- a/docs/api/examples/_api_keys_create_response.md +++ /dev/null @@ -1,15 +0,0 @@ - - -#### Example Response - -```json -{ - "created_at": "2025-01-14T10:06:19Z", - "description": "ad-hoc dev testing", - "id": "ak_2rcCs463JRq4Oijunt8pKQzWpPU", - "metadata": "{\"environment\":\"dev\"}", - "owner_id": "usr_2rcCs3aBfA01H0kq4OxydHqoED0", - "token": "2rcCs463JRq4Oijunt8pKQzWpPU_4X9PevutESkPtGEYC4tR8", - "uri": "https://api.ngrok.com/api_keys/ak_2rcCs463JRq4Oijunt8pKQzWpPU" -} -``` diff --git a/docs/api/examples/_api_keys_delete_request.md b/docs/api/examples/_api_keys_delete_request.md deleted file mode 100644 index 4da6f88805..0000000000 --- a/docs/api/examples/_api_keys_delete_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X DELETE \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/api_keys/ak_2rcCs463JRq4Oijunt8pKQzWpPU -``` diff --git a/docs/api/examples/_api_keys_delete_response.md b/docs/api/examples/_api_keys_delete_response.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/api/examples/_api_keys_get_request.md b/docs/api/examples/_api_keys_get_request.md deleted file mode 100644 index 874397786a..0000000000 --- a/docs/api/examples/_api_keys_get_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/api_keys/ak_2rcCs463JRq4Oijunt8pKQzWpPU -``` diff --git a/docs/api/examples/_api_keys_get_response.md b/docs/api/examples/_api_keys_get_response.md deleted file mode 100644 index 665c8e8ba6..0000000000 --- a/docs/api/examples/_api_keys_get_response.md +++ /dev/null @@ -1,15 +0,0 @@ - - -#### Example Response - -```json -{ - "created_at": "2025-01-14T10:06:19Z", - "description": "ad-hoc dev testing", - "id": "ak_2rcCs463JRq4Oijunt8pKQzWpPU", - "metadata": "{\"environment\":\"dev\", \"owner_id\": 123}", - "owner_id": "usr_2rcCs3aBfA01H0kq4OxydHqoED0", - "token": null, - "uri": "https://api.ngrok.com/api_keys/ak_2rcCs463JRq4Oijunt8pKQzWpPU" -} -``` diff --git a/docs/api/examples/_api_keys_list_request.md b/docs/api/examples/_api_keys_list_request.md deleted file mode 100644 index 665a50fb35..0000000000 --- a/docs/api/examples/_api_keys_list_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/api_keys -``` diff --git a/docs/api/examples/_api_keys_list_response.md b/docs/api/examples/_api_keys_list_response.md deleted file mode 100644 index fbce562ff6..0000000000 --- a/docs/api/examples/_api_keys_list_response.md +++ /dev/null @@ -1,29 +0,0 @@ - - -#### Example Response - -```json -{ - "keys": [ - { - "created_at": "2025-01-14T10:06:19Z", - "description": "ad-hoc dev testing", - "id": "ak_2rcCs463JRq4Oijunt8pKQzWpPU", - "metadata": "{\"environment\":\"dev\"}", - "owner_id": "usr_2rcCs3aBfA01H0kq4OxydHqoED0", - "token": null, - "uri": "https://api.ngrok.com/api_keys/ak_2rcCs463JRq4Oijunt8pKQzWpPU" - }, - { - "created_at": "2025-01-14T10:06:19Z", - "description": "api key for example generation", - "id": "ak_2rcCs97dFyv42ODMsLW4ypnRtP1", - "owner_id": "usr_2rcCs3aBfA01H0kq4OxydHqoED0", - "token": null, - "uri": "https://api.ngrok.com/api_keys/ak_2rcCs97dFyv42ODMsLW4ypnRtP1" - } - ], - "next_page_uri": null, - "uri": "https://api.ngrok.com/api_keys" -} -``` diff --git a/docs/api/examples/_api_keys_update_request.md b/docs/api/examples/_api_keys_update_request.md deleted file mode 100644 index d8b6d06296..0000000000 --- a/docs/api/examples/_api_keys_update_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X PATCH \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"metadata":"{\"environment\":\"dev\", \"owner_id\": 123}"}' \ -https://api.ngrok.com/api_keys/ak_2rcCs463JRq4Oijunt8pKQzWpPU -``` diff --git a/docs/api/examples/_api_keys_update_response.md b/docs/api/examples/_api_keys_update_response.md deleted file mode 100644 index 665c8e8ba6..0000000000 --- a/docs/api/examples/_api_keys_update_response.md +++ /dev/null @@ -1,15 +0,0 @@ - - -#### Example Response - -```json -{ - "created_at": "2025-01-14T10:06:19Z", - "description": "ad-hoc dev testing", - "id": "ak_2rcCs463JRq4Oijunt8pKQzWpPU", - "metadata": "{\"environment\":\"dev\", \"owner_id\": 123}", - "owner_id": "usr_2rcCs3aBfA01H0kq4OxydHqoED0", - "token": null, - "uri": "https://api.ngrok.com/api_keys/ak_2rcCs463JRq4Oijunt8pKQzWpPU" -} -``` diff --git a/docs/api/examples/_bot_users_create_request.md b/docs/api/examples/_bot_users_create_request.md deleted file mode 100644 index d4264a0cc2..0000000000 --- a/docs/api/examples/_bot_users_create_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X POST \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"name":"new bot user from API"}' \ -https://api.ngrok.com/bot_users -``` diff --git a/docs/api/examples/_bot_users_create_response.md b/docs/api/examples/_bot_users_create_response.md deleted file mode 100644 index 2e92dc7924..0000000000 --- a/docs/api/examples/_bot_users_create_response.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Response - -```json -{ - "active": true, - "created_at": "2025-01-14T10:06:48Z", - "id": "bot_2rcCvh0pkLnQTRl8DHbT8tuwHfy", - "name": "new bot user from API", - "uri": "https://api.ngrok.com/bot_users/bot_2rcCvh0pkLnQTRl8DHbT8tuwHfy" -} -``` diff --git a/docs/api/examples/_bot_users_delete_request.md b/docs/api/examples/_bot_users_delete_request.md deleted file mode 100644 index 4616cf6c7d..0000000000 --- a/docs/api/examples/_bot_users_delete_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X DELETE \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/bot_users/bot_2rcCvh0pkLnQTRl8DHbT8tuwHfy -``` diff --git a/docs/api/examples/_bot_users_delete_response.md b/docs/api/examples/_bot_users_delete_response.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/api/examples/_bot_users_get_request.md b/docs/api/examples/_bot_users_get_request.md deleted file mode 100644 index 7479703848..0000000000 --- a/docs/api/examples/_bot_users_get_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/bot_users/bot_2rcCvh0pkLnQTRl8DHbT8tuwHfy -``` diff --git a/docs/api/examples/_bot_users_get_response.md b/docs/api/examples/_bot_users_get_response.md deleted file mode 100644 index 2e92dc7924..0000000000 --- a/docs/api/examples/_bot_users_get_response.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Response - -```json -{ - "active": true, - "created_at": "2025-01-14T10:06:48Z", - "id": "bot_2rcCvh0pkLnQTRl8DHbT8tuwHfy", - "name": "new bot user from API", - "uri": "https://api.ngrok.com/bot_users/bot_2rcCvh0pkLnQTRl8DHbT8tuwHfy" -} -``` diff --git a/docs/api/examples/_bot_users_list_request.md b/docs/api/examples/_bot_users_list_request.md deleted file mode 100644 index 135c97a4c2..0000000000 --- a/docs/api/examples/_bot_users_list_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/bot_users?limit=1 -``` diff --git a/docs/api/examples/_bot_users_list_response.md b/docs/api/examples/_bot_users_list_response.md deleted file mode 100644 index b04a3ddc68..0000000000 --- a/docs/api/examples/_bot_users_list_response.md +++ /dev/null @@ -1,19 +0,0 @@ - - -#### Example Response - -```json -{ - "bot_users": [ - { - "active": true, - "created_at": "2025-01-14T10:06:48Z", - "id": "bot_2rcCvhOdyUszX5X67ShvUHlQVrq", - "name": "API example bot user", - "uri": "https://api.ngrok.com/bot_users/bot_2rcCvhOdyUszX5X67ShvUHlQVrq" - } - ], - "next_page_uri": "https://api.ngrok.com/bot_users?before_id=bot_2rcCvhOdyUszX5X67ShvUHlQVrq&limit=1", - "uri": "https://api.ngrok.com/bot_users" -} -``` diff --git a/docs/api/examples/_bot_users_update_request.md b/docs/api/examples/_bot_users_update_request.md deleted file mode 100644 index b90de59535..0000000000 --- a/docs/api/examples/_bot_users_update_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X PATCH \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"active":false,"name":"inactive bot user from API"}' \ -https://api.ngrok.com/bot_users/bot_2rcCvh0pkLnQTRl8DHbT8tuwHfy -``` diff --git a/docs/api/examples/_bot_users_update_response.md b/docs/api/examples/_bot_users_update_response.md deleted file mode 100644 index 4f3095e2b5..0000000000 --- a/docs/api/examples/_bot_users_update_response.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Response - -```json -{ - "active": false, - "created_at": "2025-01-14T10:06:48Z", - "id": "bot_2rcCvh0pkLnQTRl8DHbT8tuwHfy", - "name": "inactive bot user from API", - "uri": "https://api.ngrok.com/bot_users/bot_2rcCvh0pkLnQTRl8DHbT8tuwHfy" -} -``` diff --git a/docs/api/examples/_certificate_authorities_create_request.md b/docs/api/examples/_certificate_authorities_create_request.md deleted file mode 100644 index 84927b33e4..0000000000 --- a/docs/api/examples/_certificate_authorities_create_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X POST \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"ca_pem":"-----BEGIN CERTIFICATE-----\nMIIEETCCAvmgAwIBAgIUU3N6lNzPqar4400cLQMcVHFl+mEwDQYJKoZIhvcNAQEL\nBQAwgZcxCzAJBgNVBAYTAkFVMQwwCgYDVQQIDANOU1cxDzANBgNVBAcMBlN5ZG5l\neTEZMBcGA1UECgwQRHJvcGJlYXIgUHR5IEx0ZDEkMCIGA1UEAwwbSW50cmFuZXQg\nU2VydmljZXMgQXV0aG9yaXR5MSgwJgYJKoZIhvcNAQkBFhlzZWN1cml0eUBkcm9w\nYmVhci5leGFtcGxlMB4XDTIwMDUwMTE2Mjc1OVoXDTIxMDUwMTE2Mjc1OVowgZcx\nCzAJBgNVBAYTAkFVMQwwCgYDVQQIDANOU1cxDzANBgNVBAcMBlN5ZG5leTEZMBcG\nA1UECgwQRHJvcGJlYXIgUHR5IEx0ZDEkMCIGA1UEAwwbSW50cmFuZXQgU2Vydmlj\nZXMgQXV0aG9yaXR5MSgwJgYJKoZIhvcNAQkBFhlzZWN1cml0eUBkcm9wYmVhci5l\neGFtcGxlMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA7y/EAN0yZkA0\nnRpMBfomnnS8KMWHb90kvGfhkCDR8WCQz5mX7eDEYDthRQrEgp63qtJ7IoCM5f0A\nUD6J2m/mZecP7SfA8OuTAZ7UyRixpZh0zJQSgj24Sh1LQuYci0DNXrei+R1qBvd+\npmpZwkKygNrbZYe3oY1PZ3jEYPSAQzIObDF7LhdhLLrcfWa9BHOGMLnALNMY558b\nvoijTCEmRrSavdvrAS9LDRipEXT8EQOWZZT9VbPtgSBalvStdoupAptmPIWjXftf\nWi1kry+P0xVFZG9iZwUeAT6fSJ+gJD8M1UXWaQbocYrctESP0sZEFM3rzdWqrZb7\n3cH3K5OCvwIDAQABo1MwUTAdBgNVHQ4EFgQUsZdchgUimRHLiPRWw51+DGBmlfMw\nHwYDVR0jBBgwFoAUsZdchgUimRHLiPRWw51+DGBmlfMwDwYDVR0TAQH/BAUwAwEB\n/zANBgkqhkiG9w0BAQsFAAOCAQEANk25tt8sSfn6Qu1bbhWRbjKgS5z+j9LqyCna\nv3fbSchMthaQR7w0vL69ayroeYdqDZkRMmHjuYKY4NyqyXkkaqVO63wEicCo55d9\npIKuPzc/7xwdRephosjGTQ4QaQ4OnrdpJZieI92m9ODexgsab84AYmwNpbGOI/tK\nnPsQr8x1RfLs2gbBwQ4MYVM3tQQbX0o+yve5nz/NCOq4vdG+eKON5u6VYMkOOg9F\nVyNY1iISQkpNk/AF6Vi9BGuDb5Hg0phEl1Q0ntCO7ZHAUHjy0ucqXZiXoXdXZcs3\n3zKKLUKva59EDBZ5TUucvXh8VemBtNc6hd1mX4Tq7lAreG9pjQ==\n-----END CERTIFICATE-----","description":"Internal Coprorates Services Authority","metadata":"{\"internal_id\": \"7d2caeee-cdc3-4b26-b2c2-b280b8287552\"}"}' \ -https://api.ngrok.com/certificate_authorities -``` diff --git a/docs/api/examples/_certificate_authorities_create_response.md b/docs/api/examples/_certificate_authorities_create_response.md deleted file mode 100644 index e643296e8c..0000000000 --- a/docs/api/examples/_certificate_authorities_create_response.md +++ /dev/null @@ -1,19 +0,0 @@ - - -#### Example Response - -```json -{ - "ca_pem": "-----BEGIN CERTIFICATE-----\nMIIEETCCAvmgAwIBAgIUU3N6lNzPqar4400cLQMcVHFl+mEwDQYJKoZIhvcNAQEL\nBQAwgZcxCzAJBgNVBAYTAkFVMQwwCgYDVQQIDANOU1cxDzANBgNVBAcMBlN5ZG5l\neTEZMBcGA1UECgwQRHJvcGJlYXIgUHR5IEx0ZDEkMCIGA1UEAwwbSW50cmFuZXQg\nU2VydmljZXMgQXV0aG9yaXR5MSgwJgYJKoZIhvcNAQkBFhlzZWN1cml0eUBkcm9w\nYmVhci5leGFtcGxlMB4XDTIwMDUwMTE2Mjc1OVoXDTIxMDUwMTE2Mjc1OVowgZcx\nCzAJBgNVBAYTAkFVMQwwCgYDVQQIDANOU1cxDzANBgNVBAcMBlN5ZG5leTEZMBcG\nA1UECgwQRHJvcGJlYXIgUHR5IEx0ZDEkMCIGA1UEAwwbSW50cmFuZXQgU2Vydmlj\nZXMgQXV0aG9yaXR5MSgwJgYJKoZIhvcNAQkBFhlzZWN1cml0eUBkcm9wYmVhci5l\neGFtcGxlMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA7y/EAN0yZkA0\nnRpMBfomnnS8KMWHb90kvGfhkCDR8WCQz5mX7eDEYDthRQrEgp63qtJ7IoCM5f0A\nUD6J2m/mZecP7SfA8OuTAZ7UyRixpZh0zJQSgj24Sh1LQuYci0DNXrei+R1qBvd+\npmpZwkKygNrbZYe3oY1PZ3jEYPSAQzIObDF7LhdhLLrcfWa9BHOGMLnALNMY558b\nvoijTCEmRrSavdvrAS9LDRipEXT8EQOWZZT9VbPtgSBalvStdoupAptmPIWjXftf\nWi1kry+P0xVFZG9iZwUeAT6fSJ+gJD8M1UXWaQbocYrctESP0sZEFM3rzdWqrZb7\n3cH3K5OCvwIDAQABo1MwUTAdBgNVHQ4EFgQUsZdchgUimRHLiPRWw51+DGBmlfMw\nHwYDVR0jBBgwFoAUsZdchgUimRHLiPRWw51+DGBmlfMwDwYDVR0TAQH/BAUwAwEB\n/zANBgkqhkiG9w0BAQsFAAOCAQEANk25tt8sSfn6Qu1bbhWRbjKgS5z+j9LqyCna\nv3fbSchMthaQR7w0vL69ayroeYdqDZkRMmHjuYKY4NyqyXkkaqVO63wEicCo55d9\npIKuPzc/7xwdRephosjGTQ4QaQ4OnrdpJZieI92m9ODexgsab84AYmwNpbGOI/tK\nnPsQr8x1RfLs2gbBwQ4MYVM3tQQbX0o+yve5nz/NCOq4vdG+eKON5u6VYMkOOg9F\nVyNY1iISQkpNk/AF6Vi9BGuDb5Hg0phEl1Q0ntCO7ZHAUHjy0ucqXZiXoXdXZcs3\n3zKKLUKva59EDBZ5TUucvXh8VemBtNc6hd1mX4Tq7lAreG9pjQ==\n-----END CERTIFICATE-----\n", - "created_at": "2025-01-14T10:06:43Z", - "description": "Internal Coprorates Services Authority", - "extended_key_usages": [], - "id": "ca_2rcCv9uCz86TA3yIqpbrgiIRJnM", - "key_usages": [], - "metadata": "{\"internal_id\": \"7d2caeee-cdc3-4b26-b2c2-b280b8287552\"}", - "not_after": "2021-05-01T16:27:59Z", - "not_before": "2020-05-01T16:27:59Z", - "subject_common_name": "Intranet Services Authority", - "uri": "https://api.ngrok.com/certificate_authorities/ca_2rcCv9uCz86TA3yIqpbrgiIRJnM" -} -``` diff --git a/docs/api/examples/_certificate_authorities_delete_request.md b/docs/api/examples/_certificate_authorities_delete_request.md deleted file mode 100644 index 4c71f23dc3..0000000000 --- a/docs/api/examples/_certificate_authorities_delete_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X DELETE \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/certificate_authorities/ca_2rcCv9uCz86TA3yIqpbrgiIRJnM -``` diff --git a/docs/api/examples/_certificate_authorities_delete_response.md b/docs/api/examples/_certificate_authorities_delete_response.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/api/examples/_certificate_authorities_get_request.md b/docs/api/examples/_certificate_authorities_get_request.md deleted file mode 100644 index c50bf48821..0000000000 --- a/docs/api/examples/_certificate_authorities_get_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/certificate_authorities/ca_2rcCv9uCz86TA3yIqpbrgiIRJnM -``` diff --git a/docs/api/examples/_certificate_authorities_get_response.md b/docs/api/examples/_certificate_authorities_get_response.md deleted file mode 100644 index dc304f52c0..0000000000 --- a/docs/api/examples/_certificate_authorities_get_response.md +++ /dev/null @@ -1,19 +0,0 @@ - - -#### Example Response - -```json -{ - "ca_pem": "-----BEGIN CERTIFICATE-----\nMIIEETCCAvmgAwIBAgIUU3N6lNzPqar4400cLQMcVHFl+mEwDQYJKoZIhvcNAQEL\nBQAwgZcxCzAJBgNVBAYTAkFVMQwwCgYDVQQIDANOU1cxDzANBgNVBAcMBlN5ZG5l\neTEZMBcGA1UECgwQRHJvcGJlYXIgUHR5IEx0ZDEkMCIGA1UEAwwbSW50cmFuZXQg\nU2VydmljZXMgQXV0aG9yaXR5MSgwJgYJKoZIhvcNAQkBFhlzZWN1cml0eUBkcm9w\nYmVhci5leGFtcGxlMB4XDTIwMDUwMTE2Mjc1OVoXDTIxMDUwMTE2Mjc1OVowgZcx\nCzAJBgNVBAYTAkFVMQwwCgYDVQQIDANOU1cxDzANBgNVBAcMBlN5ZG5leTEZMBcG\nA1UECgwQRHJvcGJlYXIgUHR5IEx0ZDEkMCIGA1UEAwwbSW50cmFuZXQgU2Vydmlj\nZXMgQXV0aG9yaXR5MSgwJgYJKoZIhvcNAQkBFhlzZWN1cml0eUBkcm9wYmVhci5l\neGFtcGxlMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA7y/EAN0yZkA0\nnRpMBfomnnS8KMWHb90kvGfhkCDR8WCQz5mX7eDEYDthRQrEgp63qtJ7IoCM5f0A\nUD6J2m/mZecP7SfA8OuTAZ7UyRixpZh0zJQSgj24Sh1LQuYci0DNXrei+R1qBvd+\npmpZwkKygNrbZYe3oY1PZ3jEYPSAQzIObDF7LhdhLLrcfWa9BHOGMLnALNMY558b\nvoijTCEmRrSavdvrAS9LDRipEXT8EQOWZZT9VbPtgSBalvStdoupAptmPIWjXftf\nWi1kry+P0xVFZG9iZwUeAT6fSJ+gJD8M1UXWaQbocYrctESP0sZEFM3rzdWqrZb7\n3cH3K5OCvwIDAQABo1MwUTAdBgNVHQ4EFgQUsZdchgUimRHLiPRWw51+DGBmlfMw\nHwYDVR0jBBgwFoAUsZdchgUimRHLiPRWw51+DGBmlfMwDwYDVR0TAQH/BAUwAwEB\n/zANBgkqhkiG9w0BAQsFAAOCAQEANk25tt8sSfn6Qu1bbhWRbjKgS5z+j9LqyCna\nv3fbSchMthaQR7w0vL69ayroeYdqDZkRMmHjuYKY4NyqyXkkaqVO63wEicCo55d9\npIKuPzc/7xwdRephosjGTQ4QaQ4OnrdpJZieI92m9ODexgsab84AYmwNpbGOI/tK\nnPsQr8x1RfLs2gbBwQ4MYVM3tQQbX0o+yve5nz/NCOq4vdG+eKON5u6VYMkOOg9F\nVyNY1iISQkpNk/AF6Vi9BGuDb5Hg0phEl1Q0ntCO7ZHAUHjy0ucqXZiXoXdXZcs3\n3zKKLUKva59EDBZ5TUucvXh8VemBtNc6hd1mX4Tq7lAreG9pjQ==\n-----END CERTIFICATE-----\n", - "created_at": "2025-01-14T10:06:43Z", - "description": "Internal Corporate Services Authority (Legacy)", - "extended_key_usages": [], - "id": "ca_2rcCv9uCz86TA3yIqpbrgiIRJnM", - "key_usages": [], - "metadata": "{\"internal_id\": \"7d2caeee-cdc3-4b26-b2c2-b280b8287552\"}", - "not_after": "2021-05-01T16:27:59Z", - "not_before": "2020-05-01T16:27:59Z", - "subject_common_name": "Intranet Services Authority", - "uri": "https://api.ngrok.com/certificate_authorities/ca_2rcCv9uCz86TA3yIqpbrgiIRJnM" -} -``` diff --git a/docs/api/examples/_certificate_authorities_list_request.md b/docs/api/examples/_certificate_authorities_list_request.md deleted file mode 100644 index fdc4967dbf..0000000000 --- a/docs/api/examples/_certificate_authorities_list_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/certificate_authorities -``` diff --git a/docs/api/examples/_certificate_authorities_list_response.md b/docs/api/examples/_certificate_authorities_list_response.md deleted file mode 100644 index 21e2770748..0000000000 --- a/docs/api/examples/_certificate_authorities_list_response.md +++ /dev/null @@ -1,48 +0,0 @@ - - -#### Example Response - -```json -{ - "certificate_authorities": [ - { - "ca_pem": "-----BEGIN CERTIFICATE-----\nMIIEETCCAvmgAwIBAgIUU3N6lNzPqar4400cLQMcVHFl+mEwDQYJKoZIhvcNAQEL\nBQAwgZcxCzAJBgNVBAYTAkFVMQwwCgYDVQQIDANOU1cxDzANBgNVBAcMBlN5ZG5l\neTEZMBcGA1UECgwQRHJvcGJlYXIgUHR5IEx0ZDEkMCIGA1UEAwwbSW50cmFuZXQg\nU2VydmljZXMgQXV0aG9yaXR5MSgwJgYJKoZIhvcNAQkBFhlzZWN1cml0eUBkcm9w\nYmVhci5leGFtcGxlMB4XDTIwMDUwMTE2Mjc1OVoXDTIxMDUwMTE2Mjc1OVowgZcx\nCzAJBgNVBAYTAkFVMQwwCgYDVQQIDANOU1cxDzANBgNVBAcMBlN5ZG5leTEZMBcG\nA1UECgwQRHJvcGJlYXIgUHR5IEx0ZDEkMCIGA1UEAwwbSW50cmFuZXQgU2Vydmlj\nZXMgQXV0aG9yaXR5MSgwJgYJKoZIhvcNAQkBFhlzZWN1cml0eUBkcm9wYmVhci5l\neGFtcGxlMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA7y/EAN0yZkA0\nnRpMBfomnnS8KMWHb90kvGfhkCDR8WCQz5mX7eDEYDthRQrEgp63qtJ7IoCM5f0A\nUD6J2m/mZecP7SfA8OuTAZ7UyRixpZh0zJQSgj24Sh1LQuYci0DNXrei+R1qBvd+\npmpZwkKygNrbZYe3oY1PZ3jEYPSAQzIObDF7LhdhLLrcfWa9BHOGMLnALNMY558b\nvoijTCEmRrSavdvrAS9LDRipEXT8EQOWZZT9VbPtgSBalvStdoupAptmPIWjXftf\nWi1kry+P0xVFZG9iZwUeAT6fSJ+gJD8M1UXWaQbocYrctESP0sZEFM3rzdWqrZb7\n3cH3K5OCvwIDAQABo1MwUTAdBgNVHQ4EFgQUsZdchgUimRHLiPRWw51+DGBmlfMw\nHwYDVR0jBBgwFoAUsZdchgUimRHLiPRWw51+DGBmlfMwDwYDVR0TAQH/BAUwAwEB\n/zANBgkqhkiG9w0BAQsFAAOCAQEANk25tt8sSfn6Qu1bbhWRbjKgS5z+j9LqyCna\nv3fbSchMthaQR7w0vL69ayroeYdqDZkRMmHjuYKY4NyqyXkkaqVO63wEicCo55d9\npIKuPzc/7xwdRephosjGTQ4QaQ4OnrdpJZieI92m9ODexgsab84AYmwNpbGOI/tK\nnPsQr8x1RfLs2gbBwQ4MYVM3tQQbX0o+yve5nz/NCOq4vdG+eKON5u6VYMkOOg9F\nVyNY1iISQkpNk/AF6Vi9BGuDb5Hg0phEl1Q0ntCO7ZHAUHjy0ucqXZiXoXdXZcs3\n3zKKLUKva59EDBZ5TUucvXh8VemBtNc6hd1mX4Tq7lAreG9pjQ==\n-----END CERTIFICATE-----\n", - "created_at": "2025-01-14T10:06:43Z", - "description": "Internal Coprorates Services Authority", - "extended_key_usages": [], - "id": "ca_2rcCv9uCz86TA3yIqpbrgiIRJnM", - "key_usages": [], - "metadata": "{\"internal_id\": \"7d2caeee-cdc3-4b26-b2c2-b280b8287552\"}", - "not_after": "2021-05-01T16:27:59Z", - "not_before": "2020-05-01T16:27:59Z", - "subject_common_name": "Intranet Services Authority", - "uri": "https://api.ngrok.com/certificate_authorities/ca_2rcCv9uCz86TA3yIqpbrgiIRJnM" - }, - { - "ca_pem": "-----BEGIN CERTIFICATE-----\nMIIEAzCCAuugAwIBAgIUGN+Gv4BdJ17VoVXWrz9j51jcfYowDQYJKoZIhvcNAQEL\nBQAwgZAxCzAJBgNVBAYTAlVTMRMwEQYDVQQIDApDYWxpZm9ybmlhMRYwFAYDVQQH\nDA1TYW4gRnJhbmNpc2NvMRMwEQYDVQQKDApBQ01FLCBJbmMuMR4wHAYDVQQDDBVB\nQ01FIERldmljZSBBdXRob3JpdHkxHzAdBgkqhkiG9w0BCQEWEG9wc0BhY21lLmV4\nYW1wbGUwHhcNMjAwNTAxMTYyNTA5WhcNMjEwNTAxMTYyNTA5WjCBkDELMAkGA1UE\nBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWExFjAUBgNVBAcMDVNhbiBGcmFuY2lz\nY28xEzARBgNVBAoMCkFDTUUsIEluYy4xHjAcBgNVBAMMFUFDTUUgRGV2aWNlIEF1\ndGhvcml0eTEfMB0GCSqGSIb3DQEJARYQb3BzQGFjbWUuZXhhbXBsZTCCASIwDQYJ\nKoZIhvcNAQEBBQADggEPADCCAQoCggEBAO8vxADdMmZANJ0aTAX6Jp50vCjFh2/d\nJLxn4ZAg0fFgkM+Zl+3gxGA7YUUKxIKet6rSeyKAjOX9AFA+idpv5mXnD+0nwPDr\nkwGe1MkYsaWYdMyUEoI9uEodS0LmHItAzV63ovkdagb3fqZqWcJCsoDa22WHt6GN\nT2d4xGD0gEMyDmwxey4XYSy63H1mvQRzhjC5wCzTGOefG76Io0whJka0mr3b6wEv\nSw0YqRF0/BEDlmWU/VWz7YEgWpb0rXaLqQKbZjyFo137X1otZK8vj9MVRWRvYmcF\nHgE+n0ifoCQ/DNVF1mkG6HGK3LREj9LGRBTN683Vqq2W+93B9yuTgr8CAwEAAaNT\nMFEwHQYDVR0OBBYEFLGXXIYFIpkRy4j0VsOdfgxgZpXzMB8GA1UdIwQYMBaAFLGX\nXIYFIpkRy4j0VsOdfgxgZpXzMA8GA1UdEwEB/wQFMAMBAf8wDQYJKoZIhvcNAQEL\nBQADggEBAFyO7ZWj9w6xzoBWu/XbIVwsQ3kE5k+wrRGyp2rh2v4msAEveCIZP5kT\nCSdr2vr+9HQYiKf1ftsp9tGTLXwrhz3ztC8jIqo4A0grw5B61J0lj+2grKNq1/CK\nxQcpkbnetzo4zsDqFRoN2VK40Ovo4b/IknFa38t06b4t8cYQIqUdkFHMSSIz3Mvx\nRIK6MZlilT8zkWhi9kfCJe/s3cVEAJixNkgO4XNo5VhhxFenyvAL2vDM27dWVtDG\nqL3MFZbcy0/74AJsJDSrflGUQxjrK3WI9PkpKp/xey54XJAbhF63z1VwkJwSwufv\nW9HgidfMN9icgxkScyWpB9KrZHcsLk4=\n-----END CERTIFICATE-----\n", - "created_at": "2025-01-14T10:06:43Z", - "description": "Device Connectivity Authority", - "extended_key_usages": [], - "id": "ca_2rcCv8OBSTrFBYfxOUff1CrtlVW", - "key_usages": [], - "not_after": "2021-05-01T16:25:09Z", - "not_before": "2020-05-01T16:25:09Z", - "subject_common_name": "ACME Device Authority", - "uri": "https://api.ngrok.com/certificate_authorities/ca_2rcCv8OBSTrFBYfxOUff1CrtlVW" - }, - { - "ca_pem": "-----BEGIN CERTIFICATE-----\nMIIEETCCAvmgAwIBAgIUU3N6lNzPqar4400cLQMcVHFl+mEwDQYJKoZIhvcNAQEL\nBQAwgZcxCzAJBgNVBAYTAkFVMQwwCgYDVQQIDANOU1cxDzANBgNVBAcMBlN5ZG5l\neTEZMBcGA1UECgwQRHJvcGJlYXIgUHR5IEx0ZDEkMCIGA1UEAwwbSW50cmFuZXQg\nU2VydmljZXMgQXV0aG9yaXR5MSgwJgYJKoZIhvcNAQkBFhlzZWN1cml0eUBkcm9w\nYmVhci5leGFtcGxlMB4XDTIwMDUwMTE2Mjc1OVoXDTIxMDUwMTE2Mjc1OVowgZcx\nCzAJBgNVBAYTAkFVMQwwCgYDVQQIDANOU1cxDzANBgNVBAcMBlN5ZG5leTEZMBcG\nA1UECgwQRHJvcGJlYXIgUHR5IEx0ZDEkMCIGA1UEAwwbSW50cmFuZXQgU2Vydmlj\nZXMgQXV0aG9yaXR5MSgwJgYJKoZIhvcNAQkBFhlzZWN1cml0eUBkcm9wYmVhci5l\neGFtcGxlMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA7y/EAN0yZkA0\nnRpMBfomnnS8KMWHb90kvGfhkCDR8WCQz5mX7eDEYDthRQrEgp63qtJ7IoCM5f0A\nUD6J2m/mZecP7SfA8OuTAZ7UyRixpZh0zJQSgj24Sh1LQuYci0DNXrei+R1qBvd+\npmpZwkKygNrbZYe3oY1PZ3jEYPSAQzIObDF7LhdhLLrcfWa9BHOGMLnALNMY558b\nvoijTCEmRrSavdvrAS9LDRipEXT8EQOWZZT9VbPtgSBalvStdoupAptmPIWjXftf\nWi1kry+P0xVFZG9iZwUeAT6fSJ+gJD8M1UXWaQbocYrctESP0sZEFM3rzdWqrZb7\n3cH3K5OCvwIDAQABo1MwUTAdBgNVHQ4EFgQUsZdchgUimRHLiPRWw51+DGBmlfMw\nHwYDVR0jBBgwFoAUsZdchgUimRHLiPRWw51+DGBmlfMwDwYDVR0TAQH/BAUwAwEB\n/zANBgkqhkiG9w0BAQsFAAOCAQEANk25tt8sSfn6Qu1bbhWRbjKgS5z+j9LqyCna\nv3fbSchMthaQR7w0vL69ayroeYdqDZkRMmHjuYKY4NyqyXkkaqVO63wEicCo55d9\npIKuPzc/7xwdRephosjGTQ4QaQ4OnrdpJZieI92m9ODexgsab84AYmwNpbGOI/tK\nnPsQr8x1RfLs2gbBwQ4MYVM3tQQbX0o+yve5nz/NCOq4vdG+eKON5u6VYMkOOg9F\nVyNY1iISQkpNk/AF6Vi9BGuDb5Hg0phEl1Q0ntCO7ZHAUHjy0ucqXZiXoXdXZcs3\n3zKKLUKva59EDBZ5TUucvXh8VemBtNc6hd1mX4Tq7lAreG9pjQ==\n-----END CERTIFICATE-----\n", - "created_at": "2025-01-14T10:06:42Z", - "extended_key_usages": [], - "id": "ca_2rcCv0cp1vuwkakfArouRMOyHBz", - "key_usages": [], - "not_after": "2021-05-01T16:27:59Z", - "not_before": "2020-05-01T16:27:59Z", - "subject_common_name": "Intranet Services Authority", - "uri": "https://api.ngrok.com/certificate_authorities/ca_2rcCv0cp1vuwkakfArouRMOyHBz" - } - ], - "next_page_uri": null, - "uri": "https://api.ngrok.com/certificate_authorities" -} -``` diff --git a/docs/api/examples/_certificate_authorities_update_request.md b/docs/api/examples/_certificate_authorities_update_request.md deleted file mode 100644 index 11a7897a55..0000000000 --- a/docs/api/examples/_certificate_authorities_update_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X PATCH \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"description":"Internal Corporate Services Authority (Legacy)"}' \ -https://api.ngrok.com/certificate_authorities/ca_2rcCv9uCz86TA3yIqpbrgiIRJnM -``` diff --git a/docs/api/examples/_certificate_authorities_update_response.md b/docs/api/examples/_certificate_authorities_update_response.md deleted file mode 100644 index dc304f52c0..0000000000 --- a/docs/api/examples/_certificate_authorities_update_response.md +++ /dev/null @@ -1,19 +0,0 @@ - - -#### Example Response - -```json -{ - "ca_pem": "-----BEGIN CERTIFICATE-----\nMIIEETCCAvmgAwIBAgIUU3N6lNzPqar4400cLQMcVHFl+mEwDQYJKoZIhvcNAQEL\nBQAwgZcxCzAJBgNVBAYTAkFVMQwwCgYDVQQIDANOU1cxDzANBgNVBAcMBlN5ZG5l\neTEZMBcGA1UECgwQRHJvcGJlYXIgUHR5IEx0ZDEkMCIGA1UEAwwbSW50cmFuZXQg\nU2VydmljZXMgQXV0aG9yaXR5MSgwJgYJKoZIhvcNAQkBFhlzZWN1cml0eUBkcm9w\nYmVhci5leGFtcGxlMB4XDTIwMDUwMTE2Mjc1OVoXDTIxMDUwMTE2Mjc1OVowgZcx\nCzAJBgNVBAYTAkFVMQwwCgYDVQQIDANOU1cxDzANBgNVBAcMBlN5ZG5leTEZMBcG\nA1UECgwQRHJvcGJlYXIgUHR5IEx0ZDEkMCIGA1UEAwwbSW50cmFuZXQgU2Vydmlj\nZXMgQXV0aG9yaXR5MSgwJgYJKoZIhvcNAQkBFhlzZWN1cml0eUBkcm9wYmVhci5l\neGFtcGxlMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA7y/EAN0yZkA0\nnRpMBfomnnS8KMWHb90kvGfhkCDR8WCQz5mX7eDEYDthRQrEgp63qtJ7IoCM5f0A\nUD6J2m/mZecP7SfA8OuTAZ7UyRixpZh0zJQSgj24Sh1LQuYci0DNXrei+R1qBvd+\npmpZwkKygNrbZYe3oY1PZ3jEYPSAQzIObDF7LhdhLLrcfWa9BHOGMLnALNMY558b\nvoijTCEmRrSavdvrAS9LDRipEXT8EQOWZZT9VbPtgSBalvStdoupAptmPIWjXftf\nWi1kry+P0xVFZG9iZwUeAT6fSJ+gJD8M1UXWaQbocYrctESP0sZEFM3rzdWqrZb7\n3cH3K5OCvwIDAQABo1MwUTAdBgNVHQ4EFgQUsZdchgUimRHLiPRWw51+DGBmlfMw\nHwYDVR0jBBgwFoAUsZdchgUimRHLiPRWw51+DGBmlfMwDwYDVR0TAQH/BAUwAwEB\n/zANBgkqhkiG9w0BAQsFAAOCAQEANk25tt8sSfn6Qu1bbhWRbjKgS5z+j9LqyCna\nv3fbSchMthaQR7w0vL69ayroeYdqDZkRMmHjuYKY4NyqyXkkaqVO63wEicCo55d9\npIKuPzc/7xwdRephosjGTQ4QaQ4OnrdpJZieI92m9ODexgsab84AYmwNpbGOI/tK\nnPsQr8x1RfLs2gbBwQ4MYVM3tQQbX0o+yve5nz/NCOq4vdG+eKON5u6VYMkOOg9F\nVyNY1iISQkpNk/AF6Vi9BGuDb5Hg0phEl1Q0ntCO7ZHAUHjy0ucqXZiXoXdXZcs3\n3zKKLUKva59EDBZ5TUucvXh8VemBtNc6hd1mX4Tq7lAreG9pjQ==\n-----END CERTIFICATE-----\n", - "created_at": "2025-01-14T10:06:43Z", - "description": "Internal Corporate Services Authority (Legacy)", - "extended_key_usages": [], - "id": "ca_2rcCv9uCz86TA3yIqpbrgiIRJnM", - "key_usages": [], - "metadata": "{\"internal_id\": \"7d2caeee-cdc3-4b26-b2c2-b280b8287552\"}", - "not_after": "2021-05-01T16:27:59Z", - "not_before": "2020-05-01T16:27:59Z", - "subject_common_name": "Intranet Services Authority", - "uri": "https://api.ngrok.com/certificate_authorities/ca_2rcCv9uCz86TA3yIqpbrgiIRJnM" -} -``` diff --git a/docs/api/examples/_credentials_create_request.md b/docs/api/examples/_credentials_create_request.md deleted file mode 100644 index 59da9c69d6..0000000000 --- a/docs/api/examples/_credentials_create_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X POST \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"description":"development cred for alan@example.com"}' \ -https://api.ngrok.com/credentials -``` diff --git a/docs/api/examples/_credentials_create_response.md b/docs/api/examples/_credentials_create_response.md deleted file mode 100644 index 02b6ab4ad0..0000000000 --- a/docs/api/examples/_credentials_create_response.md +++ /dev/null @@ -1,15 +0,0 @@ - - -#### Example Response - -```json -{ - "acl": [], - "created_at": "2025-01-14T10:06:20Z", - "description": "development cred for alan@example.com", - "id": "cr_2rcCsCY33MXfPgZls9m1PJZALh2", - "owner_id": "usr_2rcCs3aBfA01H0kq4OxydHqoED0", - "token": "2rcCsCY33MXfPgZls9m1PJZALh2_4tDNXLAi3sjvNne4KAyCs", - "uri": "https://api.ngrok.com/credentials/cr_2rcCsCY33MXfPgZls9m1PJZALh2" -} -``` diff --git a/docs/api/examples/_credentials_delete_request.md b/docs/api/examples/_credentials_delete_request.md deleted file mode 100644 index d94d498031..0000000000 --- a/docs/api/examples/_credentials_delete_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X DELETE \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/credentials/cr_2rcCsCY33MXfPgZls9m1PJZALh2 -``` diff --git a/docs/api/examples/_credentials_delete_response.md b/docs/api/examples/_credentials_delete_response.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/api/examples/_credentials_get_request.md b/docs/api/examples/_credentials_get_request.md deleted file mode 100644 index fb63a9bae8..0000000000 --- a/docs/api/examples/_credentials_get_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/credentials/cr_2rcCsCY33MXfPgZls9m1PJZALh2 -``` diff --git a/docs/api/examples/_credentials_get_response.md b/docs/api/examples/_credentials_get_response.md deleted file mode 100644 index 673336ed3f..0000000000 --- a/docs/api/examples/_credentials_get_response.md +++ /dev/null @@ -1,16 +0,0 @@ - - -#### Example Response - -```json -{ - "acl": [], - "created_at": "2025-01-14T10:06:20Z", - "description": "device alpha-2", - "id": "cr_2rcCsCY33MXfPgZls9m1PJZALh2", - "metadata": "{\"device_id\": \"d5111ba7-0cc5-4ba3-8398-e6c79e4e89c2\"}", - "owner_id": "usr_2rcCs3aBfA01H0kq4OxydHqoED0", - "token": null, - "uri": "https://api.ngrok.com/credentials/cr_2rcCsCY33MXfPgZls9m1PJZALh2" -} -``` diff --git a/docs/api/examples/_credentials_list_request.md b/docs/api/examples/_credentials_list_request.md deleted file mode 100644 index 9a1de7415f..0000000000 --- a/docs/api/examples/_credentials_list_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/credentials -``` diff --git a/docs/api/examples/_credentials_list_response.md b/docs/api/examples/_credentials_list_response.md deleted file mode 100644 index 7e1e5ab93f..0000000000 --- a/docs/api/examples/_credentials_list_response.md +++ /dev/null @@ -1,39 +0,0 @@ - - -#### Example Response - -```json -{ - "credentials": [ - { - "acl": [], - "created_at": "2025-01-14T10:06:20Z", - "description": "development cred for alan@example.com", - "id": "cr_2rcCsCY33MXfPgZls9m1PJZALh2", - "owner_id": "usr_2rcCs3aBfA01H0kq4OxydHqoED0", - "token": null, - "uri": "https://api.ngrok.com/credentials/cr_2rcCsCY33MXfPgZls9m1PJZALh2" - }, - { - "acl": ["bind:1.tcp.ngrok.io:20002", "bind:132.devices.company.com"], - "created_at": "2025-01-14T10:06:20Z", - "description": "for device #132", - "id": "cr_2rcCsCXqOzitULyVNkadsfmZ9Xe", - "owner_id": "usr_2rcCs3aBfA01H0kq4OxydHqoED0", - "token": null, - "uri": "https://api.ngrok.com/credentials/cr_2rcCsCXqOzitULyVNkadsfmZ9Xe" - }, - { - "acl": [], - "created_at": "2025-01-14T10:06:19Z", - "description": "credential for \"api-examples-7b8623844c2b61c9@example.com\"", - "id": "cr_2rcCs8IYBWP7zIXy84Y4ilWVn1e", - "owner_id": "usr_2rcCs3aBfA01H0kq4OxydHqoED0", - "token": null, - "uri": "https://api.ngrok.com/credentials/cr_2rcCs8IYBWP7zIXy84Y4ilWVn1e" - } - ], - "next_page_uri": null, - "uri": "https://api.ngrok.com/credentials" -} -``` diff --git a/docs/api/examples/_credentials_update_request.md b/docs/api/examples/_credentials_update_request.md deleted file mode 100644 index ddc3082cfe..0000000000 --- a/docs/api/examples/_credentials_update_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X PATCH \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"description":"device alpha-2","metadata":"{\"device_id\": \"d5111ba7-0cc5-4ba3-8398-e6c79e4e89c2\"}"}' \ -https://api.ngrok.com/credentials/cr_2rcCsCY33MXfPgZls9m1PJZALh2 -``` diff --git a/docs/api/examples/_credentials_update_response.md b/docs/api/examples/_credentials_update_response.md deleted file mode 100644 index 673336ed3f..0000000000 --- a/docs/api/examples/_credentials_update_response.md +++ /dev/null @@ -1,16 +0,0 @@ - - -#### Example Response - -```json -{ - "acl": [], - "created_at": "2025-01-14T10:06:20Z", - "description": "device alpha-2", - "id": "cr_2rcCsCY33MXfPgZls9m1PJZALh2", - "metadata": "{\"device_id\": \"d5111ba7-0cc5-4ba3-8398-e6c79e4e89c2\"}", - "owner_id": "usr_2rcCs3aBfA01H0kq4OxydHqoED0", - "token": null, - "uri": "https://api.ngrok.com/credentials/cr_2rcCsCY33MXfPgZls9m1PJZALh2" -} -``` diff --git a/docs/api/examples/_edge_route_backend_module_delete_request.md b/docs/api/examples/_edge_route_backend_module_delete_request.md deleted file mode 100644 index cf6849cbe2..0000000000 --- a/docs/api/examples/_edge_route_backend_module_delete_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X DELETE \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/edges/https/edghts_2rcCvIJye8TdodOiPnJmFqbvueP/routes/edghtsrt_2rcCvFndV6GOCnG91ulxpKG4emg/backend -``` diff --git a/docs/api/examples/_edge_route_backend_module_delete_response.md b/docs/api/examples/_edge_route_backend_module_delete_response.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/api/examples/_edge_route_backend_module_get_request.md b/docs/api/examples/_edge_route_backend_module_get_request.md deleted file mode 100644 index 46c8efd696..0000000000 --- a/docs/api/examples/_edge_route_backend_module_get_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/edges/https/edghts_2rcCvIJye8TdodOiPnJmFqbvueP/routes/edghtsrt_2rcCvFndV6GOCnG91ulxpKG4emg/backend -``` diff --git a/docs/api/examples/_edge_route_backend_module_get_response.md b/docs/api/examples/_edge_route_backend_module_get_response.md deleted file mode 100644 index 353c26e485..0000000000 --- a/docs/api/examples/_edge_route_backend_module_get_response.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Response - -```json -{ - "backend": { - "id": "bkdtg_2rcCvFNtHaw3uuSH8yhb2eUVafV", - "uri": "https://api.ngrok.com/backends/tunnel_group/bkdtg_2rcCvFNtHaw3uuSH8yhb2eUVafV" - }, - "enabled": true -} -``` diff --git a/docs/api/examples/_edge_route_backend_module_replace_request.md b/docs/api/examples/_edge_route_backend_module_replace_request.md deleted file mode 100644 index 1092ae9609..0000000000 --- a/docs/api/examples/_edge_route_backend_module_replace_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X PUT \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"backend_id":"bkdtg_2rcCvFNtHaw3uuSH8yhb2eUVafV","enabled":true}' \ -https://api.ngrok.com/edges/https/edghts_2rcCvIJye8TdodOiPnJmFqbvueP/routes/edghtsrt_2rcCvFndV6GOCnG91ulxpKG4emg/backend -``` diff --git a/docs/api/examples/_edge_route_backend_module_replace_response.md b/docs/api/examples/_edge_route_backend_module_replace_response.md deleted file mode 100644 index 353c26e485..0000000000 --- a/docs/api/examples/_edge_route_backend_module_replace_response.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Response - -```json -{ - "backend": { - "id": "bkdtg_2rcCvFNtHaw3uuSH8yhb2eUVafV", - "uri": "https://api.ngrok.com/backends/tunnel_group/bkdtg_2rcCvFNtHaw3uuSH8yhb2eUVafV" - }, - "enabled": true -} -``` diff --git a/docs/api/examples/_edge_route_circuit_breaker_module_delete_request.md b/docs/api/examples/_edge_route_circuit_breaker_module_delete_request.md deleted file mode 100644 index 695b2d57de..0000000000 --- a/docs/api/examples/_edge_route_circuit_breaker_module_delete_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X DELETE \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/edges/https/edghts_2rcCvGOz4ekonA691yqjXzxUzGc/routes/edghtsrt_2rcCvGMi3nTqhqqJWGVO7r1Mn5g/circuit_breaker -``` diff --git a/docs/api/examples/_edge_route_circuit_breaker_module_delete_response.md b/docs/api/examples/_edge_route_circuit_breaker_module_delete_response.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/api/examples/_edge_route_circuit_breaker_module_get_request.md b/docs/api/examples/_edge_route_circuit_breaker_module_get_request.md deleted file mode 100644 index 5d779168cc..0000000000 --- a/docs/api/examples/_edge_route_circuit_breaker_module_get_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/edges/https/edghts_2rcCvGOz4ekonA691yqjXzxUzGc/routes/edghtsrt_2rcCvGMi3nTqhqqJWGVO7r1Mn5g/circuit_breaker -``` diff --git a/docs/api/examples/_edge_route_circuit_breaker_module_get_response.md b/docs/api/examples/_edge_route_circuit_breaker_module_get_response.md deleted file mode 100644 index b56bbca40f..0000000000 --- a/docs/api/examples/_edge_route_circuit_breaker_module_get_response.md +++ /dev/null @@ -1,14 +0,0 @@ - - -#### Example Response - -```json -{ - "enabled": true, - "error_threshold_percentage": 0.2, - "num_buckets": 5, - "rolling_window": 300, - "tripped_duration": 120, - "volume_threshold": 20 -} -``` diff --git a/docs/api/examples/_edge_route_circuit_breaker_module_replace_request.md b/docs/api/examples/_edge_route_circuit_breaker_module_replace_request.md deleted file mode 100644 index 8651cbc0aa..0000000000 --- a/docs/api/examples/_edge_route_circuit_breaker_module_replace_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X PUT \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"enabled":true,"error_threshold_percentage":0.2,"num_buckets":5,"rolling_window":300,"tripped_duration":120,"volume_threshold":20}' \ -https://api.ngrok.com/edges/https/edghts_2rcCvGOz4ekonA691yqjXzxUzGc/routes/edghtsrt_2rcCvGMi3nTqhqqJWGVO7r1Mn5g/circuit_breaker -``` diff --git a/docs/api/examples/_edge_route_circuit_breaker_module_replace_response.md b/docs/api/examples/_edge_route_circuit_breaker_module_replace_response.md deleted file mode 100644 index b56bbca40f..0000000000 --- a/docs/api/examples/_edge_route_circuit_breaker_module_replace_response.md +++ /dev/null @@ -1,14 +0,0 @@ - - -#### Example Response - -```json -{ - "enabled": true, - "error_threshold_percentage": 0.2, - "num_buckets": 5, - "rolling_window": 300, - "tripped_duration": 120, - "volume_threshold": 20 -} -``` diff --git a/docs/api/examples/_edge_route_compression_module_delete_request.md b/docs/api/examples/_edge_route_compression_module_delete_request.md deleted file mode 100644 index 5b40b6c9aa..0000000000 --- a/docs/api/examples/_edge_route_compression_module_delete_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X DELETE \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/edges/https/edghts_2rcCvAw6ig0lid6XnAXiOR0rXkp/routes/edghtsrt_2rcCvDNQDBSM8GPzCyC9lWNXqWz/compression -``` diff --git a/docs/api/examples/_edge_route_compression_module_delete_response.md b/docs/api/examples/_edge_route_compression_module_delete_response.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/api/examples/_edge_route_compression_module_get_request.md b/docs/api/examples/_edge_route_compression_module_get_request.md deleted file mode 100644 index da7a0799f6..0000000000 --- a/docs/api/examples/_edge_route_compression_module_get_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/edges/https/edghts_2rcCvAw6ig0lid6XnAXiOR0rXkp/routes/edghtsrt_2rcCvDNQDBSM8GPzCyC9lWNXqWz/compression -``` diff --git a/docs/api/examples/_edge_route_compression_module_get_response.md b/docs/api/examples/_edge_route_compression_module_get_response.md deleted file mode 100644 index fdfe95fc30..0000000000 --- a/docs/api/examples/_edge_route_compression_module_get_response.md +++ /dev/null @@ -1,9 +0,0 @@ - - -#### Example Response - -```json -{ - "enabled": true -} -``` diff --git a/docs/api/examples/_edge_route_compression_module_replace_request.md b/docs/api/examples/_edge_route_compression_module_replace_request.md deleted file mode 100644 index 8cf9e5b4f7..0000000000 --- a/docs/api/examples/_edge_route_compression_module_replace_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X PUT \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"enabled":true}' \ -https://api.ngrok.com/edges/https/edghts_2rcCvAw6ig0lid6XnAXiOR0rXkp/routes/edghtsrt_2rcCvDNQDBSM8GPzCyC9lWNXqWz/compression -``` diff --git a/docs/api/examples/_edge_route_compression_module_replace_response.md b/docs/api/examples/_edge_route_compression_module_replace_response.md deleted file mode 100644 index fdfe95fc30..0000000000 --- a/docs/api/examples/_edge_route_compression_module_replace_response.md +++ /dev/null @@ -1,9 +0,0 @@ - - -#### Example Response - -```json -{ - "enabled": true -} -``` diff --git a/docs/api/examples/_edge_route_ip_restriction_module_delete_request.md b/docs/api/examples/_edge_route_ip_restriction_module_delete_request.md deleted file mode 100644 index a3d6820264..0000000000 --- a/docs/api/examples/_edge_route_ip_restriction_module_delete_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X DELETE \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/edges/https/edghts_2rcCvMAMnkchNUkuFMGCJCyBDJN/routes/edghtsrt_2rcCvKAKgNDpIrPFvn5Qu1CyrCz/ip_restriction -``` diff --git a/docs/api/examples/_edge_route_ip_restriction_module_delete_response.md b/docs/api/examples/_edge_route_ip_restriction_module_delete_response.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/api/examples/_edge_route_ip_restriction_module_get_request.md b/docs/api/examples/_edge_route_ip_restriction_module_get_request.md deleted file mode 100644 index 74b1f97088..0000000000 --- a/docs/api/examples/_edge_route_ip_restriction_module_get_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/edges/https/edghts_2rcCvMAMnkchNUkuFMGCJCyBDJN/routes/edghtsrt_2rcCvKAKgNDpIrPFvn5Qu1CyrCz/ip_restriction -``` diff --git a/docs/api/examples/_edge_route_ip_restriction_module_get_response.md b/docs/api/examples/_edge_route_ip_restriction_module_get_response.md deleted file mode 100644 index c9317fba77..0000000000 --- a/docs/api/examples/_edge_route_ip_restriction_module_get_response.md +++ /dev/null @@ -1,19 +0,0 @@ - - -#### Example Response - -```json -{ - "enabled": true, - "ip_policies": [ - { - "id": "ipp_2rcCvPW0NplT8Luwd8yGTUJBliz", - "uri": "https://api.ngrok.com/ip_policies/ipp_2rcCvPW0NplT8Luwd8yGTUJBliz" - }, - { - "id": "ipp_2rcCvN79gTv2jb1Yji6tYdns2jX", - "uri": "https://api.ngrok.com/ip_policies/ipp_2rcCvN79gTv2jb1Yji6tYdns2jX" - } - ] -} -``` diff --git a/docs/api/examples/_edge_route_ip_restriction_module_replace_request.md b/docs/api/examples/_edge_route_ip_restriction_module_replace_request.md deleted file mode 100644 index ec875a84cf..0000000000 --- a/docs/api/examples/_edge_route_ip_restriction_module_replace_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X PUT \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"enabled":true,"ip_policy_ids":["ipp_2rcCvPW0NplT8Luwd8yGTUJBliz","ipp_2rcCvN79gTv2jb1Yji6tYdns2jX"]}' \ -https://api.ngrok.com/edges/https/edghts_2rcCvMAMnkchNUkuFMGCJCyBDJN/routes/edghtsrt_2rcCvKAKgNDpIrPFvn5Qu1CyrCz/ip_restriction -``` diff --git a/docs/api/examples/_edge_route_ip_restriction_module_replace_response.md b/docs/api/examples/_edge_route_ip_restriction_module_replace_response.md deleted file mode 100644 index c9317fba77..0000000000 --- a/docs/api/examples/_edge_route_ip_restriction_module_replace_response.md +++ /dev/null @@ -1,19 +0,0 @@ - - -#### Example Response - -```json -{ - "enabled": true, - "ip_policies": [ - { - "id": "ipp_2rcCvPW0NplT8Luwd8yGTUJBliz", - "uri": "https://api.ngrok.com/ip_policies/ipp_2rcCvPW0NplT8Luwd8yGTUJBliz" - }, - { - "id": "ipp_2rcCvN79gTv2jb1Yji6tYdns2jX", - "uri": "https://api.ngrok.com/ip_policies/ipp_2rcCvN79gTv2jb1Yji6tYdns2jX" - } - ] -} -``` diff --git a/docs/api/examples/_edge_route_o_auth_module_delete_request.md b/docs/api/examples/_edge_route_o_auth_module_delete_request.md deleted file mode 100644 index 38d0000fa5..0000000000 --- a/docs/api/examples/_edge_route_o_auth_module_delete_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X DELETE \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/edges/https/edghts_2rcCvPUtPn2N8EbnMo3LL36fyzz/routes/edghtsrt_2rcCvJP2dh3V8kgU4eNXG2k95so/oauth -``` diff --git a/docs/api/examples/_edge_route_o_auth_module_delete_response.md b/docs/api/examples/_edge_route_o_auth_module_delete_response.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/api/examples/_edge_route_o_auth_module_get_request.md b/docs/api/examples/_edge_route_o_auth_module_get_request.md deleted file mode 100644 index 0698f92391..0000000000 --- a/docs/api/examples/_edge_route_o_auth_module_get_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/edges/https/edghts_2rcCvPUtPn2N8EbnMo3LL36fyzz/routes/edghtsrt_2rcCvJP2dh3V8kgU4eNXG2k95so/oauth -``` diff --git a/docs/api/examples/_edge_route_o_auth_module_get_response.md b/docs/api/examples/_edge_route_o_auth_module_get_response.md deleted file mode 100644 index 81c6cb6ea0..0000000000 --- a/docs/api/examples/_edge_route_o_auth_module_get_response.md +++ /dev/null @@ -1,34 +0,0 @@ - - -#### Example Response - -```json -{ - "auth_check_interval": 0, - "cookie_prefix": "ngrok.", - "enabled": true, - "inactivity_timeout": 0, - "maximum_duration": 0, - "options_passthrough": false, - "provider": { - "amazon": null, - "facebook": null, - "github": null, - "gitlab": null, - "google": { - "client_id": "client-id", - "client_secret": "client-secret", - "email_addresses": ["alan@example.com"], - "email_domains": [], - "scopes": [ - "profile", - "email", - "https://www.googleapis.com/auth/userinfo.email" - ] - }, - "linkedin": null, - "microsoft": null, - "twitch": null - } -} -``` diff --git a/docs/api/examples/_edge_route_o_auth_module_replace_request.md b/docs/api/examples/_edge_route_o_auth_module_replace_request.md deleted file mode 100644 index 7cc029210d..0000000000 --- a/docs/api/examples/_edge_route_o_auth_module_replace_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X PUT \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"enabled":true,"provider":{"google":{"client_id":"client-id","client_secret":"client-secret","email_addresses":["alan@example.com"],"scopes":["profile","email","https://www.googleapis.com/auth/userinfo.email"]}}}' \ -https://api.ngrok.com/edges/https/edghts_2rcCvPUtPn2N8EbnMo3LL36fyzz/routes/edghtsrt_2rcCvJP2dh3V8kgU4eNXG2k95so/oauth -``` diff --git a/docs/api/examples/_edge_route_o_auth_module_replace_response.md b/docs/api/examples/_edge_route_o_auth_module_replace_response.md deleted file mode 100644 index 81c6cb6ea0..0000000000 --- a/docs/api/examples/_edge_route_o_auth_module_replace_response.md +++ /dev/null @@ -1,34 +0,0 @@ - - -#### Example Response - -```json -{ - "auth_check_interval": 0, - "cookie_prefix": "ngrok.", - "enabled": true, - "inactivity_timeout": 0, - "maximum_duration": 0, - "options_passthrough": false, - "provider": { - "amazon": null, - "facebook": null, - "github": null, - "gitlab": null, - "google": { - "client_id": "client-id", - "client_secret": "client-secret", - "email_addresses": ["alan@example.com"], - "email_domains": [], - "scopes": [ - "profile", - "email", - "https://www.googleapis.com/auth/userinfo.email" - ] - }, - "linkedin": null, - "microsoft": null, - "twitch": null - } -} -``` diff --git a/docs/api/examples/_edge_route_oidc_module_delete_request.md b/docs/api/examples/_edge_route_oidc_module_delete_request.md deleted file mode 100644 index ebb708394a..0000000000 --- a/docs/api/examples/_edge_route_oidc_module_delete_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X DELETE \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/edges/https/edghts_2rcCvOnt2wIXz7Zsq1em9khrYnG/routes/edghtsrt_2rcCvMb3d7toSL1Wwqyu9ZG61KI/oidc -``` diff --git a/docs/api/examples/_edge_route_oidc_module_delete_response.md b/docs/api/examples/_edge_route_oidc_module_delete_response.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/api/examples/_edge_route_oidc_module_get_request.md b/docs/api/examples/_edge_route_oidc_module_get_request.md deleted file mode 100644 index 404882d28a..0000000000 --- a/docs/api/examples/_edge_route_oidc_module_get_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/edges/https/edghts_2rcCvOnt2wIXz7Zsq1em9khrYnG/routes/edghtsrt_2rcCvMb3d7toSL1Wwqyu9ZG61KI/oidc -``` diff --git a/docs/api/examples/_edge_route_oidc_module_get_response.md b/docs/api/examples/_edge_route_oidc_module_get_response.md deleted file mode 100644 index 4e160f5673..0000000000 --- a/docs/api/examples/_edge_route_oidc_module_get_response.md +++ /dev/null @@ -1,17 +0,0 @@ - - -#### Example Response - -```json -{ - "client_id": "some-client-id", - "client_secret": "some-client-secret", - "cookie_prefix": "", - "enabled": true, - "inactivity_timeout": 0, - "issuer": "https://accounts.google.com", - "maximum_duration": 0, - "options_passthrough": false, - "scopes": ["profile"] -} -``` diff --git a/docs/api/examples/_edge_route_oidc_module_replace_request.md b/docs/api/examples/_edge_route_oidc_module_replace_request.md deleted file mode 100644 index 5ab75f126b..0000000000 --- a/docs/api/examples/_edge_route_oidc_module_replace_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X PUT \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"client_id":"some-client-id","client_secret":"some-client-secret","enabled":true,"issuer":"https://accounts.google.com","scopes":["profile"]}' \ -https://api.ngrok.com/edges/https/edghts_2rcCvOnt2wIXz7Zsq1em9khrYnG/routes/edghtsrt_2rcCvMb3d7toSL1Wwqyu9ZG61KI/oidc -``` diff --git a/docs/api/examples/_edge_route_oidc_module_replace_response.md b/docs/api/examples/_edge_route_oidc_module_replace_response.md deleted file mode 100644 index 4e160f5673..0000000000 --- a/docs/api/examples/_edge_route_oidc_module_replace_response.md +++ /dev/null @@ -1,17 +0,0 @@ - - -#### Example Response - -```json -{ - "client_id": "some-client-id", - "client_secret": "some-client-secret", - "cookie_prefix": "", - "enabled": true, - "inactivity_timeout": 0, - "issuer": "https://accounts.google.com", - "maximum_duration": 0, - "options_passthrough": false, - "scopes": ["profile"] -} -``` diff --git a/docs/api/examples/_edge_route_request_headers_module_delete_request.md b/docs/api/examples/_edge_route_request_headers_module_delete_request.md deleted file mode 100644 index 61e296d2db..0000000000 --- a/docs/api/examples/_edge_route_request_headers_module_delete_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X DELETE \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/edges/https/edghts_2rcCvRmlG2nPTlent8dLnGMBqwM/routes/edghtsrt_2rcCvURXo6QLbgQwVHO1moNMO54/request_headers -``` diff --git a/docs/api/examples/_edge_route_request_headers_module_delete_response.md b/docs/api/examples/_edge_route_request_headers_module_delete_response.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/api/examples/_edge_route_request_headers_module_get_request.md b/docs/api/examples/_edge_route_request_headers_module_get_request.md deleted file mode 100644 index 62af14de92..0000000000 --- a/docs/api/examples/_edge_route_request_headers_module_get_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/edges/https/edghts_2rcCvRmlG2nPTlent8dLnGMBqwM/routes/edghtsrt_2rcCvURXo6QLbgQwVHO1moNMO54/request_headers -``` diff --git a/docs/api/examples/_edge_route_request_headers_module_get_response.md b/docs/api/examples/_edge_route_request_headers_module_get_response.md deleted file mode 100644 index 03643279b6..0000000000 --- a/docs/api/examples/_edge_route_request_headers_module_get_response.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Response - -```json -{ - "add": { - "x-frontend": "ngrok" - }, - "enabled": true, - "remove": ["cache-control"] -} -``` diff --git a/docs/api/examples/_edge_route_request_headers_module_replace_request.md b/docs/api/examples/_edge_route_request_headers_module_replace_request.md deleted file mode 100644 index 7d44fec5b8..0000000000 --- a/docs/api/examples/_edge_route_request_headers_module_replace_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X PUT \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"add":{"x-frontend":"ngrok"},"enabled":true,"remove":["cache-control"]}' \ -https://api.ngrok.com/edges/https/edghts_2rcCvRmlG2nPTlent8dLnGMBqwM/routes/edghtsrt_2rcCvURXo6QLbgQwVHO1moNMO54/request_headers -``` diff --git a/docs/api/examples/_edge_route_request_headers_module_replace_response.md b/docs/api/examples/_edge_route_request_headers_module_replace_response.md deleted file mode 100644 index 03643279b6..0000000000 --- a/docs/api/examples/_edge_route_request_headers_module_replace_response.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Response - -```json -{ - "add": { - "x-frontend": "ngrok" - }, - "enabled": true, - "remove": ["cache-control"] -} -``` diff --git a/docs/api/examples/_edge_route_response_headers_module_delete_request.md b/docs/api/examples/_edge_route_response_headers_module_delete_request.md deleted file mode 100644 index a7c8bcab9d..0000000000 --- a/docs/api/examples/_edge_route_response_headers_module_delete_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X DELETE \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/edges/https/edghts_2rcCvVPEngcgAyM0TyvipVMuKCR/routes/edghtsrt_2rcCvTIB74lfzHJG20Jk4lbxKhn/response_headers -``` diff --git a/docs/api/examples/_edge_route_response_headers_module_delete_response.md b/docs/api/examples/_edge_route_response_headers_module_delete_response.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/api/examples/_edge_route_response_headers_module_get_request.md b/docs/api/examples/_edge_route_response_headers_module_get_request.md deleted file mode 100644 index b13b91bbb7..0000000000 --- a/docs/api/examples/_edge_route_response_headers_module_get_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/edges/https/edghts_2rcCvVPEngcgAyM0TyvipVMuKCR/routes/edghtsrt_2rcCvTIB74lfzHJG20Jk4lbxKhn/response_headers -``` diff --git a/docs/api/examples/_edge_route_response_headers_module_get_response.md b/docs/api/examples/_edge_route_response_headers_module_get_response.md deleted file mode 100644 index 9397e5e898..0000000000 --- a/docs/api/examples/_edge_route_response_headers_module_get_response.md +++ /dev/null @@ -1,14 +0,0 @@ - - -#### Example Response - -```json -{ - "add": { - "content-security-policy": "script-src 'self'", - "x-frame-options": "DENY" - }, - "enabled": true, - "remove": [] -} -``` diff --git a/docs/api/examples/_edge_route_response_headers_module_replace_request.md b/docs/api/examples/_edge_route_response_headers_module_replace_request.md deleted file mode 100644 index 74832259a9..0000000000 --- a/docs/api/examples/_edge_route_response_headers_module_replace_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X PUT \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"add":{"Content-Security-Policy":"script-src 'self'","X-Frame-Options":"DENY"},"enabled":true}' \ -https://api.ngrok.com/edges/https/edghts_2rcCvVPEngcgAyM0TyvipVMuKCR/routes/edghtsrt_2rcCvTIB74lfzHJG20Jk4lbxKhn/response_headers -``` diff --git a/docs/api/examples/_edge_route_response_headers_module_replace_response.md b/docs/api/examples/_edge_route_response_headers_module_replace_response.md deleted file mode 100644 index 9397e5e898..0000000000 --- a/docs/api/examples/_edge_route_response_headers_module_replace_response.md +++ /dev/null @@ -1,14 +0,0 @@ - - -#### Example Response - -```json -{ - "add": { - "content-security-policy": "script-src 'self'", - "x-frame-options": "DENY" - }, - "enabled": true, - "remove": [] -} -``` diff --git a/docs/api/examples/_edge_route_saml_module_delete_request.md b/docs/api/examples/_edge_route_saml_module_delete_request.md deleted file mode 100644 index 4ccdc000a8..0000000000 --- a/docs/api/examples/_edge_route_saml_module_delete_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X DELETE \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/edges/https/edghts_2rcCvVrjXL2lpZ9dgECuXsFukRv/routes/edghtsrt_2rcCvSxprCyfSjKpDkkVdEs9OkC/saml -``` diff --git a/docs/api/examples/_edge_route_saml_module_delete_response.md b/docs/api/examples/_edge_route_saml_module_delete_response.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/api/examples/_edge_route_saml_module_get_request.md b/docs/api/examples/_edge_route_saml_module_get_request.md deleted file mode 100644 index 57df95a387..0000000000 --- a/docs/api/examples/_edge_route_saml_module_get_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/edges/https/edghts_2rcCvVrjXL2lpZ9dgECuXsFukRv/routes/edghtsrt_2rcCvSxprCyfSjKpDkkVdEs9OkC/saml -``` diff --git a/docs/api/examples/_edge_route_saml_module_get_response.md b/docs/api/examples/_edge_route_saml_module_get_response.md deleted file mode 100644 index cfeaa3cfdb..0000000000 --- a/docs/api/examples/_edge_route_saml_module_get_response.md +++ /dev/null @@ -1,24 +0,0 @@ - - -#### Example Response - -```json -{ - "allow_idp_initiated": true, - "assertion_consumer_service_url": "https://idp.local-ngrok.com/saml/edghtsrt_2rcCvSxprCyfSjKpDkkVdEs9OkC/acs", - "authorized_groups": [], - "cookie_prefix": "", - "enabled": true, - "entity_id": "https://idp.local-ngrok.com/saml/edghtsrt_2rcCvSxprCyfSjKpDkkVdEs9OkC", - "force_authn": false, - "idp_metadata": "\nurn:oasis:names:tc:SAML:2.0:nameid-format:transient\n", - "idp_metadata_url": "", - "inactivity_timeout": 0, - "maximum_duration": 0, - "metadata_url": "https://idp.local-ngrok.com/saml/edghtsrt_2rcCvSxprCyfSjKpDkkVdEs9OkC", - "nameid_format": "urn:oasis:names:tc:SAML:2.0:nameid-format:persistent", - "options_passthrough": false, - "request_signing_certificate_pem": "-----BEGIN CERTIFICATE-----\nMIIEAzCCAuugAwIBAgIQd0f8dWrOEC2n3DS7PP3KLDANBgkqhkiG9w0BAQsFADCB\noDFOMEwGA1UECgxFaHR0cHM6Ly9pZHAubG9jYWwtbmdyb2suY29tL3NhbWwvZWRn\naHRzcnRfMnJjQ3ZTeHByQ3lmU2pLcERra1ZkRXM5T2tDMU4wTAYDVQQDDEVodHRw\nczovL2lkcC5sb2NhbC1uZ3Jvay5jb20vc2FtbC9lZGdodHNydF8ycmNDdlN4cHJD\neWZTaktwRGtrVmRFczlPa0MwIBcNMjUwMTE0MTAwNjQ2WhgPMjA2MDAxMDYxMDA2\nNDZaMIGgMU4wTAYDVQQKDEVodHRwczovL2lkcC5sb2NhbC1uZ3Jvay5jb20vc2Ft\nbC9lZGdodHNydF8ycmNDdlN4cHJDeWZTaktwRGtrVmRFczlPa0MxTjBMBgNVBAMM\nRWh0dHBzOi8vaWRwLmxvY2FsLW5ncm9rLmNvbS9zYW1sL2VkZ2h0c3J0XzJyY0N2\nU3hwckN5ZlNqS3BEa2tWZEVzOU9rQzCCASIwDQYJKoZIhvcNAQEBBQADggEPADCC\nAQoCggEBALdwcqSvuY8KPcCjr3yCwqVOyncIzD26skk3Zfh6CKlk5tdOvZVGzkUp\nZkhjlLQ7CoFsCoPVvjBZ4aGL1AoVMSB9pbCtP72S9r3W7a0h3YLe5AtaDwJYYnUy\nDXfLu2a+B/JMG9Nu3nA5LqiMXNtxrk3qLGtohKiJyY0W8nnVq7VVgcfCUrCV5GAI\nhlcC8IqBBy2LbFe4PPz20sXnOhLgH7xDFgu0WkFZm72qfx2TIFgUvNKRBwIJEUfk\nJJ6miL5f1w5AuIA0liKT7uUUUPb2uU3lF5G1CvStgjTv56CmlZmbSaLlKIvYH1V+\nPEnFRUQxUhL7Nc2KLQBVlc+lG1uRxLECAwEAAaM1MDMwDgYDVR0PAQH/BAQDAgeA\nMBMGA1UdJQQMMAoGCCsGAQUFBwMBMAwGA1UdEwEB/wQCMAAwDQYJKoZIhvcNAQEL\nBQADggEBAIufH3LMI6zy05r5HASeZ2JUcj3FkBDkT37WztPiylhsji6j8Pl9E2ZN\nM6+BARArV3PE3ktQXwGLigtKiy9/o2mkBAm29gDVKTXFxnV8lygTK+AGUPVcpmnS\nYFH8Q/tR+mwIUY+F8ab+To9/6NlAW5MYHDp/Yw6mBWimH9crvCkw+RZwN7J3kR+y\n05GKagSd01Iy8RdS826rT4RYKq9USryouOrRW9Zr4mYnm/xnF+09FkhxKSCaym/S\n2OfvYVuZon79lkVhTYuAGJM+bgkMR0V/I1XLlpM34j5HMamabf6gVrf9QAwGFcBv\nxvE3XfL0RYM23fysXiocbj661dkIBZ8=\n-----END CERTIFICATE-----\n", - "single_logout_url": "https://idp.local-ngrok.com/saml/edghtsrt_2rcCvSxprCyfSjKpDkkVdEs9OkC/slo" -} -``` diff --git a/docs/api/examples/_edge_route_saml_module_replace_request.md b/docs/api/examples/_edge_route_saml_module_replace_request.md deleted file mode 100644 index 0d411757a8..0000000000 --- a/docs/api/examples/_edge_route_saml_module_replace_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X PUT \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"enabled":true,"idp_metadata":"\nurn:oasis:names:tc:SAML:2.0:nameid-format:transient\n"}' \ -https://api.ngrok.com/edges/https/edghts_2rcCvVrjXL2lpZ9dgECuXsFukRv/routes/edghtsrt_2rcCvSxprCyfSjKpDkkVdEs9OkC/saml -``` diff --git a/docs/api/examples/_edge_route_saml_module_replace_response.md b/docs/api/examples/_edge_route_saml_module_replace_response.md deleted file mode 100644 index cfeaa3cfdb..0000000000 --- a/docs/api/examples/_edge_route_saml_module_replace_response.md +++ /dev/null @@ -1,24 +0,0 @@ - - -#### Example Response - -```json -{ - "allow_idp_initiated": true, - "assertion_consumer_service_url": "https://idp.local-ngrok.com/saml/edghtsrt_2rcCvSxprCyfSjKpDkkVdEs9OkC/acs", - "authorized_groups": [], - "cookie_prefix": "", - "enabled": true, - "entity_id": "https://idp.local-ngrok.com/saml/edghtsrt_2rcCvSxprCyfSjKpDkkVdEs9OkC", - "force_authn": false, - "idp_metadata": "\nurn:oasis:names:tc:SAML:2.0:nameid-format:transient\n", - "idp_metadata_url": "", - "inactivity_timeout": 0, - "maximum_duration": 0, - "metadata_url": "https://idp.local-ngrok.com/saml/edghtsrt_2rcCvSxprCyfSjKpDkkVdEs9OkC", - "nameid_format": "urn:oasis:names:tc:SAML:2.0:nameid-format:persistent", - "options_passthrough": false, - "request_signing_certificate_pem": "-----BEGIN CERTIFICATE-----\nMIIEAzCCAuugAwIBAgIQd0f8dWrOEC2n3DS7PP3KLDANBgkqhkiG9w0BAQsFADCB\noDFOMEwGA1UECgxFaHR0cHM6Ly9pZHAubG9jYWwtbmdyb2suY29tL3NhbWwvZWRn\naHRzcnRfMnJjQ3ZTeHByQ3lmU2pLcERra1ZkRXM5T2tDMU4wTAYDVQQDDEVodHRw\nczovL2lkcC5sb2NhbC1uZ3Jvay5jb20vc2FtbC9lZGdodHNydF8ycmNDdlN4cHJD\neWZTaktwRGtrVmRFczlPa0MwIBcNMjUwMTE0MTAwNjQ2WhgPMjA2MDAxMDYxMDA2\nNDZaMIGgMU4wTAYDVQQKDEVodHRwczovL2lkcC5sb2NhbC1uZ3Jvay5jb20vc2Ft\nbC9lZGdodHNydF8ycmNDdlN4cHJDeWZTaktwRGtrVmRFczlPa0MxTjBMBgNVBAMM\nRWh0dHBzOi8vaWRwLmxvY2FsLW5ncm9rLmNvbS9zYW1sL2VkZ2h0c3J0XzJyY0N2\nU3hwckN5ZlNqS3BEa2tWZEVzOU9rQzCCASIwDQYJKoZIhvcNAQEBBQADggEPADCC\nAQoCggEBALdwcqSvuY8KPcCjr3yCwqVOyncIzD26skk3Zfh6CKlk5tdOvZVGzkUp\nZkhjlLQ7CoFsCoPVvjBZ4aGL1AoVMSB9pbCtP72S9r3W7a0h3YLe5AtaDwJYYnUy\nDXfLu2a+B/JMG9Nu3nA5LqiMXNtxrk3qLGtohKiJyY0W8nnVq7VVgcfCUrCV5GAI\nhlcC8IqBBy2LbFe4PPz20sXnOhLgH7xDFgu0WkFZm72qfx2TIFgUvNKRBwIJEUfk\nJJ6miL5f1w5AuIA0liKT7uUUUPb2uU3lF5G1CvStgjTv56CmlZmbSaLlKIvYH1V+\nPEnFRUQxUhL7Nc2KLQBVlc+lG1uRxLECAwEAAaM1MDMwDgYDVR0PAQH/BAQDAgeA\nMBMGA1UdJQQMMAoGCCsGAQUFBwMBMAwGA1UdEwEB/wQCMAAwDQYJKoZIhvcNAQEL\nBQADggEBAIufH3LMI6zy05r5HASeZ2JUcj3FkBDkT37WztPiylhsji6j8Pl9E2ZN\nM6+BARArV3PE3ktQXwGLigtKiy9/o2mkBAm29gDVKTXFxnV8lygTK+AGUPVcpmnS\nYFH8Q/tR+mwIUY+F8ab+To9/6NlAW5MYHDp/Yw6mBWimH9crvCkw+RZwN7J3kR+y\n05GKagSd01Iy8RdS826rT4RYKq9USryouOrRW9Zr4mYnm/xnF+09FkhxKSCaym/S\n2OfvYVuZon79lkVhTYuAGJM+bgkMR0V/I1XLlpM34j5HMamabf6gVrf9QAwGFcBv\nxvE3XfL0RYM23fysXiocbj661dkIBZ8=\n-----END CERTIFICATE-----\n", - "single_logout_url": "https://idp.local-ngrok.com/saml/edghtsrt_2rcCvSxprCyfSjKpDkkVdEs9OkC/slo" -} -``` diff --git a/docs/api/examples/_edge_route_traffic_policy_module_delete_request.md b/docs/api/examples/_edge_route_traffic_policy_module_delete_request.md deleted file mode 100644 index 7eadf802a7..0000000000 --- a/docs/api/examples/_edge_route_traffic_policy_module_delete_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X DELETE \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/edges/https/edghts_2rcCvL7HuKc2oixDbmNiw1DnN0q/routes/edghtsrt_2rcCvL4W0rhygcTk3nz7vZU0Der/traffic_policy -``` diff --git a/docs/api/examples/_edge_route_traffic_policy_module_delete_response.md b/docs/api/examples/_edge_route_traffic_policy_module_delete_response.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/api/examples/_edge_route_traffic_policy_module_get_request.md b/docs/api/examples/_edge_route_traffic_policy_module_get_request.md deleted file mode 100644 index e9a56dd83d..0000000000 --- a/docs/api/examples/_edge_route_traffic_policy_module_get_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/edges/https/edghts_2rcCvL7HuKc2oixDbmNiw1DnN0q/routes/edghtsrt_2rcCvL4W0rhygcTk3nz7vZU0Der/traffic_policy -``` diff --git a/docs/api/examples/_edge_route_traffic_policy_module_get_response.md b/docs/api/examples/_edge_route_traffic_policy_module_get_response.md deleted file mode 100644 index 6e464e4ea1..0000000000 --- a/docs/api/examples/_edge_route_traffic_policy_module_get_response.md +++ /dev/null @@ -1,10 +0,0 @@ - - -#### Example Response - -```json -{ - "enabled": true, - "value": "{\n\t\"on_http_request\":[\n\t\t{\n\t\t\t\"name\":\"Rewrite /products API Calls\",\n\t\t\t\"expressions\":[\"req.url.path == '/products'\"],\n\t\t\t\"actions\":[\n\t\t\t\t{\n\t\t\t\t\t\"type\": \"url-rewrite\",\n\t\t\t\t\t\"config\": {\n\t\t\t\t\t\t\"from\": \"/products/?([.*]+)?\",\n\t\t\t\t\t\t\"to\": \"/products.php?query=$1\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t{\n\t\t\t\"name\":\"Block POST Requests With Large Content Length From Specific Countries\",\n\t\t\t\"expressions\":[\n\t\t\t\t\"req.method == 'POST' && req.content_length > 10000\",\n\t\t\t\t\"conn.geo.country_code in ['BR', 'CN', 'CU', 'IR', 'NG', 'RO', 'RU', 'SD', 'SY', 'UA']\"\n\t\t\t],\n\t\t\t\"actions\":[\n\t\t\t\t{\n\t\t\t\t\t\"type\":\"custom-response\",\n\t\t\t\t\t\"config\":{\n\t\t\t\t\t\t\"status_code\":401,\n\t\t\t\t\t\t\"headers\":{\n\t\t\t\t\t\t\t\"content-type\":\"text/plain\"\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"content\":\"access denied\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t{\n\t\t\t\"name\":\"Block AI Crawler Bots\",\n\t\t\t\"expressions\":[\"'ChatGPT' in req.headers['user-agent'] || 'GPTBot' in req.headers['user-agent']\"],\n\t\t\t\"actions\":[\n\t\t\t\t{\n\t\t\t\t\t\"type\":\"deny\",\n\t\t\t\t\t\"config\":{\n\t\t\t\t\t\t\"status_code\":400\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t}\n\t],\n\t\"on_http_response\":[\n\t\t{\n\t\t\t\"name\":\"Brotli Compress Responses\",\n\t\t\t\"actions\":[\n\t\t\t\t{\n\t\t\t\t\t\"type\":\"compress-response\",\n\t\t\t\t\t\"config\": {\n\t\t\t\t\t\t\"algorithms\":[\"br\"]\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t}\n\t]\n}" -} -``` diff --git a/docs/api/examples/_edge_route_traffic_policy_module_replace_request.md b/docs/api/examples/_edge_route_traffic_policy_module_replace_request.md deleted file mode 100644 index 32b833c17b..0000000000 --- a/docs/api/examples/_edge_route_traffic_policy_module_replace_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X PUT \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"enabled":true,"value":"{\n\t\"on_http_request\":[\n\t\t{\n\t\t\t\"name\":\"Rewrite /products API Calls\",\n\t\t\t\"expressions\":[\"req.url.path == '/products'\"],\n\t\t\t\"actions\":[\n\t\t\t\t{\n\t\t\t\t\t\"type\": \"url-rewrite\",\n\t\t\t\t\t\"config\": {\n\t\t\t\t\t\t\"from\": \"/products/?([.*]+)?\",\n\t\t\t\t\t\t\"to\": \"/products.php?query=$1\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t{\n\t\t\t\"name\":\"Block POST Requests With Large Content Length From Specific Countries\",\n\t\t\t\"expressions\":[\n\t\t\t\t\"req.method == 'POST' && req.content_length > 10000\",\n\t\t\t\t\"conn.geo.country_code in ['BR', 'CN', 'CU', 'IR', 'NG', 'RO', 'RU', 'SD', 'SY', 'UA']\"\n\t\t\t],\n\t\t\t\"actions\":[\n\t\t\t\t{\n\t\t\t\t\t\"type\":\"custom-response\",\n\t\t\t\t\t\"config\":{\n\t\t\t\t\t\t\"status_code\":401,\n\t\t\t\t\t\t\"headers\":{\n\t\t\t\t\t\t\t\"content-type\":\"text/plain\"\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"content\":\"access denied\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t{\n\t\t\t\"name\":\"Block AI Crawler Bots\",\n\t\t\t\"expressions\":[\"'ChatGPT' in req.headers['user-agent'] || 'GPTBot' in req.headers['user-agent']\"],\n\t\t\t\"actions\":[\n\t\t\t\t{\n\t\t\t\t\t\"type\":\"deny\",\n\t\t\t\t\t\"config\":{\n\t\t\t\t\t\t\"status_code\":400\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t}\n\t],\n\t\"on_http_response\":[\n\t\t{\n\t\t\t\"name\":\"Brotli Compress Responses\",\n\t\t\t\"actions\":[\n\t\t\t\t{\n\t\t\t\t\t\"type\":\"compress-response\",\n\t\t\t\t\t\"config\": {\n\t\t\t\t\t\t\"algorithms\":[\"br\"]\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t}\n\t]\n}"}' \ -https://api.ngrok.com/edges/https/edghts_2rcCvL7HuKc2oixDbmNiw1DnN0q/routes/edghtsrt_2rcCvL4W0rhygcTk3nz7vZU0Der/traffic_policy -``` diff --git a/docs/api/examples/_edge_route_traffic_policy_module_replace_response.md b/docs/api/examples/_edge_route_traffic_policy_module_replace_response.md deleted file mode 100644 index 6e464e4ea1..0000000000 --- a/docs/api/examples/_edge_route_traffic_policy_module_replace_response.md +++ /dev/null @@ -1,10 +0,0 @@ - - -#### Example Response - -```json -{ - "enabled": true, - "value": "{\n\t\"on_http_request\":[\n\t\t{\n\t\t\t\"name\":\"Rewrite /products API Calls\",\n\t\t\t\"expressions\":[\"req.url.path == '/products'\"],\n\t\t\t\"actions\":[\n\t\t\t\t{\n\t\t\t\t\t\"type\": \"url-rewrite\",\n\t\t\t\t\t\"config\": {\n\t\t\t\t\t\t\"from\": \"/products/?([.*]+)?\",\n\t\t\t\t\t\t\"to\": \"/products.php?query=$1\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t{\n\t\t\t\"name\":\"Block POST Requests With Large Content Length From Specific Countries\",\n\t\t\t\"expressions\":[\n\t\t\t\t\"req.method == 'POST' && req.content_length > 10000\",\n\t\t\t\t\"conn.geo.country_code in ['BR', 'CN', 'CU', 'IR', 'NG', 'RO', 'RU', 'SD', 'SY', 'UA']\"\n\t\t\t],\n\t\t\t\"actions\":[\n\t\t\t\t{\n\t\t\t\t\t\"type\":\"custom-response\",\n\t\t\t\t\t\"config\":{\n\t\t\t\t\t\t\"status_code\":401,\n\t\t\t\t\t\t\"headers\":{\n\t\t\t\t\t\t\t\"content-type\":\"text/plain\"\n\t\t\t\t\t\t},\n\t\t\t\t\t\t\"content\":\"access denied\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t{\n\t\t\t\"name\":\"Block AI Crawler Bots\",\n\t\t\t\"expressions\":[\"'ChatGPT' in req.headers['user-agent'] || 'GPTBot' in req.headers['user-agent']\"],\n\t\t\t\"actions\":[\n\t\t\t\t{\n\t\t\t\t\t\"type\":\"deny\",\n\t\t\t\t\t\"config\":{\n\t\t\t\t\t\t\"status_code\":400\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t}\n\t],\n\t\"on_http_response\":[\n\t\t{\n\t\t\t\"name\":\"Brotli Compress Responses\",\n\t\t\t\"actions\":[\n\t\t\t\t{\n\t\t\t\t\t\"type\":\"compress-response\",\n\t\t\t\t\t\"config\": {\n\t\t\t\t\t\t\"algorithms\":[\"br\"]\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t}\n\t]\n}" -} -``` diff --git a/docs/api/examples/_edge_route_user_agent_filter_module_delete_request.md b/docs/api/examples/_edge_route_user_agent_filter_module_delete_request.md deleted file mode 100644 index bba9d1f504..0000000000 --- a/docs/api/examples/_edge_route_user_agent_filter_module_delete_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X DELETE \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/edges/https/edghts_2rcCvX4D2NtKfxsAAuWfoGLWZ8g/routes/edghtsrt_2rcCvUtrIn7x4Owss5k3gBDmuMw/user_agent_filter -``` diff --git a/docs/api/examples/_edge_route_user_agent_filter_module_delete_response.md b/docs/api/examples/_edge_route_user_agent_filter_module_delete_response.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/api/examples/_edge_route_user_agent_filter_module_get_request.md b/docs/api/examples/_edge_route_user_agent_filter_module_get_request.md deleted file mode 100644 index 1647d2de64..0000000000 --- a/docs/api/examples/_edge_route_user_agent_filter_module_get_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/edges/https/edghts_2rcCvX4D2NtKfxsAAuWfoGLWZ8g/routes/edghtsrt_2rcCvUtrIn7x4Owss5k3gBDmuMw/user_agent_filter -``` diff --git a/docs/api/examples/_edge_route_user_agent_filter_module_get_response.md b/docs/api/examples/_edge_route_user_agent_filter_module_get_response.md deleted file mode 100644 index 49a0de6ede..0000000000 --- a/docs/api/examples/_edge_route_user_agent_filter_module_get_response.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Response - -```json -{ - "allow": ["(Pingdom\\.com_bot_version_)(\\d+)\\.(\\d+)"], - "deny": ["(made_up_bot)/(\\d+)\\.(\\d+)"], - "enabled": true -} -``` diff --git a/docs/api/examples/_edge_route_user_agent_filter_module_replace_request.md b/docs/api/examples/_edge_route_user_agent_filter_module_replace_request.md deleted file mode 100644 index 874ba6d2e8..0000000000 --- a/docs/api/examples/_edge_route_user_agent_filter_module_replace_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X PUT \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"allow":["(Pingdom\\.com_bot_version_)(\\d+)\\.(\\d+)"],"deny":["(made_up_bot)/(\\d+)\\.(\\d+)"],"enabled":true}' \ -https://api.ngrok.com/edges/https/edghts_2rcCvX4D2NtKfxsAAuWfoGLWZ8g/routes/edghtsrt_2rcCvUtrIn7x4Owss5k3gBDmuMw/user_agent_filter -``` diff --git a/docs/api/examples/_edge_route_user_agent_filter_module_replace_response.md b/docs/api/examples/_edge_route_user_agent_filter_module_replace_response.md deleted file mode 100644 index 49a0de6ede..0000000000 --- a/docs/api/examples/_edge_route_user_agent_filter_module_replace_response.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Response - -```json -{ - "allow": ["(Pingdom\\.com_bot_version_)(\\d+)\\.(\\d+)"], - "deny": ["(made_up_bot)/(\\d+)\\.(\\d+)"], - "enabled": true -} -``` diff --git a/docs/api/examples/_edge_route_webhook_verification_module_delete_request.md b/docs/api/examples/_edge_route_webhook_verification_module_delete_request.md deleted file mode 100644 index 0c96601d99..0000000000 --- a/docs/api/examples/_edge_route_webhook_verification_module_delete_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X DELETE \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/edges/https/edghts_2rcCvfSGoiUGCHC5ZDAP1CarHrh/routes/edghtsrt_2rcCvdl6hf1ikCmDNLplLBz03aa/webhook_verification -``` diff --git a/docs/api/examples/_edge_route_webhook_verification_module_delete_response.md b/docs/api/examples/_edge_route_webhook_verification_module_delete_response.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/api/examples/_edge_route_webhook_verification_module_get_request.md b/docs/api/examples/_edge_route_webhook_verification_module_get_request.md deleted file mode 100644 index df7d0bd4fb..0000000000 --- a/docs/api/examples/_edge_route_webhook_verification_module_get_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/edges/https/edghts_2rcCvfSGoiUGCHC5ZDAP1CarHrh/routes/edghtsrt_2rcCvdl6hf1ikCmDNLplLBz03aa/webhook_verification -``` diff --git a/docs/api/examples/_edge_route_webhook_verification_module_get_response.md b/docs/api/examples/_edge_route_webhook_verification_module_get_response.md deleted file mode 100644 index 999761990a..0000000000 --- a/docs/api/examples/_edge_route_webhook_verification_module_get_response.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Response - -```json -{ - "enabled": true, - "provider": "TWILIO", - "secret": "secret_token" -} -``` diff --git a/docs/api/examples/_edge_route_webhook_verification_module_replace_request.md b/docs/api/examples/_edge_route_webhook_verification_module_replace_request.md deleted file mode 100644 index 8a0890ec2b..0000000000 --- a/docs/api/examples/_edge_route_webhook_verification_module_replace_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X PUT \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"enabled":true,"provider":"TWILIO","secret":"secret_token"}' \ -https://api.ngrok.com/edges/https/edghts_2rcCvfSGoiUGCHC5ZDAP1CarHrh/routes/edghtsrt_2rcCvdl6hf1ikCmDNLplLBz03aa/webhook_verification -``` diff --git a/docs/api/examples/_edge_route_webhook_verification_module_replace_response.md b/docs/api/examples/_edge_route_webhook_verification_module_replace_response.md deleted file mode 100644 index 999761990a..0000000000 --- a/docs/api/examples/_edge_route_webhook_verification_module_replace_response.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Response - -```json -{ - "enabled": true, - "provider": "TWILIO", - "secret": "secret_token" -} -``` diff --git a/docs/api/examples/_edge_route_websocket_tcp_converter_module_delete_request.md b/docs/api/examples/_edge_route_websocket_tcp_converter_module_delete_request.md deleted file mode 100644 index f19d841552..0000000000 --- a/docs/api/examples/_edge_route_websocket_tcp_converter_module_delete_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X DELETE \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/edges/https/edghts_2rcCvZAM1C1xssUfZeasjokDfxy/routes/edghtsrt_2rcCvatvnSajk5FQ5PQJOrKLmvY/websocket_tcp_converter -``` diff --git a/docs/api/examples/_edge_route_websocket_tcp_converter_module_delete_response.md b/docs/api/examples/_edge_route_websocket_tcp_converter_module_delete_response.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/api/examples/_edge_route_websocket_tcp_converter_module_get_request.md b/docs/api/examples/_edge_route_websocket_tcp_converter_module_get_request.md deleted file mode 100644 index 85538fc4ac..0000000000 --- a/docs/api/examples/_edge_route_websocket_tcp_converter_module_get_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/edges/https/edghts_2rcCvZAM1C1xssUfZeasjokDfxy/routes/edghtsrt_2rcCvatvnSajk5FQ5PQJOrKLmvY/websocket_tcp_converter -``` diff --git a/docs/api/examples/_edge_route_websocket_tcp_converter_module_get_response.md b/docs/api/examples/_edge_route_websocket_tcp_converter_module_get_response.md deleted file mode 100644 index fdfe95fc30..0000000000 --- a/docs/api/examples/_edge_route_websocket_tcp_converter_module_get_response.md +++ /dev/null @@ -1,9 +0,0 @@ - - -#### Example Response - -```json -{ - "enabled": true -} -``` diff --git a/docs/api/examples/_edge_route_websocket_tcp_converter_module_replace_request.md b/docs/api/examples/_edge_route_websocket_tcp_converter_module_replace_request.md deleted file mode 100644 index 5b7d8846aa..0000000000 --- a/docs/api/examples/_edge_route_websocket_tcp_converter_module_replace_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X PUT \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"enabled":true}' \ -https://api.ngrok.com/edges/https/edghts_2rcCvZAM1C1xssUfZeasjokDfxy/routes/edghtsrt_2rcCvatvnSajk5FQ5PQJOrKLmvY/websocket_tcp_converter -``` diff --git a/docs/api/examples/_edge_route_websocket_tcp_converter_module_replace_response.md b/docs/api/examples/_edge_route_websocket_tcp_converter_module_replace_response.md deleted file mode 100644 index fdfe95fc30..0000000000 --- a/docs/api/examples/_edge_route_websocket_tcp_converter_module_replace_response.md +++ /dev/null @@ -1,9 +0,0 @@ - - -#### Example Response - -```json -{ - "enabled": true -} -``` diff --git a/docs/api/examples/_edges_https_create_request.md b/docs/api/examples/_edges_https_create_request.md deleted file mode 100644 index 1ea100ba07..0000000000 --- a/docs/api/examples/_edges_https_create_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X POST \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"description":"acme https edge","hostports":["example.com:443"],"metadata":"{\"environment\": \"staging\"}"}' \ -https://api.ngrok.com/edges/https -``` diff --git a/docs/api/examples/_edges_https_create_response.md b/docs/api/examples/_edges_https_create_response.md deleted file mode 100644 index 6ee7315154..0000000000 --- a/docs/api/examples/_edges_https_create_response.md +++ /dev/null @@ -1,17 +0,0 @@ - - -#### Example Response - -```json -{ - "created_at": "2025-01-14T10:06:43Z", - "description": "acme https edge", - "hostports": ["example.com:443"], - "id": "edghts_2rcCv9v5JCRsPwWisboNMCmUw0h", - "metadata": "{\"environment\": \"staging\"}", - "mutual_tls": null, - "routes": [], - "tls_termination": null, - "uri": "https://api.ngrok.com/edges/https/edghts_2rcCv9v5JCRsPwWisboNMCmUw0h" -} -``` diff --git a/docs/api/examples/_edges_https_delete_request.md b/docs/api/examples/_edges_https_delete_request.md deleted file mode 100644 index cf30c06d46..0000000000 --- a/docs/api/examples/_edges_https_delete_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X DELETE \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/edges/https/edghts_2rcCv9v5JCRsPwWisboNMCmUw0h -``` diff --git a/docs/api/examples/_edges_https_delete_response.md b/docs/api/examples/_edges_https_delete_response.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/api/examples/_edges_https_get_request.md b/docs/api/examples/_edges_https_get_request.md deleted file mode 100644 index da69ebe161..0000000000 --- a/docs/api/examples/_edges_https_get_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/edges/https/edghts_2rcCv9v5JCRsPwWisboNMCmUw0h -``` diff --git a/docs/api/examples/_edges_https_get_response.md b/docs/api/examples/_edges_https_get_response.md deleted file mode 100644 index 6ee7315154..0000000000 --- a/docs/api/examples/_edges_https_get_response.md +++ /dev/null @@ -1,17 +0,0 @@ - - -#### Example Response - -```json -{ - "created_at": "2025-01-14T10:06:43Z", - "description": "acme https edge", - "hostports": ["example.com:443"], - "id": "edghts_2rcCv9v5JCRsPwWisboNMCmUw0h", - "metadata": "{\"environment\": \"staging\"}", - "mutual_tls": null, - "routes": [], - "tls_termination": null, - "uri": "https://api.ngrok.com/edges/https/edghts_2rcCv9v5JCRsPwWisboNMCmUw0h" -} -``` diff --git a/docs/api/examples/_edges_https_list_request.md b/docs/api/examples/_edges_https_list_request.md deleted file mode 100644 index 661521639a..0000000000 --- a/docs/api/examples/_edges_https_list_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/edges/https -``` diff --git a/docs/api/examples/_edges_https_list_response.md b/docs/api/examples/_edges_https_list_response.md deleted file mode 100644 index a968d2da21..0000000000 --- a/docs/api/examples/_edges_https_list_response.md +++ /dev/null @@ -1,23 +0,0 @@ - - -#### Example Response - -```json -{ - "https_edges": [ - { - "created_at": "2025-01-14T10:06:43Z", - "description": "acme https edge", - "hostports": ["example.com:443"], - "id": "edghts_2rcCv9v5JCRsPwWisboNMCmUw0h", - "metadata": "{\"environment\": \"staging\"}", - "mutual_tls": null, - "routes": [], - "tls_termination": null, - "uri": "https://api.ngrok.com/edges/https/edghts_2rcCv9v5JCRsPwWisboNMCmUw0h" - } - ], - "next_page_uri": null, - "uri": "https://api.ngrok.com/edges/https" -} -``` diff --git a/docs/api/examples/_edges_https_routes_create_request.md b/docs/api/examples/_edges_https_routes_create_request.md deleted file mode 100644 index aa512cd788..0000000000 --- a/docs/api/examples/_edges_https_routes_create_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X POST \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"description":"acme edge route","match":"/","match_type":"path_prefix","metadata":"{\"environment\": \"staging\"}"}' \ -https://api.ngrok.com/edges/https/edghts_2rcCvD6t8gEn8KpOh1fTjUKsR6x/routes -``` diff --git a/docs/api/examples/_edges_https_routes_create_response.md b/docs/api/examples/_edges_https_routes_create_response.md deleted file mode 100644 index 495ae12dbe..0000000000 --- a/docs/api/examples/_edges_https_routes_create_response.md +++ /dev/null @@ -1,30 +0,0 @@ - - -#### Example Response - -```json -{ - "backend": null, - "circuit_breaker": null, - "compression": null, - "created_at": "2025-01-14T10:06:44Z", - "description": "acme edge route", - "edge_id": "edghts_2rcCvD6t8gEn8KpOh1fTjUKsR6x", - "id": "edghtsrt_2rcCvCLDo9AvOMfaVFmsnkNELvN", - "ip_restriction": null, - "match": "/", - "match_type": "path_prefix", - "metadata": "{\"environment\": \"staging\"}", - "oauth": null, - "oidc": null, - "policy": null, - "request_headers": null, - "response_headers": null, - "saml": null, - "traffic_policy": null, - "uri": "https://api.ngrok.com/edges/https/edghts_2rcCvD6t8gEn8KpOh1fTjUKsR6x/routes/edghtsrt_2rcCvCLDo9AvOMfaVFmsnkNELvN", - "user_agent_filter": null, - "webhook_verification": null, - "websocket_tcp_converter": null -} -``` diff --git a/docs/api/examples/_edges_https_routes_delete_request.md b/docs/api/examples/_edges_https_routes_delete_request.md deleted file mode 100644 index c07ec2309c..0000000000 --- a/docs/api/examples/_edges_https_routes_delete_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X DELETE \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/edges/https/edghts_2rcCvD6t8gEn8KpOh1fTjUKsR6x/routes/edghtsrt_2rcCvCLDo9AvOMfaVFmsnkNELvN -``` diff --git a/docs/api/examples/_edges_https_routes_delete_response.md b/docs/api/examples/_edges_https_routes_delete_response.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/api/examples/_edges_https_routes_get_request.md b/docs/api/examples/_edges_https_routes_get_request.md deleted file mode 100644 index 628afe027d..0000000000 --- a/docs/api/examples/_edges_https_routes_get_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/edges/https/edghts_2rcCvD6t8gEn8KpOh1fTjUKsR6x/routes/edghtsrt_2rcCvCLDo9AvOMfaVFmsnkNELvN -``` diff --git a/docs/api/examples/_edges_https_routes_get_response.md b/docs/api/examples/_edges_https_routes_get_response.md deleted file mode 100644 index 495ae12dbe..0000000000 --- a/docs/api/examples/_edges_https_routes_get_response.md +++ /dev/null @@ -1,30 +0,0 @@ - - -#### Example Response - -```json -{ - "backend": null, - "circuit_breaker": null, - "compression": null, - "created_at": "2025-01-14T10:06:44Z", - "description": "acme edge route", - "edge_id": "edghts_2rcCvD6t8gEn8KpOh1fTjUKsR6x", - "id": "edghtsrt_2rcCvCLDo9AvOMfaVFmsnkNELvN", - "ip_restriction": null, - "match": "/", - "match_type": "path_prefix", - "metadata": "{\"environment\": \"staging\"}", - "oauth": null, - "oidc": null, - "policy": null, - "request_headers": null, - "response_headers": null, - "saml": null, - "traffic_policy": null, - "uri": "https://api.ngrok.com/edges/https/edghts_2rcCvD6t8gEn8KpOh1fTjUKsR6x/routes/edghtsrt_2rcCvCLDo9AvOMfaVFmsnkNELvN", - "user_agent_filter": null, - "webhook_verification": null, - "websocket_tcp_converter": null -} -``` diff --git a/docs/api/examples/_edges_https_routes_update_request.md b/docs/api/examples/_edges_https_routes_update_request.md deleted file mode 100644 index 02cd1725ba..0000000000 --- a/docs/api/examples/_edges_https_routes_update_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X PATCH \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"metadata":"{\"environment\": \"production\"}"}' \ -https://api.ngrok.com/edges/https/edghts_2rcCvD6t8gEn8KpOh1fTjUKsR6x/routes/edghtsrt_2rcCvCLDo9AvOMfaVFmsnkNELvN -``` diff --git a/docs/api/examples/_edges_https_routes_update_response.md b/docs/api/examples/_edges_https_routes_update_response.md deleted file mode 100644 index 2a5e711505..0000000000 --- a/docs/api/examples/_edges_https_routes_update_response.md +++ /dev/null @@ -1,30 +0,0 @@ - - -#### Example Response - -```json -{ - "backend": null, - "circuit_breaker": null, - "compression": null, - "created_at": "2025-01-14T10:06:44Z", - "description": "acme edge route", - "edge_id": "edghts_2rcCvD6t8gEn8KpOh1fTjUKsR6x", - "id": "edghtsrt_2rcCvCLDo9AvOMfaVFmsnkNELvN", - "ip_restriction": null, - "match": "/", - "match_type": "path_prefix", - "metadata": "{\"environment\": \"production\"}", - "oauth": null, - "oidc": null, - "policy": null, - "request_headers": null, - "response_headers": null, - "saml": null, - "traffic_policy": null, - "uri": "https://api.ngrok.com/edges/https/edghts_2rcCvD6t8gEn8KpOh1fTjUKsR6x/routes/edghtsrt_2rcCvCLDo9AvOMfaVFmsnkNELvN", - "user_agent_filter": null, - "webhook_verification": null, - "websocket_tcp_converter": null -} -``` diff --git a/docs/api/examples/_edges_https_update_request.md b/docs/api/examples/_edges_https_update_request.md deleted file mode 100644 index 1db570549b..0000000000 --- a/docs/api/examples/_edges_https_update_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X PATCH \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"metadata":"{\"environment\": \"production\"}"}' \ -https://api.ngrok.com/edges/https/edghts_2rcCv9v5JCRsPwWisboNMCmUw0h -``` diff --git a/docs/api/examples/_edges_https_update_response.md b/docs/api/examples/_edges_https_update_response.md deleted file mode 100644 index c90f06d46b..0000000000 --- a/docs/api/examples/_edges_https_update_response.md +++ /dev/null @@ -1,17 +0,0 @@ - - -#### Example Response - -```json -{ - "created_at": "2025-01-14T10:06:43Z", - "description": "acme https edge", - "hostports": ["example.com:443"], - "id": "edghts_2rcCv9v5JCRsPwWisboNMCmUw0h", - "metadata": "{\"environment\": \"production\"}", - "mutual_tls": null, - "routes": [], - "tls_termination": null, - "uri": "https://api.ngrok.com/edges/https/edghts_2rcCv9v5JCRsPwWisboNMCmUw0h" -} -``` diff --git a/docs/api/examples/_edges_tcp_create_request.md b/docs/api/examples/_edges_tcp_create_request.md deleted file mode 100644 index 4b4c3acc5c..0000000000 --- a/docs/api/examples/_edges_tcp_create_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X POST \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"description":"acme tcp edge","metadata":"{\"environment\": \"staging\"}"}' \ -https://api.ngrok.com/edges/tcp -``` diff --git a/docs/api/examples/_edges_tcp_create_response.md b/docs/api/examples/_edges_tcp_create_response.md deleted file mode 100644 index 04c1bdd041..0000000000 --- a/docs/api/examples/_edges_tcp_create_response.md +++ /dev/null @@ -1,18 +0,0 @@ - - -#### Example Response - -```json -{ - "backend": null, - "created_at": "2025-01-14T10:06:47Z", - "description": "acme tcp edge", - "hostports": null, - "id": "edgtcp_2rcCvYaCz4tUbWiCRVTCu2RsxrA", - "ip_restriction": null, - "metadata": "{\"environment\": \"staging\"}", - "policy": null, - "traffic_policy": null, - "uri": "https://api.ngrok.com/edges/tcp/edgtcp_2rcCvYaCz4tUbWiCRVTCu2RsxrA" -} -``` diff --git a/docs/api/examples/_edges_tcp_delete_request.md b/docs/api/examples/_edges_tcp_delete_request.md deleted file mode 100644 index f6fdde97c8..0000000000 --- a/docs/api/examples/_edges_tcp_delete_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X DELETE \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/edges/tcp/edgtcp_2rcCvYaCz4tUbWiCRVTCu2RsxrA -``` diff --git a/docs/api/examples/_edges_tcp_delete_response.md b/docs/api/examples/_edges_tcp_delete_response.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/api/examples/_edges_tcp_get_request.md b/docs/api/examples/_edges_tcp_get_request.md deleted file mode 100644 index f29c0cd7ea..0000000000 --- a/docs/api/examples/_edges_tcp_get_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/edges/tcp/edgtcp_2rcCvYaCz4tUbWiCRVTCu2RsxrA -``` diff --git a/docs/api/examples/_edges_tcp_get_response.md b/docs/api/examples/_edges_tcp_get_response.md deleted file mode 100644 index 04c1bdd041..0000000000 --- a/docs/api/examples/_edges_tcp_get_response.md +++ /dev/null @@ -1,18 +0,0 @@ - - -#### Example Response - -```json -{ - "backend": null, - "created_at": "2025-01-14T10:06:47Z", - "description": "acme tcp edge", - "hostports": null, - "id": "edgtcp_2rcCvYaCz4tUbWiCRVTCu2RsxrA", - "ip_restriction": null, - "metadata": "{\"environment\": \"staging\"}", - "policy": null, - "traffic_policy": null, - "uri": "https://api.ngrok.com/edges/tcp/edgtcp_2rcCvYaCz4tUbWiCRVTCu2RsxrA" -} -``` diff --git a/docs/api/examples/_edges_tcp_list_request.md b/docs/api/examples/_edges_tcp_list_request.md deleted file mode 100644 index 446503b11d..0000000000 --- a/docs/api/examples/_edges_tcp_list_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/edges/tcp -``` diff --git a/docs/api/examples/_edges_tcp_list_response.md b/docs/api/examples/_edges_tcp_list_response.md deleted file mode 100644 index 6ff38477a4..0000000000 --- a/docs/api/examples/_edges_tcp_list_response.md +++ /dev/null @@ -1,24 +0,0 @@ - - -#### Example Response - -```json -{ - "next_page_uri": null, - "tcp_edges": [ - { - "backend": null, - "created_at": "2025-01-14T10:06:47Z", - "description": "acme tcp edge", - "hostports": null, - "id": "edgtcp_2rcCvYaCz4tUbWiCRVTCu2RsxrA", - "ip_restriction": null, - "metadata": "{\"environment\": \"staging\"}", - "policy": null, - "traffic_policy": null, - "uri": "https://api.ngrok.com/edges/tcp/edgtcp_2rcCvYaCz4tUbWiCRVTCu2RsxrA" - } - ], - "uri": "https://api.ngrok.com/edges/tcp" -} -``` diff --git a/docs/api/examples/_edges_tcp_update_request.md b/docs/api/examples/_edges_tcp_update_request.md deleted file mode 100644 index 9ca8415a0d..0000000000 --- a/docs/api/examples/_edges_tcp_update_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X PATCH \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"metadata":"{\"environment\": \"production\"}"}' \ -https://api.ngrok.com/edges/tcp/edgtcp_2rcCvYaCz4tUbWiCRVTCu2RsxrA -``` diff --git a/docs/api/examples/_edges_tcp_update_response.md b/docs/api/examples/_edges_tcp_update_response.md deleted file mode 100644 index b766772379..0000000000 --- a/docs/api/examples/_edges_tcp_update_response.md +++ /dev/null @@ -1,18 +0,0 @@ - - -#### Example Response - -```json -{ - "backend": null, - "created_at": "2025-01-14T10:06:47Z", - "description": "acme tcp edge", - "hostports": null, - "id": "edgtcp_2rcCvYaCz4tUbWiCRVTCu2RsxrA", - "ip_restriction": null, - "metadata": "{\"environment\": \"production\"}", - "policy": null, - "traffic_policy": null, - "uri": "https://api.ngrok.com/edges/tcp/edgtcp_2rcCvYaCz4tUbWiCRVTCu2RsxrA" -} -``` diff --git a/docs/api/examples/_edges_tls_create_request.md b/docs/api/examples/_edges_tls_create_request.md deleted file mode 100644 index 13acfcddaf..0000000000 --- a/docs/api/examples/_edges_tls_create_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X POST \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"description":"acme tls edge","hostports":["example.com:443"],"metadata":"{\"environment\": \"staging\"}"}' \ -https://api.ngrok.com/edges/tls -``` diff --git a/docs/api/examples/_edges_tls_create_response.md b/docs/api/examples/_edges_tls_create_response.md deleted file mode 100644 index 3a224107c9..0000000000 --- a/docs/api/examples/_edges_tls_create_response.md +++ /dev/null @@ -1,20 +0,0 @@ - - -#### Example Response - -```json -{ - "backend": null, - "created_at": "2025-01-14T10:06:47Z", - "description": "acme tls edge", - "hostports": ["example.com:443"], - "id": "edgtls_2rcCvde7zJTvl6TwY5HLqJlwhXz", - "ip_restriction": null, - "metadata": "{\"environment\": \"staging\"}", - "mutual_tls": null, - "policy": null, - "tls_termination": null, - "traffic_policy": null, - "uri": "https://api.ngrok.com/edges/tls/edgtls_2rcCvde7zJTvl6TwY5HLqJlwhXz" -} -``` diff --git a/docs/api/examples/_edges_tls_delete_request.md b/docs/api/examples/_edges_tls_delete_request.md deleted file mode 100644 index 25fad7c64a..0000000000 --- a/docs/api/examples/_edges_tls_delete_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X DELETE \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/edges/tls/edgtls_2rcCvde7zJTvl6TwY5HLqJlwhXz -``` diff --git a/docs/api/examples/_edges_tls_delete_response.md b/docs/api/examples/_edges_tls_delete_response.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/api/examples/_edges_tls_get_request.md b/docs/api/examples/_edges_tls_get_request.md deleted file mode 100644 index c8cbc2189f..0000000000 --- a/docs/api/examples/_edges_tls_get_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/edges/tls/edgtls_2rcCvde7zJTvl6TwY5HLqJlwhXz -``` diff --git a/docs/api/examples/_edges_tls_get_response.md b/docs/api/examples/_edges_tls_get_response.md deleted file mode 100644 index 3a224107c9..0000000000 --- a/docs/api/examples/_edges_tls_get_response.md +++ /dev/null @@ -1,20 +0,0 @@ - - -#### Example Response - -```json -{ - "backend": null, - "created_at": "2025-01-14T10:06:47Z", - "description": "acme tls edge", - "hostports": ["example.com:443"], - "id": "edgtls_2rcCvde7zJTvl6TwY5HLqJlwhXz", - "ip_restriction": null, - "metadata": "{\"environment\": \"staging\"}", - "mutual_tls": null, - "policy": null, - "tls_termination": null, - "traffic_policy": null, - "uri": "https://api.ngrok.com/edges/tls/edgtls_2rcCvde7zJTvl6TwY5HLqJlwhXz" -} -``` diff --git a/docs/api/examples/_edges_tls_list_request.md b/docs/api/examples/_edges_tls_list_request.md deleted file mode 100644 index da1d207e39..0000000000 --- a/docs/api/examples/_edges_tls_list_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/edges/tls -``` diff --git a/docs/api/examples/_edges_tls_list_response.md b/docs/api/examples/_edges_tls_list_response.md deleted file mode 100644 index e70ea4cda2..0000000000 --- a/docs/api/examples/_edges_tls_list_response.md +++ /dev/null @@ -1,45 +0,0 @@ - - -#### Example Response - -```json -{ - "next_page_uri": null, - "tls_edges": [ - { - "backend": null, - "created_at": "2025-01-14T10:06:47Z", - "description": "acme tls edge", - "hostports": ["example.com:443"], - "id": "edgtls_2rcCvde7zJTvl6TwY5HLqJlwhXz", - "ip_restriction": null, - "metadata": "{\"environment\": \"staging\"}", - "mutual_tls": null, - "policy": null, - "tls_termination": null, - "traffic_policy": null, - "uri": "https://api.ngrok.com/edges/tls/edgtls_2rcCvde7zJTvl6TwY5HLqJlwhXz" - }, - { - "backend": { - "backend": { - "id": "bkdhr_2rcCu48LNH3HU7rx4s8N7kRJ5nP", - "uri": "https://api.ngrok.com/backends/http_response/bkdhr_2rcCu48LNH3HU7rx4s8N7kRJ5nP" - }, - "enabled": true - }, - "created_at": "2025-01-14T10:06:35Z", - "description": "acme tls edge", - "hostports": ["endpoint-example2.com:443"], - "id": "edgtls_2rcCu3Mv1sn41sQWC6XN2AOtaaH", - "ip_restriction": null, - "mutual_tls": null, - "policy": null, - "tls_termination": null, - "traffic_policy": null, - "uri": "https://api.ngrok.com/edges/tls/edgtls_2rcCu3Mv1sn41sQWC6XN2AOtaaH" - } - ], - "uri": "https://api.ngrok.com/edges/tls" -} -``` diff --git a/docs/api/examples/_edges_tls_update_request.md b/docs/api/examples/_edges_tls_update_request.md deleted file mode 100644 index c0b6c510e8..0000000000 --- a/docs/api/examples/_edges_tls_update_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X PATCH \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"metadata":"{\"environment\": \"production\"}"}' \ -https://api.ngrok.com/edges/tls/edgtls_2rcCvde7zJTvl6TwY5HLqJlwhXz -``` diff --git a/docs/api/examples/_edges_tls_update_response.md b/docs/api/examples/_edges_tls_update_response.md deleted file mode 100644 index 57c1f951dd..0000000000 --- a/docs/api/examples/_edges_tls_update_response.md +++ /dev/null @@ -1,20 +0,0 @@ - - -#### Example Response - -```json -{ - "backend": null, - "created_at": "2025-01-14T10:06:47Z", - "description": "acme tls edge", - "hostports": ["example.com:443"], - "id": "edgtls_2rcCvde7zJTvl6TwY5HLqJlwhXz", - "ip_restriction": null, - "metadata": "{\"environment\": \"production\"}", - "mutual_tls": null, - "policy": null, - "tls_termination": null, - "traffic_policy": null, - "uri": "https://api.ngrok.com/edges/tls/edgtls_2rcCvde7zJTvl6TwY5HLqJlwhXz" -} -``` diff --git a/docs/api/examples/_endpoint_basic_auth_module_delete_request.md b/docs/api/examples/_endpoint_basic_auth_module_delete_request.md deleted file mode 100644 index 202278d353..0000000000 --- a/docs/api/examples/_endpoint_basic_auth_module_delete_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X DELETE \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/endpoint_configurations/ec_2rcCuvaDKMCs4Li5cfnwsex2hdo/basic_auth -``` diff --git a/docs/api/examples/_endpoint_basic_auth_module_delete_response.md b/docs/api/examples/_endpoint_basic_auth_module_delete_response.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/api/examples/_endpoint_basic_auth_module_get_request.md b/docs/api/examples/_endpoint_basic_auth_module_get_request.md deleted file mode 100644 index 29ff4e5ae2..0000000000 --- a/docs/api/examples/_endpoint_basic_auth_module_get_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/endpoint_configurations/ec_2rcCuvaDKMCs4Li5cfnwsex2hdo/basic_auth -``` diff --git a/docs/api/examples/_endpoint_basic_auth_module_get_response.md b/docs/api/examples/_endpoint_basic_auth_module_get_response.md deleted file mode 100644 index 4324c02dc7..0000000000 --- a/docs/api/examples/_endpoint_basic_auth_module_get_response.md +++ /dev/null @@ -1,12 +0,0 @@ - - -#### Example Response - -```json -{ - "allow_options": true, - "auth_provider_id": "agent", - "enabled": true, - "realm": "" -} -``` diff --git a/docs/api/examples/_endpoint_basic_auth_module_replace_request.md b/docs/api/examples/_endpoint_basic_auth_module_replace_request.md deleted file mode 100644 index 844b8256e9..0000000000 --- a/docs/api/examples/_endpoint_basic_auth_module_replace_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X PUT \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"allow_options":true,"auth_provider_id":"agent"}' \ -https://api.ngrok.com/endpoint_configurations/ec_2rcCuvaDKMCs4Li5cfnwsex2hdo/basic_auth -``` diff --git a/docs/api/examples/_endpoint_basic_auth_module_replace_response.md b/docs/api/examples/_endpoint_basic_auth_module_replace_response.md deleted file mode 100644 index 4324c02dc7..0000000000 --- a/docs/api/examples/_endpoint_basic_auth_module_replace_response.md +++ /dev/null @@ -1,12 +0,0 @@ - - -#### Example Response - -```json -{ - "allow_options": true, - "auth_provider_id": "agent", - "enabled": true, - "realm": "" -} -``` diff --git a/docs/api/examples/_endpoint_circuit_breaker_module_delete_request.md b/docs/api/examples/_endpoint_circuit_breaker_module_delete_request.md deleted file mode 100644 index 7f997c3e08..0000000000 --- a/docs/api/examples/_endpoint_circuit_breaker_module_delete_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X DELETE \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/endpoint_configurations/ec_2rcCuvaDKMCs4Li5cfnwsex2hdo/circuit_breaker -``` diff --git a/docs/api/examples/_endpoint_circuit_breaker_module_delete_response.md b/docs/api/examples/_endpoint_circuit_breaker_module_delete_response.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/api/examples/_endpoint_circuit_breaker_module_get_request.md b/docs/api/examples/_endpoint_circuit_breaker_module_get_request.md deleted file mode 100644 index 24bf77b257..0000000000 --- a/docs/api/examples/_endpoint_circuit_breaker_module_get_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/endpoint_configurations/ec_2rcCuvaDKMCs4Li5cfnwsex2hdo/circuit_breaker -``` diff --git a/docs/api/examples/_endpoint_circuit_breaker_module_get_response.md b/docs/api/examples/_endpoint_circuit_breaker_module_get_response.md deleted file mode 100644 index b56bbca40f..0000000000 --- a/docs/api/examples/_endpoint_circuit_breaker_module_get_response.md +++ /dev/null @@ -1,14 +0,0 @@ - - -#### Example Response - -```json -{ - "enabled": true, - "error_threshold_percentage": 0.2, - "num_buckets": 5, - "rolling_window": 300, - "tripped_duration": 120, - "volume_threshold": 20 -} -``` diff --git a/docs/api/examples/_endpoint_circuit_breaker_module_replace_request.md b/docs/api/examples/_endpoint_circuit_breaker_module_replace_request.md deleted file mode 100644 index e2f130b56d..0000000000 --- a/docs/api/examples/_endpoint_circuit_breaker_module_replace_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X PUT \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"error_threshold_percentage":0.2,"num_buckets":5,"rolling_window":300,"tripped_duration":120,"volume_threshold":20}' \ -https://api.ngrok.com/endpoint_configurations/ec_2rcCuvaDKMCs4Li5cfnwsex2hdo/circuit_breaker -``` diff --git a/docs/api/examples/_endpoint_circuit_breaker_module_replace_response.md b/docs/api/examples/_endpoint_circuit_breaker_module_replace_response.md deleted file mode 100644 index b56bbca40f..0000000000 --- a/docs/api/examples/_endpoint_circuit_breaker_module_replace_response.md +++ /dev/null @@ -1,14 +0,0 @@ - - -#### Example Response - -```json -{ - "enabled": true, - "error_threshold_percentage": 0.2, - "num_buckets": 5, - "rolling_window": 300, - "tripped_duration": 120, - "volume_threshold": 20 -} -``` diff --git a/docs/api/examples/_endpoint_compression_module_delete_request.md b/docs/api/examples/_endpoint_compression_module_delete_request.md deleted file mode 100644 index c41274db06..0000000000 --- a/docs/api/examples/_endpoint_compression_module_delete_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X DELETE \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/endpoint_configurations/ec_2rcCuvaDKMCs4Li5cfnwsex2hdo/compression -``` diff --git a/docs/api/examples/_endpoint_compression_module_delete_response.md b/docs/api/examples/_endpoint_compression_module_delete_response.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/api/examples/_endpoint_compression_module_get_request.md b/docs/api/examples/_endpoint_compression_module_get_request.md deleted file mode 100644 index 04efe487d9..0000000000 --- a/docs/api/examples/_endpoint_compression_module_get_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/endpoint_configurations/ec_2rcCuvaDKMCs4Li5cfnwsex2hdo/compression -``` diff --git a/docs/api/examples/_endpoint_compression_module_get_response.md b/docs/api/examples/_endpoint_compression_module_get_response.md deleted file mode 100644 index 2317802fea..0000000000 --- a/docs/api/examples/_endpoint_compression_module_get_response.md +++ /dev/null @@ -1,9 +0,0 @@ - - -#### Example Response - -```json -{ - "enabled": false -} -``` diff --git a/docs/api/examples/_endpoint_compression_module_replace_request.md b/docs/api/examples/_endpoint_compression_module_replace_request.md deleted file mode 100644 index d093f66a5e..0000000000 --- a/docs/api/examples/_endpoint_compression_module_replace_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X PUT \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"enabled":false}' \ -https://api.ngrok.com/endpoint_configurations/ec_2rcCuvaDKMCs4Li5cfnwsex2hdo/compression -``` diff --git a/docs/api/examples/_endpoint_compression_module_replace_response.md b/docs/api/examples/_endpoint_compression_module_replace_response.md deleted file mode 100644 index 2317802fea..0000000000 --- a/docs/api/examples/_endpoint_compression_module_replace_response.md +++ /dev/null @@ -1,9 +0,0 @@ - - -#### Example Response - -```json -{ - "enabled": false -} -``` diff --git a/docs/api/examples/_endpoint_configurations_create_request.md b/docs/api/examples/_endpoint_configurations_create_request.md deleted file mode 100644 index 3f964b5494..0000000000 --- a/docs/api/examples/_endpoint_configurations_create_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X POST \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"description":"app servers","request_headers":{"add":{"x-frontend":"ngrok"},"remove":["cache-control"]},"type":"https"}' \ -https://api.ngrok.com/endpoint_configurations -``` diff --git a/docs/api/examples/_endpoint_configurations_create_response.md b/docs/api/examples/_endpoint_configurations_create_response.md deleted file mode 100644 index e544d7c3de..0000000000 --- a/docs/api/examples/_endpoint_configurations_create_response.md +++ /dev/null @@ -1,32 +0,0 @@ - - -#### Example Response - -```json -{ - "backend": null, - "basic_auth": null, - "circuit_breaker": null, - "compression": null, - "created_at": "2025-01-14T10:06:19Z", - "description": "app servers", - "id": "ec_2rcCs2TUspA15WKBwzgSI5EzmqN", - "ip_policy": null, - "mutual_tls": null, - "oauth": null, - "oidc": null, - "request_headers": { - "add": { - "x-frontend": "ngrok" - }, - "enabled": true, - "remove": ["cache-control"] - }, - "response_headers": null, - "saml": null, - "tls_termination": null, - "type": "https", - "uri": "https://api.ngrok.com/endpoint_configurations/ec_2rcCs2TUspA15WKBwzgSI5EzmqN", - "webhook_validation": null -} -``` diff --git a/docs/api/examples/_endpoint_configurations_delete_request.md b/docs/api/examples/_endpoint_configurations_delete_request.md deleted file mode 100644 index b0324eba67..0000000000 --- a/docs/api/examples/_endpoint_configurations_delete_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X DELETE \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/endpoint_configurations/ec_2rcCs2TUspA15WKBwzgSI5EzmqN -``` diff --git a/docs/api/examples/_endpoint_configurations_delete_response.md b/docs/api/examples/_endpoint_configurations_delete_response.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/api/examples/_endpoint_configurations_get_request.md b/docs/api/examples/_endpoint_configurations_get_request.md deleted file mode 100644 index 04effbc3a9..0000000000 --- a/docs/api/examples/_endpoint_configurations_get_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/endpoint_configurations/ec_2rcCs2TUspA15WKBwzgSI5EzmqN -``` diff --git a/docs/api/examples/_endpoint_configurations_get_response.md b/docs/api/examples/_endpoint_configurations_get_response.md deleted file mode 100644 index 0202a68b57..0000000000 --- a/docs/api/examples/_endpoint_configurations_get_response.md +++ /dev/null @@ -1,40 +0,0 @@ - - -#### Example Response - -```json -{ - "backend": null, - "basic_auth": null, - "circuit_breaker": null, - "compression": null, - "created_at": "2025-01-14T10:06:19Z", - "description": "app servers", - "id": "ec_2rcCs2TUspA15WKBwzgSI5EzmqN", - "ip_policy": { - "enabled": true, - "ip_policies": [ - { - "id": "ipp_2rcCs4XjqVMoCjxe2RmC2X3H1jh", - "uri": "https://api.ngrok.com/ip_policies/ipp_2rcCs4XjqVMoCjxe2RmC2X3H1jh" - } - ] - }, - "mutual_tls": null, - "oauth": null, - "oidc": null, - "request_headers": { - "add": { - "x-frontend": "ngrok" - }, - "enabled": true, - "remove": ["cache-control"] - }, - "response_headers": null, - "saml": null, - "tls_termination": null, - "type": "https", - "uri": "https://api.ngrok.com/endpoint_configurations/ec_2rcCs2TUspA15WKBwzgSI5EzmqN", - "webhook_validation": null -} -``` diff --git a/docs/api/examples/_endpoint_configurations_list_request.md b/docs/api/examples/_endpoint_configurations_list_request.md deleted file mode 100644 index aae4dd75f5..0000000000 --- a/docs/api/examples/_endpoint_configurations_list_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/endpoint_configurations -``` diff --git a/docs/api/examples/_endpoint_configurations_list_response.md b/docs/api/examples/_endpoint_configurations_list_response.md deleted file mode 100644 index 46b084a69b..0000000000 --- a/docs/api/examples/_endpoint_configurations_list_response.md +++ /dev/null @@ -1,74 +0,0 @@ - - -#### Example Response - -```json -{ - "endpoint_configurations": [ - { - "backend": null, - "basic_auth": null, - "circuit_breaker": { - "enabled": true, - "error_threshold_percentage": 0.2, - "num_buckets": 0, - "rolling_window": 0, - "tripped_duration": 0, - "volume_threshold": 0 - }, - "compression": { - "enabled": true - }, - "created_at": "2025-01-14T10:06:19Z", - "description": "web servers", - "id": "ec_2rcCs7KetFWlyNjqnP4Gsz33H2i", - "ip_policy": null, - "mutual_tls": null, - "oauth": null, - "oidc": null, - "request_headers": null, - "response_headers": { - "add": { - "content-security-policy": "script-src 'self'", - "x-frame-options": "DENY" - }, - "enabled": true, - "remove": [] - }, - "saml": null, - "tls_termination": null, - "type": "https", - "uri": "https://api.ngrok.com/endpoint_configurations/ec_2rcCs7KetFWlyNjqnP4Gsz33H2i", - "webhook_validation": null - }, - { - "backend": null, - "basic_auth": null, - "circuit_breaker": null, - "compression": null, - "created_at": "2025-01-14T10:06:19Z", - "description": "app servers", - "id": "ec_2rcCs2TUspA15WKBwzgSI5EzmqN", - "ip_policy": null, - "mutual_tls": null, - "oauth": null, - "oidc": null, - "request_headers": { - "add": { - "x-frontend": "ngrok" - }, - "enabled": true, - "remove": ["cache-control"] - }, - "response_headers": null, - "saml": null, - "tls_termination": null, - "type": "https", - "uri": "https://api.ngrok.com/endpoint_configurations/ec_2rcCs2TUspA15WKBwzgSI5EzmqN", - "webhook_validation": null - } - ], - "next_page_uri": null, - "uri": "https://api.ngrok.com/endpoint_configurations" -} -``` diff --git a/docs/api/examples/_endpoint_configurations_update_request.md b/docs/api/examples/_endpoint_configurations_update_request.md deleted file mode 100644 index 41c259ce67..0000000000 --- a/docs/api/examples/_endpoint_configurations_update_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X PATCH \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"ip_policy":{"ip_policy_ids":["ipp_2rcCs4XjqVMoCjxe2RmC2X3H1jh"]}}' \ -https://api.ngrok.com/endpoint_configurations/ec_2rcCs2TUspA15WKBwzgSI5EzmqN -``` diff --git a/docs/api/examples/_endpoint_configurations_update_response.md b/docs/api/examples/_endpoint_configurations_update_response.md deleted file mode 100644 index 0202a68b57..0000000000 --- a/docs/api/examples/_endpoint_configurations_update_response.md +++ /dev/null @@ -1,40 +0,0 @@ - - -#### Example Response - -```json -{ - "backend": null, - "basic_auth": null, - "circuit_breaker": null, - "compression": null, - "created_at": "2025-01-14T10:06:19Z", - "description": "app servers", - "id": "ec_2rcCs2TUspA15WKBwzgSI5EzmqN", - "ip_policy": { - "enabled": true, - "ip_policies": [ - { - "id": "ipp_2rcCs4XjqVMoCjxe2RmC2X3H1jh", - "uri": "https://api.ngrok.com/ip_policies/ipp_2rcCs4XjqVMoCjxe2RmC2X3H1jh" - } - ] - }, - "mutual_tls": null, - "oauth": null, - "oidc": null, - "request_headers": { - "add": { - "x-frontend": "ngrok" - }, - "enabled": true, - "remove": ["cache-control"] - }, - "response_headers": null, - "saml": null, - "tls_termination": null, - "type": "https", - "uri": "https://api.ngrok.com/endpoint_configurations/ec_2rcCs2TUspA15WKBwzgSI5EzmqN", - "webhook_validation": null -} -``` diff --git a/docs/api/examples/_endpoint_ip_policy_module_delete_request.md b/docs/api/examples/_endpoint_ip_policy_module_delete_request.md deleted file mode 100644 index ac8bca46dd..0000000000 --- a/docs/api/examples/_endpoint_ip_policy_module_delete_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X DELETE \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/endpoint_configurations/ec_2rcCuvaDKMCs4Li5cfnwsex2hdo/ip_policy -``` diff --git a/docs/api/examples/_endpoint_ip_policy_module_delete_response.md b/docs/api/examples/_endpoint_ip_policy_module_delete_response.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/api/examples/_endpoint_ip_policy_module_get_request.md b/docs/api/examples/_endpoint_ip_policy_module_get_request.md deleted file mode 100644 index ee8d50e616..0000000000 --- a/docs/api/examples/_endpoint_ip_policy_module_get_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/endpoint_configurations/ec_2rcCuvaDKMCs4Li5cfnwsex2hdo/ip_policy -``` diff --git a/docs/api/examples/_endpoint_ip_policy_module_get_response.md b/docs/api/examples/_endpoint_ip_policy_module_get_response.md deleted file mode 100644 index 35a849cca0..0000000000 --- a/docs/api/examples/_endpoint_ip_policy_module_get_response.md +++ /dev/null @@ -1,15 +0,0 @@ - - -#### Example Response - -```json -{ - "enabled": true, - "ip_policies": [ - { - "id": "ipp_2rcCv2jhs1HudVLSuVIe16uDlnB", - "uri": "https://api.ngrok.com/ip_policies/ipp_2rcCv2jhs1HudVLSuVIe16uDlnB" - } - ] -} -``` diff --git a/docs/api/examples/_endpoint_ip_policy_module_replace_request.md b/docs/api/examples/_endpoint_ip_policy_module_replace_request.md deleted file mode 100644 index 9e6f491bc9..0000000000 --- a/docs/api/examples/_endpoint_ip_policy_module_replace_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X PUT \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"ip_policy_ids":["ipp_2rcCv2jhs1HudVLSuVIe16uDlnB"]}' \ -https://api.ngrok.com/endpoint_configurations/ec_2rcCuvaDKMCs4Li5cfnwsex2hdo/ip_policy -``` diff --git a/docs/api/examples/_endpoint_ip_policy_module_replace_response.md b/docs/api/examples/_endpoint_ip_policy_module_replace_response.md deleted file mode 100644 index 35a849cca0..0000000000 --- a/docs/api/examples/_endpoint_ip_policy_module_replace_response.md +++ /dev/null @@ -1,15 +0,0 @@ - - -#### Example Response - -```json -{ - "enabled": true, - "ip_policies": [ - { - "id": "ipp_2rcCv2jhs1HudVLSuVIe16uDlnB", - "uri": "https://api.ngrok.com/ip_policies/ipp_2rcCv2jhs1HudVLSuVIe16uDlnB" - } - ] -} -``` diff --git a/docs/api/examples/_endpoint_mutual_tls_module_delete_request.md b/docs/api/examples/_endpoint_mutual_tls_module_delete_request.md deleted file mode 100644 index c71290715d..0000000000 --- a/docs/api/examples/_endpoint_mutual_tls_module_delete_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X DELETE \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/endpoint_configurations/ec_2rcCuvaDKMCs4Li5cfnwsex2hdo/mutual_tls -``` diff --git a/docs/api/examples/_endpoint_mutual_tls_module_delete_response.md b/docs/api/examples/_endpoint_mutual_tls_module_delete_response.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/api/examples/_endpoint_mutual_tls_module_get_request.md b/docs/api/examples/_endpoint_mutual_tls_module_get_request.md deleted file mode 100644 index 27ce1b9045..0000000000 --- a/docs/api/examples/_endpoint_mutual_tls_module_get_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/endpoint_configurations/ec_2rcCuvaDKMCs4Li5cfnwsex2hdo/mutual_tls -``` diff --git a/docs/api/examples/_endpoint_mutual_tls_module_get_response.md b/docs/api/examples/_endpoint_mutual_tls_module_get_response.md deleted file mode 100644 index d803b2bccf..0000000000 --- a/docs/api/examples/_endpoint_mutual_tls_module_get_response.md +++ /dev/null @@ -1,15 +0,0 @@ - - -#### Example Response - -```json -{ - "certificate_authorities": [ - { - "id": "ca_2rcCv0cp1vuwkakfArouRMOyHBz", - "uri": "https://api.ngrok.com/certificate_authorities/ca_2rcCv0cp1vuwkakfArouRMOyHBz" - } - ], - "enabled": true -} -``` diff --git a/docs/api/examples/_endpoint_mutual_tls_module_replace_request.md b/docs/api/examples/_endpoint_mutual_tls_module_replace_request.md deleted file mode 100644 index 2765fac041..0000000000 --- a/docs/api/examples/_endpoint_mutual_tls_module_replace_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X PUT \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"certificate_authority_ids":["ca_2rcCv0cp1vuwkakfArouRMOyHBz"],"enabled":true}' \ -https://api.ngrok.com/endpoint_configurations/ec_2rcCuvaDKMCs4Li5cfnwsex2hdo/mutual_tls -``` diff --git a/docs/api/examples/_endpoint_mutual_tls_module_replace_response.md b/docs/api/examples/_endpoint_mutual_tls_module_replace_response.md deleted file mode 100644 index d803b2bccf..0000000000 --- a/docs/api/examples/_endpoint_mutual_tls_module_replace_response.md +++ /dev/null @@ -1,15 +0,0 @@ - - -#### Example Response - -```json -{ - "certificate_authorities": [ - { - "id": "ca_2rcCv0cp1vuwkakfArouRMOyHBz", - "uri": "https://api.ngrok.com/certificate_authorities/ca_2rcCv0cp1vuwkakfArouRMOyHBz" - } - ], - "enabled": true -} -``` diff --git a/docs/api/examples/_endpoint_o_auth_module_delete_request.md b/docs/api/examples/_endpoint_o_auth_module_delete_request.md deleted file mode 100644 index ffc061d8be..0000000000 --- a/docs/api/examples/_endpoint_o_auth_module_delete_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X DELETE \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/endpoint_configurations/ec_2rcCuvaDKMCs4Li5cfnwsex2hdo/oauth -``` diff --git a/docs/api/examples/_endpoint_o_auth_module_delete_response.md b/docs/api/examples/_endpoint_o_auth_module_delete_response.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/api/examples/_endpoint_o_auth_module_get_request.md b/docs/api/examples/_endpoint_o_auth_module_get_request.md deleted file mode 100644 index feaab51d94..0000000000 --- a/docs/api/examples/_endpoint_o_auth_module_get_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/endpoint_configurations/ec_2rcCuvaDKMCs4Li5cfnwsex2hdo/oauth -``` diff --git a/docs/api/examples/_endpoint_o_auth_module_get_response.md b/docs/api/examples/_endpoint_o_auth_module_get_response.md deleted file mode 100644 index 11952498b1..0000000000 --- a/docs/api/examples/_endpoint_o_auth_module_get_response.md +++ /dev/null @@ -1,34 +0,0 @@ - - -#### Example Response - -```json -{ - "auth_check_interval": 0, - "cookie_prefix": "ngrok.", - "enabled": true, - "inactivity_timeout": 0, - "maximum_duration": 0, - "options_passthrough": true, - "provider": { - "amazon": null, - "facebook": null, - "github": null, - "gitlab": null, - "google": { - "client_id": "client-id", - "client_secret": "client-secret", - "email_addresses": ["alan@example.com"], - "email_domains": [], - "scopes": [ - "profile", - "email", - "https://www.googleapis.com/auth/gmail.compose" - ] - }, - "linkedin": null, - "microsoft": null, - "twitch": null - } -} -``` diff --git a/docs/api/examples/_endpoint_o_auth_module_replace_request.md b/docs/api/examples/_endpoint_o_auth_module_replace_request.md deleted file mode 100644 index 6fb5391747..0000000000 --- a/docs/api/examples/_endpoint_o_auth_module_replace_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X PUT \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"options_passthrough":true,"provider":{"google":{"client_id":"client-id","client_secret":"client-secret","email_addresses":["alan@example.com"],"scopes":["profile","email","https://www.googleapis.com/auth/gmail.compose"]}}}' \ -https://api.ngrok.com/endpoint_configurations/ec_2rcCuvaDKMCs4Li5cfnwsex2hdo/oauth -``` diff --git a/docs/api/examples/_endpoint_o_auth_module_replace_response.md b/docs/api/examples/_endpoint_o_auth_module_replace_response.md deleted file mode 100644 index 11952498b1..0000000000 --- a/docs/api/examples/_endpoint_o_auth_module_replace_response.md +++ /dev/null @@ -1,34 +0,0 @@ - - -#### Example Response - -```json -{ - "auth_check_interval": 0, - "cookie_prefix": "ngrok.", - "enabled": true, - "inactivity_timeout": 0, - "maximum_duration": 0, - "options_passthrough": true, - "provider": { - "amazon": null, - "facebook": null, - "github": null, - "gitlab": null, - "google": { - "client_id": "client-id", - "client_secret": "client-secret", - "email_addresses": ["alan@example.com"], - "email_domains": [], - "scopes": [ - "profile", - "email", - "https://www.googleapis.com/auth/gmail.compose" - ] - }, - "linkedin": null, - "microsoft": null, - "twitch": null - } -} -``` diff --git a/docs/api/examples/_endpoint_oidc_module_delete_request.md b/docs/api/examples/_endpoint_oidc_module_delete_request.md deleted file mode 100644 index e2624da71d..0000000000 --- a/docs/api/examples/_endpoint_oidc_module_delete_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X DELETE \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/endpoint_configurations/ec_2rcCuvaDKMCs4Li5cfnwsex2hdo/oidc -``` diff --git a/docs/api/examples/_endpoint_oidc_module_delete_response.md b/docs/api/examples/_endpoint_oidc_module_delete_response.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/api/examples/_endpoint_oidc_module_get_request.md b/docs/api/examples/_endpoint_oidc_module_get_request.md deleted file mode 100644 index bbe34c0594..0000000000 --- a/docs/api/examples/_endpoint_oidc_module_get_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/endpoint_configurations/ec_2rcCuvaDKMCs4Li5cfnwsex2hdo/oidc -``` diff --git a/docs/api/examples/_endpoint_oidc_module_get_response.md b/docs/api/examples/_endpoint_oidc_module_get_response.md deleted file mode 100644 index 4e160f5673..0000000000 --- a/docs/api/examples/_endpoint_oidc_module_get_response.md +++ /dev/null @@ -1,17 +0,0 @@ - - -#### Example Response - -```json -{ - "client_id": "some-client-id", - "client_secret": "some-client-secret", - "cookie_prefix": "", - "enabled": true, - "inactivity_timeout": 0, - "issuer": "https://accounts.google.com", - "maximum_duration": 0, - "options_passthrough": false, - "scopes": ["profile"] -} -``` diff --git a/docs/api/examples/_endpoint_oidc_module_replace_request.md b/docs/api/examples/_endpoint_oidc_module_replace_request.md deleted file mode 100644 index 15bce55403..0000000000 --- a/docs/api/examples/_endpoint_oidc_module_replace_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X PUT \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"client_id":"some-client-id","client_secret":"some-client-secret","enabled":true,"issuer":"https://accounts.google.com","scopes":["profile"]}' \ -https://api.ngrok.com/endpoint_configurations/ec_2rcCuvaDKMCs4Li5cfnwsex2hdo/oidc -``` diff --git a/docs/api/examples/_endpoint_oidc_module_replace_response.md b/docs/api/examples/_endpoint_oidc_module_replace_response.md deleted file mode 100644 index 4e160f5673..0000000000 --- a/docs/api/examples/_endpoint_oidc_module_replace_response.md +++ /dev/null @@ -1,17 +0,0 @@ - - -#### Example Response - -```json -{ - "client_id": "some-client-id", - "client_secret": "some-client-secret", - "cookie_prefix": "", - "enabled": true, - "inactivity_timeout": 0, - "issuer": "https://accounts.google.com", - "maximum_duration": 0, - "options_passthrough": false, - "scopes": ["profile"] -} -``` diff --git a/docs/api/examples/_endpoint_request_headers_module_delete_request.md b/docs/api/examples/_endpoint_request_headers_module_delete_request.md deleted file mode 100644 index a5117a7033..0000000000 --- a/docs/api/examples/_endpoint_request_headers_module_delete_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X DELETE \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/endpoint_configurations/ec_2rcCuvaDKMCs4Li5cfnwsex2hdo/request_headers -``` diff --git a/docs/api/examples/_endpoint_request_headers_module_delete_response.md b/docs/api/examples/_endpoint_request_headers_module_delete_response.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/api/examples/_endpoint_request_headers_module_get_request.md b/docs/api/examples/_endpoint_request_headers_module_get_request.md deleted file mode 100644 index 65aa495e62..0000000000 --- a/docs/api/examples/_endpoint_request_headers_module_get_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/endpoint_configurations/ec_2rcCuvaDKMCs4Li5cfnwsex2hdo/request_headers -``` diff --git a/docs/api/examples/_endpoint_request_headers_module_get_response.md b/docs/api/examples/_endpoint_request_headers_module_get_response.md deleted file mode 100644 index 1a81c64752..0000000000 --- a/docs/api/examples/_endpoint_request_headers_module_get_response.md +++ /dev/null @@ -1,14 +0,0 @@ - - -#### Example Response - -```json -{ - "add": { - "x-baz": "qux", - "x-foo": "bar" - }, - "enabled": true, - "remove": ["x-internal-header"] -} -``` diff --git a/docs/api/examples/_endpoint_request_headers_module_replace_request.md b/docs/api/examples/_endpoint_request_headers_module_replace_request.md deleted file mode 100644 index 5f8fd2136f..0000000000 --- a/docs/api/examples/_endpoint_request_headers_module_replace_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X PUT \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"add":{"X-Baz":"qux","X-Foo":"bar"},"remove":["X-Internal-Header"]}' \ -https://api.ngrok.com/endpoint_configurations/ec_2rcCuvaDKMCs4Li5cfnwsex2hdo/request_headers -``` diff --git a/docs/api/examples/_endpoint_request_headers_module_replace_response.md b/docs/api/examples/_endpoint_request_headers_module_replace_response.md deleted file mode 100644 index 1a81c64752..0000000000 --- a/docs/api/examples/_endpoint_request_headers_module_replace_response.md +++ /dev/null @@ -1,14 +0,0 @@ - - -#### Example Response - -```json -{ - "add": { - "x-baz": "qux", - "x-foo": "bar" - }, - "enabled": true, - "remove": ["x-internal-header"] -} -``` diff --git a/docs/api/examples/_endpoint_response_headers_module_delete_request.md b/docs/api/examples/_endpoint_response_headers_module_delete_request.md deleted file mode 100644 index d47a4c043e..0000000000 --- a/docs/api/examples/_endpoint_response_headers_module_delete_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X DELETE \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/endpoint_configurations/ec_2rcCuvaDKMCs4Li5cfnwsex2hdo/response_headers -``` diff --git a/docs/api/examples/_endpoint_response_headers_module_delete_response.md b/docs/api/examples/_endpoint_response_headers_module_delete_response.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/api/examples/_endpoint_response_headers_module_get_request.md b/docs/api/examples/_endpoint_response_headers_module_get_request.md deleted file mode 100644 index e577d1c538..0000000000 --- a/docs/api/examples/_endpoint_response_headers_module_get_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/endpoint_configurations/ec_2rcCuvaDKMCs4Li5cfnwsex2hdo/response_headers -``` diff --git a/docs/api/examples/_endpoint_response_headers_module_get_response.md b/docs/api/examples/_endpoint_response_headers_module_get_response.md deleted file mode 100644 index 81740b9d04..0000000000 --- a/docs/api/examples/_endpoint_response_headers_module_get_response.md +++ /dev/null @@ -1,14 +0,0 @@ - - -#### Example Response - -```json -{ - "add": { - "cache-control": "no-cache, no-store", - "x-xss-protection": "1; mode=block" - }, - "enabled": true, - "remove": [] -} -``` diff --git a/docs/api/examples/_endpoint_response_headers_module_replace_request.md b/docs/api/examples/_endpoint_response_headers_module_replace_request.md deleted file mode 100644 index 8befd0c8ae..0000000000 --- a/docs/api/examples/_endpoint_response_headers_module_replace_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X PUT \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"add":{"Cache-Control":"no-cache, no-store","X-XSS-Protection":"1; mode=block"}}' \ -https://api.ngrok.com/endpoint_configurations/ec_2rcCuvaDKMCs4Li5cfnwsex2hdo/response_headers -``` diff --git a/docs/api/examples/_endpoint_response_headers_module_replace_response.md b/docs/api/examples/_endpoint_response_headers_module_replace_response.md deleted file mode 100644 index 81740b9d04..0000000000 --- a/docs/api/examples/_endpoint_response_headers_module_replace_response.md +++ /dev/null @@ -1,14 +0,0 @@ - - -#### Example Response - -```json -{ - "add": { - "cache-control": "no-cache, no-store", - "x-xss-protection": "1; mode=block" - }, - "enabled": true, - "remove": [] -} -``` diff --git a/docs/api/examples/_endpoint_saml_module_delete_request.md b/docs/api/examples/_endpoint_saml_module_delete_request.md deleted file mode 100644 index 2ff548b889..0000000000 --- a/docs/api/examples/_endpoint_saml_module_delete_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X DELETE \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/endpoint_configurations/ec_2rcCuvaDKMCs4Li5cfnwsex2hdo/saml -``` diff --git a/docs/api/examples/_endpoint_saml_module_delete_response.md b/docs/api/examples/_endpoint_saml_module_delete_response.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/api/examples/_endpoint_saml_module_get_request.md b/docs/api/examples/_endpoint_saml_module_get_request.md deleted file mode 100644 index fe385b2b19..0000000000 --- a/docs/api/examples/_endpoint_saml_module_get_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/endpoint_configurations/ec_2rcCuvaDKMCs4Li5cfnwsex2hdo/saml -``` diff --git a/docs/api/examples/_endpoint_saml_module_get_response.md b/docs/api/examples/_endpoint_saml_module_get_response.md deleted file mode 100644 index 83c19abbc6..0000000000 --- a/docs/api/examples/_endpoint_saml_module_get_response.md +++ /dev/null @@ -1,24 +0,0 @@ - - -#### Example Response - -```json -{ - "allow_idp_initiated": true, - "assertion_consumer_service_url": "https://idp.local-ngrok.com/saml/ec_2rcCuvaDKMCs4Li5cfnwsex2hdo/acs", - "authorized_groups": [], - "cookie_prefix": "", - "enabled": true, - "entity_id": "https://idp.local-ngrok.com/saml/ec_2rcCuvaDKMCs4Li5cfnwsex2hdo", - "force_authn": false, - "idp_metadata": "\nurn:oasis:names:tc:SAML:2.0:nameid-format:transient\n", - "idp_metadata_url": "", - "inactivity_timeout": 0, - "maximum_duration": 0, - "metadata_url": "https://idp.local-ngrok.com/saml/ec_2rcCuvaDKMCs4Li5cfnwsex2hdo", - "nameid_format": "urn:oasis:names:tc:SAML:2.0:nameid-format:persistent", - "options_passthrough": false, - "request_signing_certificate_pem": "-----BEGIN CERTIFICATE-----\nMIID7DCCAtSgAwIBAgIRAJwpeP8XI3nDV6w/4z3gPvkwDQYJKoZIhvcNAQELBQAw\ngZQxSDBGBgNVBAoMP2h0dHBzOi8vaWRwLmxvY2FsLW5ncm9rLmNvbS9zYW1sL2Vj\nXzJyY0N1dmFES01DczRMaTVjZm53c2V4MmhkbzFIMEYGA1UEAww/aHR0cHM6Ly9p\nZHAubG9jYWwtbmdyb2suY29tL3NhbWwvZWNfMnJjQ3V2YURLTUNzNExpNWNmbndz\nZXgyaGRvMCAXDTI1MDExNDEwMDY0MloYDzIwNjAwMTA2MTAwNjQyWjCBlDFIMEYG\nA1UECgw/aHR0cHM6Ly9pZHAubG9jYWwtbmdyb2suY29tL3NhbWwvZWNfMnJjQ3V2\nYURLTUNzNExpNWNmbndzZXgyaGRvMUgwRgYDVQQDDD9odHRwczovL2lkcC5sb2Nh\nbC1uZ3Jvay5jb20vc2FtbC9lY18ycmNDdXZhREtNQ3M0TGk1Y2Zud3NleDJoZG8w\nggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCZzSEndez+MKFkfIk0VeP0\n7SUMot1QHC6mIWpi9cki1vJ86E3z8GTjwDo/1Q+2pQxzpzLc/wA4+YXpGVV6XEJ+\n8Zmg+wcKALqjVj2+TZnMiKOLPx8rTXZxHr880obSDlZKzsAr3vJ58BAbxgNop7SC\n7mw0jcH7/QNROXp9teJnTb2ukw/GbCGts/YJ9WGyHFis2579xHC6LH9gnhkdbgzC\nXFC9oYWIFET8Y9jjEm5FJO6KAqTViFmsMuHgtQPVclmf9JVfedKoe1fw9IE7pWgJ\nEgZBoO3hWt8nGZmmvxoCg+A2cWHqfaCYz0t7vG7SWpkIW+NKRGblxPylEcJpTJgv\nAgMBAAGjNTAzMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDATAM\nBgNVHRMBAf8EAjAAMA0GCSqGSIb3DQEBCwUAA4IBAQAaq47Xhg+gnBZWlauntwqz\nongkeDyIa5JbtKqyVPE1iQALFz64eZP+TWHKkY8Z6aoZCj7PxLAn4nmE2BYU5DV4\nzz4V8e8X2q0s1PvLEZU/aWiKK3/ewcvMURrm6tTXpiEdIkSiEaoIrwTAmIwUEfX5\nJLcGgs3URo4nEtnKhWBuAH7r4sliMZk4GPQwM0wafiS3r3FuI6yFX5gVh78CfvLU\nDrhyp6E57QefIZG7G0Fr38CtwgPNA0T/L53kzZfm1B4b5AwHlMmSCkl3XVNuaw83\nGLIF/3ktsU2pli/PC1gOmcuxE3zy1hoG03MiIs9zFSM++VAI5/a+hbGdy0k1IcZW\n-----END CERTIFICATE-----\n", - "single_logout_url": "https://idp.local-ngrok.com/saml/ec_2rcCuvaDKMCs4Li5cfnwsex2hdo/slo" -} -``` diff --git a/docs/api/examples/_endpoint_saml_module_replace_request.md b/docs/api/examples/_endpoint_saml_module_replace_request.md deleted file mode 100644 index bcffd52430..0000000000 --- a/docs/api/examples/_endpoint_saml_module_replace_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X PUT \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"enabled":true,"idp_metadata":"\nurn:oasis:names:tc:SAML:2.0:nameid-format:transient\n"}' \ -https://api.ngrok.com/endpoint_configurations/ec_2rcCuvaDKMCs4Li5cfnwsex2hdo/saml -``` diff --git a/docs/api/examples/_endpoint_saml_module_replace_response.md b/docs/api/examples/_endpoint_saml_module_replace_response.md deleted file mode 100644 index 83c19abbc6..0000000000 --- a/docs/api/examples/_endpoint_saml_module_replace_response.md +++ /dev/null @@ -1,24 +0,0 @@ - - -#### Example Response - -```json -{ - "allow_idp_initiated": true, - "assertion_consumer_service_url": "https://idp.local-ngrok.com/saml/ec_2rcCuvaDKMCs4Li5cfnwsex2hdo/acs", - "authorized_groups": [], - "cookie_prefix": "", - "enabled": true, - "entity_id": "https://idp.local-ngrok.com/saml/ec_2rcCuvaDKMCs4Li5cfnwsex2hdo", - "force_authn": false, - "idp_metadata": "\nurn:oasis:names:tc:SAML:2.0:nameid-format:transient\n", - "idp_metadata_url": "", - "inactivity_timeout": 0, - "maximum_duration": 0, - "metadata_url": "https://idp.local-ngrok.com/saml/ec_2rcCuvaDKMCs4Li5cfnwsex2hdo", - "nameid_format": "urn:oasis:names:tc:SAML:2.0:nameid-format:persistent", - "options_passthrough": false, - "request_signing_certificate_pem": "-----BEGIN CERTIFICATE-----\nMIID7DCCAtSgAwIBAgIRAJwpeP8XI3nDV6w/4z3gPvkwDQYJKoZIhvcNAQELBQAw\ngZQxSDBGBgNVBAoMP2h0dHBzOi8vaWRwLmxvY2FsLW5ncm9rLmNvbS9zYW1sL2Vj\nXzJyY0N1dmFES01DczRMaTVjZm53c2V4MmhkbzFIMEYGA1UEAww/aHR0cHM6Ly9p\nZHAubG9jYWwtbmdyb2suY29tL3NhbWwvZWNfMnJjQ3V2YURLTUNzNExpNWNmbndz\nZXgyaGRvMCAXDTI1MDExNDEwMDY0MloYDzIwNjAwMTA2MTAwNjQyWjCBlDFIMEYG\nA1UECgw/aHR0cHM6Ly9pZHAubG9jYWwtbmdyb2suY29tL3NhbWwvZWNfMnJjQ3V2\nYURLTUNzNExpNWNmbndzZXgyaGRvMUgwRgYDVQQDDD9odHRwczovL2lkcC5sb2Nh\nbC1uZ3Jvay5jb20vc2FtbC9lY18ycmNDdXZhREtNQ3M0TGk1Y2Zud3NleDJoZG8w\nggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCZzSEndez+MKFkfIk0VeP0\n7SUMot1QHC6mIWpi9cki1vJ86E3z8GTjwDo/1Q+2pQxzpzLc/wA4+YXpGVV6XEJ+\n8Zmg+wcKALqjVj2+TZnMiKOLPx8rTXZxHr880obSDlZKzsAr3vJ58BAbxgNop7SC\n7mw0jcH7/QNROXp9teJnTb2ukw/GbCGts/YJ9WGyHFis2579xHC6LH9gnhkdbgzC\nXFC9oYWIFET8Y9jjEm5FJO6KAqTViFmsMuHgtQPVclmf9JVfedKoe1fw9IE7pWgJ\nEgZBoO3hWt8nGZmmvxoCg+A2cWHqfaCYz0t7vG7SWpkIW+NKRGblxPylEcJpTJgv\nAgMBAAGjNTAzMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDATAM\nBgNVHRMBAf8EAjAAMA0GCSqGSIb3DQEBCwUAA4IBAQAaq47Xhg+gnBZWlauntwqz\nongkeDyIa5JbtKqyVPE1iQALFz64eZP+TWHKkY8Z6aoZCj7PxLAn4nmE2BYU5DV4\nzz4V8e8X2q0s1PvLEZU/aWiKK3/ewcvMURrm6tTXpiEdIkSiEaoIrwTAmIwUEfX5\nJLcGgs3URo4nEtnKhWBuAH7r4sliMZk4GPQwM0wafiS3r3FuI6yFX5gVh78CfvLU\nDrhyp6E57QefIZG7G0Fr38CtwgPNA0T/L53kzZfm1B4b5AwHlMmSCkl3XVNuaw83\nGLIF/3ktsU2pli/PC1gOmcuxE3zy1hoG03MiIs9zFSM++VAI5/a+hbGdy0k1IcZW\n-----END CERTIFICATE-----\n", - "single_logout_url": "https://idp.local-ngrok.com/saml/ec_2rcCuvaDKMCs4Li5cfnwsex2hdo/slo" -} -``` diff --git a/docs/api/examples/_endpoint_tls_termination_module_delete_request.md b/docs/api/examples/_endpoint_tls_termination_module_delete_request.md deleted file mode 100644 index 2c05e93cbd..0000000000 --- a/docs/api/examples/_endpoint_tls_termination_module_delete_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X DELETE \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/endpoint_configurations/ec_2rcCuvaDKMCs4Li5cfnwsex2hdo/tls_termination -``` diff --git a/docs/api/examples/_endpoint_tls_termination_module_delete_response.md b/docs/api/examples/_endpoint_tls_termination_module_delete_response.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/api/examples/_endpoint_tls_termination_module_get_request.md b/docs/api/examples/_endpoint_tls_termination_module_get_request.md deleted file mode 100644 index 58fdba4257..0000000000 --- a/docs/api/examples/_endpoint_tls_termination_module_get_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/endpoint_configurations/ec_2rcCuvaDKMCs4Li5cfnwsex2hdo/tls_termination -``` diff --git a/docs/api/examples/_endpoint_tls_termination_module_get_response.md b/docs/api/examples/_endpoint_tls_termination_module_get_response.md deleted file mode 100644 index 479c4532c8..0000000000 --- a/docs/api/examples/_endpoint_tls_termination_module_get_response.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Response - -```json -{ - "enabled": true, - "min_version": "1.2", - "terminate_at": "edge" -} -``` diff --git a/docs/api/examples/_endpoint_tls_termination_module_replace_request.md b/docs/api/examples/_endpoint_tls_termination_module_replace_request.md deleted file mode 100644 index e0cfef61a4..0000000000 --- a/docs/api/examples/_endpoint_tls_termination_module_replace_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X PUT \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"min_version":"1.2","terminate_at":"edge"}' \ -https://api.ngrok.com/endpoint_configurations/ec_2rcCuvaDKMCs4Li5cfnwsex2hdo/tls_termination -``` diff --git a/docs/api/examples/_endpoint_tls_termination_module_replace_response.md b/docs/api/examples/_endpoint_tls_termination_module_replace_response.md deleted file mode 100644 index 479c4532c8..0000000000 --- a/docs/api/examples/_endpoint_tls_termination_module_replace_response.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Response - -```json -{ - "enabled": true, - "min_version": "1.2", - "terminate_at": "edge" -} -``` diff --git a/docs/api/examples/_endpoint_webhook_validation_module_delete_request.md b/docs/api/examples/_endpoint_webhook_validation_module_delete_request.md deleted file mode 100644 index ba8a71f33e..0000000000 --- a/docs/api/examples/_endpoint_webhook_validation_module_delete_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X DELETE \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/endpoint_configurations/ec_2rcCuvaDKMCs4Li5cfnwsex2hdo/webhook_validation -``` diff --git a/docs/api/examples/_endpoint_webhook_validation_module_delete_response.md b/docs/api/examples/_endpoint_webhook_validation_module_delete_response.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/api/examples/_endpoint_webhook_validation_module_get_request.md b/docs/api/examples/_endpoint_webhook_validation_module_get_request.md deleted file mode 100644 index 1eab6a88d7..0000000000 --- a/docs/api/examples/_endpoint_webhook_validation_module_get_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/endpoint_configurations/ec_2rcCuvaDKMCs4Li5cfnwsex2hdo/webhook_validation -``` diff --git a/docs/api/examples/_endpoint_webhook_validation_module_get_response.md b/docs/api/examples/_endpoint_webhook_validation_module_get_response.md deleted file mode 100644 index 999761990a..0000000000 --- a/docs/api/examples/_endpoint_webhook_validation_module_get_response.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Response - -```json -{ - "enabled": true, - "provider": "TWILIO", - "secret": "secret_token" -} -``` diff --git a/docs/api/examples/_endpoint_webhook_validation_module_replace_request.md b/docs/api/examples/_endpoint_webhook_validation_module_replace_request.md deleted file mode 100644 index b345d0fbad..0000000000 --- a/docs/api/examples/_endpoint_webhook_validation_module_replace_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X PUT \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"provider":"TWILIO","secret":"secret_token"}' \ -https://api.ngrok.com/endpoint_configurations/ec_2rcCuvaDKMCs4Li5cfnwsex2hdo/webhook_validation -``` diff --git a/docs/api/examples/_endpoint_webhook_validation_module_replace_response.md b/docs/api/examples/_endpoint_webhook_validation_module_replace_response.md deleted file mode 100644 index 999761990a..0000000000 --- a/docs/api/examples/_endpoint_webhook_validation_module_replace_response.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Response - -```json -{ - "enabled": true, - "provider": "TWILIO", - "secret": "secret_token" -} -``` diff --git a/docs/api/examples/_endpoints_create_request.md b/docs/api/examples/_endpoints_create_request.md deleted file mode 100644 index 25ece71be1..0000000000 --- a/docs/api/examples/_endpoints_create_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X POST \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"bindings":["public"],"description":"sample cloud endpoint","metadata":"{\"environment\": \"staging\"}","traffic_policy":"{\"on_http_request\":[{\"actions\":[{\"type\":\"deny\",\"config\":{\"status_code\":404}}]}]}","type":"cloud","url":"https://endpoint-example2.com:443"}' \ -https://api.ngrok.com/endpoints -``` diff --git a/docs/api/examples/_endpoints_create_response.md b/docs/api/examples/_endpoints_create_response.md deleted file mode 100644 index 1f5d633c91..0000000000 --- a/docs/api/examples/_endpoints_create_response.md +++ /dev/null @@ -1,25 +0,0 @@ - - -#### Example Response - -```json -{ - "bindings": ["public"], - "created_at": "2025-01-14T10:06:40Z", - "description": "sample cloud endpoint", - "domain": { - "id": "rd_2rcCu7OH60v3P9Fk9oc12fQtyxO", - "uri": "https://api.ngrok.com/reserved_domains/rd_2rcCu7OH60v3P9Fk9oc12fQtyxO" - }, - "hostport": "endpoint-example2.com:443", - "id": "ep_2rcCuj3bi4YCDt6F0mMVar6gGfk", - "metadata": "{\"environment\": \"staging\"}", - "proto": "https", - "public_url": "https://endpoint-example2.com", - "traffic_policy": "{\"on_http_request\":[{\"actions\":[{\"type\":\"deny\",\"config\":{\"status_code\":404}}]}]}", - "type": "cloud", - "updated_at": "2025-01-14T10:06:40Z", - "uri": "https://api.ngrok.com/endpoints/ep_2rcCuj3bi4YCDt6F0mMVar6gGfk", - "url": "https://endpoint-example2.com" -} -``` diff --git a/docs/api/examples/_endpoints_delete_request.md b/docs/api/examples/_endpoints_delete_request.md deleted file mode 100644 index 419b65122a..0000000000 --- a/docs/api/examples/_endpoints_delete_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X DELETE \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/endpoints/ep_2rcCuj3bi4YCDt6F0mMVar6gGfk -``` diff --git a/docs/api/examples/_endpoints_delete_response.md b/docs/api/examples/_endpoints_delete_response.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/api/examples/_endpoints_get_request.md b/docs/api/examples/_endpoints_get_request.md deleted file mode 100644 index 27986e60d0..0000000000 --- a/docs/api/examples/_endpoints_get_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/endpoints/ep_2rcCuj3bi4YCDt6F0mMVar6gGfk -``` diff --git a/docs/api/examples/_endpoints_get_response.md b/docs/api/examples/_endpoints_get_response.md deleted file mode 100644 index 5becadb25b..0000000000 --- a/docs/api/examples/_endpoints_get_response.md +++ /dev/null @@ -1,27 +0,0 @@ - - -#### Example Response - -```json -{ - "bindings": ["public"], - "created_at": "2025-01-14T10:06:41Z", - "description": "sample cloud endpoint", - "domain": { - "id": "rd_2rcCu7OH60v3P9Fk9oc12fQtyxO", - "uri": "https://api.ngrok.com/reserved_domains/rd_2rcCu7OH60v3P9Fk9oc12fQtyxO" - }, - "edge": { - "id": "edgtls_2rcCu3Mv1sn41sQWC6XN2AOtaaH", - "uri": "https://api.ngrok.com/edges/tls/edgtls_2rcCu3Mv1sn41sQWC6XN2AOtaaH" - }, - "hostport": "endpoint-example2.com:443", - "id": "ep_2rcCuj3bi4YCDt6F0mMVar6gGfk", - "proto": "https", - "public_url": "https://endpoint-example2.com", - "type": "cloud", - "updated_at": "2025-01-14T10:06:41Z", - "uri": "https://api.ngrok.com/endpoints/ep_2rcCuj3bi4YCDt6F0mMVar6gGfk", - "url": "https://endpoint-example2.com" -} -``` diff --git a/docs/api/examples/_endpoints_list_request.md b/docs/api/examples/_endpoints_list_request.md deleted file mode 100644 index c6d019e19f..0000000000 --- a/docs/api/examples/_endpoints_list_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/endpoints -``` diff --git a/docs/api/examples/_endpoints_list_response.md b/docs/api/examples/_endpoints_list_response.md deleted file mode 100644 index d3382b9031..0000000000 --- a/docs/api/examples/_endpoints_list_response.md +++ /dev/null @@ -1,55 +0,0 @@ - - -#### Example Response - -```json -{ - "endpoints": [ - { - "bindings": ["public"], - "created_at": "2025-01-14T10:06:39Z", - "hostport": "cc6f3dda97be.ngrok.paid:443", - "id": "ep_2rcCueQnhASllDgqZGNDmDCoOkj", - "name": "command_line", - "principal": { - "id": "usr_2rcCs3aBfA01H0kq4OxydHqoED0", - "uri": "" - }, - "proto": "https", - "public_url": "https://cc6f3dda97be.ngrok.paid", - "tunnel": { - "id": "tn_2rcCueQnhASllDgqZGNDmDCoOkj", - "uri": "https://api.ngrok.com/tunnels/tn_2rcCueQnhASllDgqZGNDmDCoOkj" - }, - "tunnel_session": { - "id": "ts_2rcCuc30ZEJgcRwMFqQ2pD9ZEvM", - "uri": "https://api.ngrok.com/tunnel_sessions/ts_2rcCuc30ZEJgcRwMFqQ2pD9ZEvM" - }, - "type": "ephemeral", - "updated_at": "2025-01-14T10:06:39Z", - "upstream_url": "http://localhost:80", - "url": "https://cc6f3dda97be.ngrok.paid" - }, - { - "bindings": ["public"], - "created_at": "2025-01-14T10:06:36Z", - "domain": { - "id": "rd_2rcCu7OH60v3P9Fk9oc12fQtyxO", - "uri": "https://api.ngrok.com/reserved_domains/rd_2rcCu7OH60v3P9Fk9oc12fQtyxO" - }, - "edge": { - "id": "edgtls_2rcCu3Mv1sn41sQWC6XN2AOtaaH", - "uri": "https://api.ngrok.com/edges/tls/edgtls_2rcCu3Mv1sn41sQWC6XN2AOtaaH" - }, - "hostport": "endpoint-example2.com:443", - "id": "ep_2rcCu9S8AIG5a9wNimT1fXEPsbO", - "proto": "tls", - "public_url": "tls://endpoint-example2.com", - "type": "edge", - "updated_at": "2025-01-14T10:06:36Z" - } - ], - "next_page_uri": null, - "uri": "https://api.ngrok.com/endpoints" -} -``` diff --git a/docs/api/examples/_endpoints_update_request.md b/docs/api/examples/_endpoints_update_request.md deleted file mode 100644 index b2f86765a8..0000000000 --- a/docs/api/examples/_endpoints_update_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X PATCH \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"description":"Sample Cloud Endpoint"}' \ -https://api.ngrok.com/endpoints/ep_2rcCuj3bi4YCDt6F0mMVar6gGfk -``` diff --git a/docs/api/examples/_endpoints_update_response.md b/docs/api/examples/_endpoints_update_response.md deleted file mode 100644 index b4312cb0ec..0000000000 --- a/docs/api/examples/_endpoints_update_response.md +++ /dev/null @@ -1,25 +0,0 @@ - - -#### Example Response - -```json -{ - "bindings": ["public"], - "created_at": "2025-01-14T10:06:40Z", - "description": "Sample Cloud Endpoint", - "domain": { - "id": "rd_2rcCu7OH60v3P9Fk9oc12fQtyxO", - "uri": "https://api.ngrok.com/reserved_domains/rd_2rcCu7OH60v3P9Fk9oc12fQtyxO" - }, - "hostport": "endpoint-example2.com:443", - "id": "ep_2rcCuj3bi4YCDt6F0mMVar6gGfk", - "metadata": "{\"environment\": \"staging\"}", - "proto": "https", - "public_url": "https://endpoint-example2.com", - "traffic_policy": "{\"on_http_request\":[{\"actions\":[{\"type\":\"deny\",\"config\":{\"status_code\":404}}]}]}", - "type": "cloud", - "updated_at": "2025-01-14T10:06:41Z", - "uri": "https://api.ngrok.com/endpoints/ep_2rcCuj3bi4YCDt6F0mMVar6gGfk", - "url": "https://endpoint-example2.com" -} -``` diff --git a/docs/api/examples/_event_destinations_create_request.md b/docs/api/examples/_event_destinations_create_request.md deleted file mode 100644 index aed53a6472..0000000000 --- a/docs/api/examples/_event_destinations_create_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X POST \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"description":"kinesis dev stream","format":"json","metadata":"{\"environment\":\"dev\"}","target":{"kinesis":{"auth":{"role":{"role_arn":"arn:aws:iam::123456789012:role/example"}},"stream_arn":"arn:ngrok-local:kinesis:us-east-2:123456789012:stream/mystream2"}}}' \ -https://api.ngrok.com/event_destinations -``` diff --git a/docs/api/examples/_event_destinations_create_response.md b/docs/api/examples/_event_destinations_create_response.md deleted file mode 100644 index fce7dc043d..0000000000 --- a/docs/api/examples/_event_destinations_create_response.md +++ /dev/null @@ -1,29 +0,0 @@ - - -#### Example Response - -```json -{ - "created_at": "2025-01-14T10:06:43Z", - "description": "kinesis dev stream", - "format": "json", - "id": "ed_2rcCv4pEpLQVudfxQP1recqsDuR", - "metadata": "{\"environment\":\"dev\"}", - "target": { - "azure_logs_ingestion": null, - "cloudwatch_logs": null, - "datadog": null, - "firehose": null, - "kinesis": { - "auth": { - "creds": null, - "role": { - "role_arn": "arn:aws:iam::123456789012:role/example" - } - }, - "stream_arn": "arn:ngrok-local:kinesis:us-east-2:123456789012:stream/mystream2" - } - }, - "uri": "https://api.ngrok.com/event_destinations/ed_2rcCv4pEpLQVudfxQP1recqsDuR" -} -``` diff --git a/docs/api/examples/_event_destinations_delete_request.md b/docs/api/examples/_event_destinations_delete_request.md deleted file mode 100644 index 9c5417f86c..0000000000 --- a/docs/api/examples/_event_destinations_delete_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X DELETE \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/event_destinations/ed_2rcCv4pEpLQVudfxQP1recqsDuR -``` diff --git a/docs/api/examples/_event_destinations_delete_response.md b/docs/api/examples/_event_destinations_delete_response.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/api/examples/_event_destinations_get_request.md b/docs/api/examples/_event_destinations_get_request.md deleted file mode 100644 index 61bbb40970..0000000000 --- a/docs/api/examples/_event_destinations_get_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/event_destinations/ed_2rcCv4pEpLQVudfxQP1recqsDuR -``` diff --git a/docs/api/examples/_event_destinations_get_response.md b/docs/api/examples/_event_destinations_get_response.md deleted file mode 100644 index 43eb9b411c..0000000000 --- a/docs/api/examples/_event_destinations_get_response.md +++ /dev/null @@ -1,29 +0,0 @@ - - -#### Example Response - -```json -{ - "created_at": "2025-01-14T10:06:43Z", - "description": "kinesis dev stream 1 of 3", - "format": "json", - "id": "ed_2rcCv4pEpLQVudfxQP1recqsDuR", - "metadata": "{\"environment\":\"dev\", \"stream\":1}", - "target": { - "azure_logs_ingestion": null, - "cloudwatch_logs": null, - "datadog": null, - "firehose": null, - "kinesis": { - "auth": { - "creds": null, - "role": { - "role_arn": "arn:aws:iam::123456789012:role/example" - } - }, - "stream_arn": "arn:ngrok-local:kinesis:us-east-2:123456789012:stream/mystream2" - } - }, - "uri": "https://api.ngrok.com/event_destinations/ed_2rcCv4pEpLQVudfxQP1recqsDuR" -} -``` diff --git a/docs/api/examples/_event_destinations_list_request.md b/docs/api/examples/_event_destinations_list_request.md deleted file mode 100644 index 6791e75142..0000000000 --- a/docs/api/examples/_event_destinations_list_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/event_destinations -``` diff --git a/docs/api/examples/_event_destinations_list_response.md b/docs/api/examples/_event_destinations_list_response.md deleted file mode 100644 index 3781532ff1..0000000000 --- a/docs/api/examples/_event_destinations_list_response.md +++ /dev/null @@ -1,35 +0,0 @@ - - -#### Example Response - -```json -{ - "event_destinations": [ - { - "created_at": "2025-01-14T10:06:43Z", - "description": "kinesis dev stream", - "format": "json", - "id": "ed_2rcCv4pEpLQVudfxQP1recqsDuR", - "metadata": "{\"environment\":\"dev\"}", - "target": { - "azure_logs_ingestion": null, - "cloudwatch_logs": null, - "datadog": null, - "firehose": null, - "kinesis": { - "auth": { - "creds": null, - "role": { - "role_arn": "arn:aws:iam::123456789012:role/example" - } - }, - "stream_arn": "arn:ngrok-local:kinesis:us-east-2:123456789012:stream/mystream2" - } - }, - "uri": "https://api.ngrok.com/event_destinations/ed_2rcCv4pEpLQVudfxQP1recqsDuR" - } - ], - "next_page_uri": null, - "uri": "https://api.ngrok.com/event_destinations" -} -``` diff --git a/docs/api/examples/_event_destinations_update_request.md b/docs/api/examples/_event_destinations_update_request.md deleted file mode 100644 index 09f81c0f3e..0000000000 --- a/docs/api/examples/_event_destinations_update_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X PATCH \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"description":"kinesis dev stream 1 of 3","metadata":"{\"environment\":\"dev\", \"stream\":1}"}' \ -https://api.ngrok.com/event_destinations/ed_2rcCv4pEpLQVudfxQP1recqsDuR -``` diff --git a/docs/api/examples/_event_destinations_update_response.md b/docs/api/examples/_event_destinations_update_response.md deleted file mode 100644 index 43eb9b411c..0000000000 --- a/docs/api/examples/_event_destinations_update_response.md +++ /dev/null @@ -1,29 +0,0 @@ - - -#### Example Response - -```json -{ - "created_at": "2025-01-14T10:06:43Z", - "description": "kinesis dev stream 1 of 3", - "format": "json", - "id": "ed_2rcCv4pEpLQVudfxQP1recqsDuR", - "metadata": "{\"environment\":\"dev\", \"stream\":1}", - "target": { - "azure_logs_ingestion": null, - "cloudwatch_logs": null, - "datadog": null, - "firehose": null, - "kinesis": { - "auth": { - "creds": null, - "role": { - "role_arn": "arn:aws:iam::123456789012:role/example" - } - }, - "stream_arn": "arn:ngrok-local:kinesis:us-east-2:123456789012:stream/mystream2" - } - }, - "uri": "https://api.ngrok.com/event_destinations/ed_2rcCv4pEpLQVudfxQP1recqsDuR" -} -``` diff --git a/docs/api/examples/_event_sources_create_request.md b/docs/api/examples/_event_sources_create_request.md deleted file mode 100644 index f632273d05..0000000000 --- a/docs/api/examples/_event_sources_create_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X POST \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"type":"ip_policy_updated.v0"}' \ -https://api.ngrok.com/event_subscriptions/esb_2rcCv55MMrKLugXQCIIuQaGlPih/sources -``` diff --git a/docs/api/examples/_event_sources_create_response.md b/docs/api/examples/_event_sources_create_response.md deleted file mode 100644 index 2ed59b7463..0000000000 --- a/docs/api/examples/_event_sources_create_response.md +++ /dev/null @@ -1,10 +0,0 @@ - - -#### Example Response - -```json -{ - "type": "ip_policy_updated.v0", - "uri": "https://api.ngrok.com/event_subscriptions/esb_2rcCv55MMrKLugXQCIIuQaGlPih/sources/ip_policy_updated.v0" -} -``` diff --git a/docs/api/examples/_event_sources_delete_request.md b/docs/api/examples/_event_sources_delete_request.md deleted file mode 100644 index 49cfb08dbf..0000000000 --- a/docs/api/examples/_event_sources_delete_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X DELETE \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/event_subscriptions/esb_2rcCv55MMrKLugXQCIIuQaGlPih/sources/ip_policy_updated.v0 -``` diff --git a/docs/api/examples/_event_sources_delete_response.md b/docs/api/examples/_event_sources_delete_response.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/api/examples/_event_sources_get_request.md b/docs/api/examples/_event_sources_get_request.md deleted file mode 100644 index b05a23bbbb..0000000000 --- a/docs/api/examples/_event_sources_get_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/event_subscriptions/esb_2rcCv55MMrKLugXQCIIuQaGlPih/sources/ip_policy_updated.v0 -``` diff --git a/docs/api/examples/_event_sources_get_response.md b/docs/api/examples/_event_sources_get_response.md deleted file mode 100644 index 2ed59b7463..0000000000 --- a/docs/api/examples/_event_sources_get_response.md +++ /dev/null @@ -1,10 +0,0 @@ - - -#### Example Response - -```json -{ - "type": "ip_policy_updated.v0", - "uri": "https://api.ngrok.com/event_subscriptions/esb_2rcCv55MMrKLugXQCIIuQaGlPih/sources/ip_policy_updated.v0" -} -``` diff --git a/docs/api/examples/_event_sources_list_request.md b/docs/api/examples/_event_sources_list_request.md deleted file mode 100644 index 0640467a47..0000000000 --- a/docs/api/examples/_event_sources_list_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/event_subscriptions/esb_2rcCv55MMrKLugXQCIIuQaGlPih/sources -``` diff --git a/docs/api/examples/_event_sources_list_response.md b/docs/api/examples/_event_sources_list_response.md deleted file mode 100644 index c21c14654b..0000000000 --- a/docs/api/examples/_event_sources_list_response.md +++ /dev/null @@ -1,19 +0,0 @@ - - -#### Example Response - -```json -{ - "sources": [ - { - "type": "ip_policy_created.v0", - "uri": "https://api.ngrok.com/event_subscriptions/esb_2rcCv55MMrKLugXQCIIuQaGlPih/sources/ip_policy_created.v0" - }, - { - "type": "ip_policy_updated.v0", - "uri": "https://api.ngrok.com/event_subscriptions/esb_2rcCv55MMrKLugXQCIIuQaGlPih/sources/ip_policy_updated.v0" - } - ], - "uri": "https://api.ngrok.com/event_subscriptions/esb_2rcCv55MMrKLugXQCIIuQaGlPih/sources" -} -``` diff --git a/docs/api/examples/_event_sources_update_request.md b/docs/api/examples/_event_sources_update_request.md deleted file mode 100644 index 48262b19a4..0000000000 --- a/docs/api/examples/_event_sources_update_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X PATCH \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{}' \ -https://api.ngrok.com/event_subscriptions/esb_2rcCv55MMrKLugXQCIIuQaGlPih/sources/ip_policy_updated.v0 -``` diff --git a/docs/api/examples/_event_sources_update_response.md b/docs/api/examples/_event_sources_update_response.md deleted file mode 100644 index 2ed59b7463..0000000000 --- a/docs/api/examples/_event_sources_update_response.md +++ /dev/null @@ -1,10 +0,0 @@ - - -#### Example Response - -```json -{ - "type": "ip_policy_updated.v0", - "uri": "https://api.ngrok.com/event_subscriptions/esb_2rcCv55MMrKLugXQCIIuQaGlPih/sources/ip_policy_updated.v0" -} -``` diff --git a/docs/api/examples/_event_subscriptions_create_request.md b/docs/api/examples/_event_subscriptions_create_request.md deleted file mode 100644 index e0cfeb3c02..0000000000 --- a/docs/api/examples/_event_subscriptions_create_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X POST \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"description":"ip policy creations","destination_ids":["ed_2rcCv3Npo2S08ewOnLtthQFEQPN"],"metadata":"{\"environment\": \"staging\"}","sources":[{"type":"ip_policy_created.v0"}]}' \ -https://api.ngrok.com/event_subscriptions -``` diff --git a/docs/api/examples/_event_subscriptions_create_response.md b/docs/api/examples/_event_subscriptions_create_response.md deleted file mode 100644 index ab6c760a96..0000000000 --- a/docs/api/examples/_event_subscriptions_create_response.md +++ /dev/null @@ -1,25 +0,0 @@ - - -#### Example Response - -```json -{ - "created_at": "2025-01-14T10:06:43Z", - "description": "ip policy creations", - "destinations": [ - { - "id": "ed_2rcCv3Npo2S08ewOnLtthQFEQPN", - "uri": "https://api.ngrok.com/event_destinations/ed_2rcCv3Npo2S08ewOnLtthQFEQPN" - } - ], - "id": "esb_2rcCv8tz6FV12RAnXpSjfarPCAA", - "metadata": "{\"environment\": \"staging\"}", - "sources": [ - { - "type": "ip_policy_created.v0", - "uri": "https://api.ngrok.com/event_subscriptions/esb_2rcCv8tz6FV12RAnXpSjfarPCAA/sources/ip_policy_created.v0" - } - ], - "uri": "https://api.ngrok.com/event_subscriptions/esb_2rcCv8tz6FV12RAnXpSjfarPCAA" -} -``` diff --git a/docs/api/examples/_event_subscriptions_delete_request.md b/docs/api/examples/_event_subscriptions_delete_request.md deleted file mode 100644 index 6f996c73b9..0000000000 --- a/docs/api/examples/_event_subscriptions_delete_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X DELETE \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/event_subscriptions/esb_2rcCv8tz6FV12RAnXpSjfarPCAA -``` diff --git a/docs/api/examples/_event_subscriptions_delete_response.md b/docs/api/examples/_event_subscriptions_delete_response.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/api/examples/_event_subscriptions_get_request.md b/docs/api/examples/_event_subscriptions_get_request.md deleted file mode 100644 index 8153a9785f..0000000000 --- a/docs/api/examples/_event_subscriptions_get_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/event_subscriptions/esb_2rcCv8tz6FV12RAnXpSjfarPCAA -``` diff --git a/docs/api/examples/_event_subscriptions_get_response.md b/docs/api/examples/_event_subscriptions_get_response.md deleted file mode 100644 index a59153dd09..0000000000 --- a/docs/api/examples/_event_subscriptions_get_response.md +++ /dev/null @@ -1,25 +0,0 @@ - - -#### Example Response - -```json -{ - "created_at": "2025-01-14T10:06:43Z", - "description": "IP Policy Creations", - "destinations": [ - { - "id": "ed_2rcCv3Npo2S08ewOnLtthQFEQPN", - "uri": "https://api.ngrok.com/event_destinations/ed_2rcCv3Npo2S08ewOnLtthQFEQPN" - } - ], - "id": "esb_2rcCv8tz6FV12RAnXpSjfarPCAA", - "metadata": "{\"environment\": \"staging\"}", - "sources": [ - { - "type": "ip_policy_created.v0", - "uri": "https://api.ngrok.com/event_subscriptions/esb_2rcCv8tz6FV12RAnXpSjfarPCAA/sources/ip_policy_created.v0" - } - ], - "uri": "https://api.ngrok.com/event_subscriptions/esb_2rcCv8tz6FV12RAnXpSjfarPCAA" -} -``` diff --git a/docs/api/examples/_event_subscriptions_list_request.md b/docs/api/examples/_event_subscriptions_list_request.md deleted file mode 100644 index 0e20ec91f5..0000000000 --- a/docs/api/examples/_event_subscriptions_list_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/event_subscriptions -``` diff --git a/docs/api/examples/_event_subscriptions_list_response.md b/docs/api/examples/_event_subscriptions_list_response.md deleted file mode 100644 index d77a399ee4..0000000000 --- a/docs/api/examples/_event_subscriptions_list_response.md +++ /dev/null @@ -1,31 +0,0 @@ - - -#### Example Response - -```json -{ - "event_subscriptions": [ - { - "created_at": "2025-01-14T10:06:43Z", - "description": "ip policy creations", - "destinations": [ - { - "id": "ed_2rcCv3Npo2S08ewOnLtthQFEQPN", - "uri": "https://api.ngrok.com/event_destinations/ed_2rcCv3Npo2S08ewOnLtthQFEQPN" - } - ], - "id": "esb_2rcCv8tz6FV12RAnXpSjfarPCAA", - "metadata": "{\"environment\": \"staging\"}", - "sources": [ - { - "type": "ip_policy_created.v0", - "uri": "https://api.ngrok.com/event_subscriptions/esb_2rcCv8tz6FV12RAnXpSjfarPCAA/sources/ip_policy_created.v0" - } - ], - "uri": "https://api.ngrok.com/event_subscriptions/esb_2rcCv8tz6FV12RAnXpSjfarPCAA" - } - ], - "next_page_uri": null, - "uri": "https://api.ngrok.com/event_subscriptions" -} -``` diff --git a/docs/api/examples/_event_subscriptions_update_request.md b/docs/api/examples/_event_subscriptions_update_request.md deleted file mode 100644 index bb501dba5d..0000000000 --- a/docs/api/examples/_event_subscriptions_update_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X PATCH \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"description":"IP Policy Creations"}' \ -https://api.ngrok.com/event_subscriptions/esb_2rcCv8tz6FV12RAnXpSjfarPCAA -``` diff --git a/docs/api/examples/_event_subscriptions_update_response.md b/docs/api/examples/_event_subscriptions_update_response.md deleted file mode 100644 index a59153dd09..0000000000 --- a/docs/api/examples/_event_subscriptions_update_response.md +++ /dev/null @@ -1,25 +0,0 @@ - - -#### Example Response - -```json -{ - "created_at": "2025-01-14T10:06:43Z", - "description": "IP Policy Creations", - "destinations": [ - { - "id": "ed_2rcCv3Npo2S08ewOnLtthQFEQPN", - "uri": "https://api.ngrok.com/event_destinations/ed_2rcCv3Npo2S08ewOnLtthQFEQPN" - } - ], - "id": "esb_2rcCv8tz6FV12RAnXpSjfarPCAA", - "metadata": "{\"environment\": \"staging\"}", - "sources": [ - { - "type": "ip_policy_created.v0", - "uri": "https://api.ngrok.com/event_subscriptions/esb_2rcCv8tz6FV12RAnXpSjfarPCAA/sources/ip_policy_created.v0" - } - ], - "uri": "https://api.ngrok.com/event_subscriptions/esb_2rcCv8tz6FV12RAnXpSjfarPCAA" -} -``` diff --git a/docs/api/examples/_failover_backends_create_request.md b/docs/api/examples/_failover_backends_create_request.md deleted file mode 100644 index d0ace0b4a5..0000000000 --- a/docs/api/examples/_failover_backends_create_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X POST \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"backends":["bkdhr_2rcCv8WSTPGo4atlNxQAa8ggT2N"],"description":"acme failover","metadata":"{\"environment\": \"staging\"}"}' \ -https://api.ngrok.com/backends/failover -``` diff --git a/docs/api/examples/_failover_backends_create_response.md b/docs/api/examples/_failover_backends_create_response.md deleted file mode 100644 index ff45398d55..0000000000 --- a/docs/api/examples/_failover_backends_create_response.md +++ /dev/null @@ -1,14 +0,0 @@ - - -#### Example Response - -```json -{ - "backends": ["bkdhr_2rcCv8WSTPGo4atlNxQAa8ggT2N"], - "created_at": "2025-01-14T10:06:43Z", - "description": "acme failover", - "id": "bkdfo_2rcCv41PW6SxihUUiSQYOkFYYBI", - "metadata": "{\"environment\": \"staging\"}", - "uri": "https://api.ngrok.com/backends/failover/bkdfo_2rcCv41PW6SxihUUiSQYOkFYYBI" -} -``` diff --git a/docs/api/examples/_failover_backends_delete_request.md b/docs/api/examples/_failover_backends_delete_request.md deleted file mode 100644 index 20b44395b9..0000000000 --- a/docs/api/examples/_failover_backends_delete_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X DELETE \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/backends/failover/bkdfo_2rcCv41PW6SxihUUiSQYOkFYYBI -``` diff --git a/docs/api/examples/_failover_backends_delete_response.md b/docs/api/examples/_failover_backends_delete_response.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/api/examples/_failover_backends_get_request.md b/docs/api/examples/_failover_backends_get_request.md deleted file mode 100644 index a3f809c791..0000000000 --- a/docs/api/examples/_failover_backends_get_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/backends/failover/bkdfo_2rcCv41PW6SxihUUiSQYOkFYYBI -``` diff --git a/docs/api/examples/_failover_backends_get_response.md b/docs/api/examples/_failover_backends_get_response.md deleted file mode 100644 index ff45398d55..0000000000 --- a/docs/api/examples/_failover_backends_get_response.md +++ /dev/null @@ -1,14 +0,0 @@ - - -#### Example Response - -```json -{ - "backends": ["bkdhr_2rcCv8WSTPGo4atlNxQAa8ggT2N"], - "created_at": "2025-01-14T10:06:43Z", - "description": "acme failover", - "id": "bkdfo_2rcCv41PW6SxihUUiSQYOkFYYBI", - "metadata": "{\"environment\": \"staging\"}", - "uri": "https://api.ngrok.com/backends/failover/bkdfo_2rcCv41PW6SxihUUiSQYOkFYYBI" -} -``` diff --git a/docs/api/examples/_failover_backends_list_request.md b/docs/api/examples/_failover_backends_list_request.md deleted file mode 100644 index 8169f344ce..0000000000 --- a/docs/api/examples/_failover_backends_list_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/backends/failover -``` diff --git a/docs/api/examples/_failover_backends_list_response.md b/docs/api/examples/_failover_backends_list_response.md deleted file mode 100644 index 722973028d..0000000000 --- a/docs/api/examples/_failover_backends_list_response.md +++ /dev/null @@ -1,20 +0,0 @@ - - -#### Example Response - -```json -{ - "backends": [ - { - "backends": ["bkdhr_2rcCv8WSTPGo4atlNxQAa8ggT2N"], - "created_at": "2025-01-14T10:06:43Z", - "description": "acme failover", - "id": "bkdfo_2rcCv41PW6SxihUUiSQYOkFYYBI", - "metadata": "{\"environment\": \"staging\"}", - "uri": "https://api.ngrok.com/backends/failover/bkdfo_2rcCv41PW6SxihUUiSQYOkFYYBI" - } - ], - "next_page_uri": null, - "uri": "https://api.ngrok.com/backends/failover" -} -``` diff --git a/docs/api/examples/_failover_backends_update_request.md b/docs/api/examples/_failover_backends_update_request.md deleted file mode 100644 index 77ee623674..0000000000 --- a/docs/api/examples/_failover_backends_update_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X PATCH \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"metadata":"{\"environment\": \"production\"}"}' \ -https://api.ngrok.com/backends/failover/bkdfo_2rcCv41PW6SxihUUiSQYOkFYYBI -``` diff --git a/docs/api/examples/_failover_backends_update_response.md b/docs/api/examples/_failover_backends_update_response.md deleted file mode 100644 index 38294ddf9a..0000000000 --- a/docs/api/examples/_failover_backends_update_response.md +++ /dev/null @@ -1,14 +0,0 @@ - - -#### Example Response - -```json -{ - "backends": [], - "created_at": "2025-01-14T10:06:43Z", - "description": "acme failover", - "id": "bkdfo_2rcCv41PW6SxihUUiSQYOkFYYBI", - "metadata": "{\"environment\": \"production\"}", - "uri": "https://api.ngrok.com/backends/failover/bkdfo_2rcCv41PW6SxihUUiSQYOkFYYBI" -} -``` diff --git a/docs/api/examples/_http_response_backends_create_request.md b/docs/api/examples/_http_response_backends_create_request.md deleted file mode 100644 index bdc9c97843..0000000000 --- a/docs/api/examples/_http_response_backends_create_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X POST \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"body":"I'm a teapot","description":"acme http response","headers":{"Content-Type":"text/plain"},"metadata":"{\"environment\": \"staging\"}","status_code":418}' \ -https://api.ngrok.com/backends/http_response -``` diff --git a/docs/api/examples/_http_response_backends_create_response.md b/docs/api/examples/_http_response_backends_create_response.md deleted file mode 100644 index a0b773e895..0000000000 --- a/docs/api/examples/_http_response_backends_create_response.md +++ /dev/null @@ -1,18 +0,0 @@ - - -#### Example Response - -```json -{ - "body": "I'm a teapot", - "created_at": "2025-01-14T10:06:43Z", - "description": "acme http response", - "headers": { - "content-type": "text/plain" - }, - "id": "bkdhr_2rcCv6dY08OEXR6k3hgFBk8nmpX", - "metadata": "{\"environment\": \"staging\"}", - "status_code": 418, - "uri": "https://api.ngrok.com/backends/http_response/bkdhr_2rcCv6dY08OEXR6k3hgFBk8nmpX" -} -``` diff --git a/docs/api/examples/_http_response_backends_delete_request.md b/docs/api/examples/_http_response_backends_delete_request.md deleted file mode 100644 index 30de6d8a44..0000000000 --- a/docs/api/examples/_http_response_backends_delete_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X DELETE \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/backends/http_response/bkdhr_2rcCv6dY08OEXR6k3hgFBk8nmpX -``` diff --git a/docs/api/examples/_http_response_backends_delete_response.md b/docs/api/examples/_http_response_backends_delete_response.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/api/examples/_http_response_backends_get_request.md b/docs/api/examples/_http_response_backends_get_request.md deleted file mode 100644 index a822f8d772..0000000000 --- a/docs/api/examples/_http_response_backends_get_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/backends/http_response/bkdhr_2rcCv6dY08OEXR6k3hgFBk8nmpX -``` diff --git a/docs/api/examples/_http_response_backends_get_response.md b/docs/api/examples/_http_response_backends_get_response.md deleted file mode 100644 index a0b773e895..0000000000 --- a/docs/api/examples/_http_response_backends_get_response.md +++ /dev/null @@ -1,18 +0,0 @@ - - -#### Example Response - -```json -{ - "body": "I'm a teapot", - "created_at": "2025-01-14T10:06:43Z", - "description": "acme http response", - "headers": { - "content-type": "text/plain" - }, - "id": "bkdhr_2rcCv6dY08OEXR6k3hgFBk8nmpX", - "metadata": "{\"environment\": \"staging\"}", - "status_code": 418, - "uri": "https://api.ngrok.com/backends/http_response/bkdhr_2rcCv6dY08OEXR6k3hgFBk8nmpX" -} -``` diff --git a/docs/api/examples/_http_response_backends_list_request.md b/docs/api/examples/_http_response_backends_list_request.md deleted file mode 100644 index 891538226a..0000000000 --- a/docs/api/examples/_http_response_backends_list_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/backends/http_response -``` diff --git a/docs/api/examples/_http_response_backends_list_response.md b/docs/api/examples/_http_response_backends_list_response.md deleted file mode 100644 index 773e36afcf..0000000000 --- a/docs/api/examples/_http_response_backends_list_response.md +++ /dev/null @@ -1,40 +0,0 @@ - - -#### Example Response - -```json -{ - "backends": [ - { - "body": "one", - "created_at": "2025-01-14T10:06:43Z", - "headers": null, - "id": "bkdhr_2rcCv8WSTPGo4atlNxQAa8ggT2N", - "status_code": 200, - "uri": "https://api.ngrok.com/backends/http_response/bkdhr_2rcCv8WSTPGo4atlNxQAa8ggT2N" - }, - { - "body": "I'm a teapot", - "created_at": "2025-01-14T10:06:43Z", - "description": "acme http response", - "headers": { - "content-type": "text/plain" - }, - "id": "bkdhr_2rcCv6dY08OEXR6k3hgFBk8nmpX", - "metadata": "{\"environment\": \"staging\"}", - "status_code": 418, - "uri": "https://api.ngrok.com/backends/http_response/bkdhr_2rcCv6dY08OEXR6k3hgFBk8nmpX" - }, - { - "body": "one", - "created_at": "2025-01-14T10:06:35Z", - "headers": null, - "id": "bkdhr_2rcCu48LNH3HU7rx4s8N7kRJ5nP", - "status_code": 200, - "uri": "https://api.ngrok.com/backends/http_response/bkdhr_2rcCu48LNH3HU7rx4s8N7kRJ5nP" - } - ], - "next_page_uri": null, - "uri": "https://api.ngrok.com/backends/http_response" -} -``` diff --git a/docs/api/examples/_http_response_backends_update_request.md b/docs/api/examples/_http_response_backends_update_request.md deleted file mode 100644 index 3ca7c19851..0000000000 --- a/docs/api/examples/_http_response_backends_update_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X PATCH \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"metadata":"{\"environment\": \"production\"}"}' \ -https://api.ngrok.com/backends/http_response/bkdhr_2rcCv6dY08OEXR6k3hgFBk8nmpX -``` diff --git a/docs/api/examples/_http_response_backends_update_response.md b/docs/api/examples/_http_response_backends_update_response.md deleted file mode 100644 index 819b8a38aa..0000000000 --- a/docs/api/examples/_http_response_backends_update_response.md +++ /dev/null @@ -1,18 +0,0 @@ - - -#### Example Response - -```json -{ - "body": "I'm a teapot", - "created_at": "2025-01-14T10:06:43Z", - "description": "acme http response", - "headers": { - "content-type": "text/plain" - }, - "id": "bkdhr_2rcCv6dY08OEXR6k3hgFBk8nmpX", - "metadata": "{\"environment\": \"production\"}", - "status_code": 418, - "uri": "https://api.ngrok.com/backends/http_response/bkdhr_2rcCv6dY08OEXR6k3hgFBk8nmpX" -} -``` diff --git a/docs/api/examples/_https_edge_mutual_tls_module_delete_request.md b/docs/api/examples/_https_edge_mutual_tls_module_delete_request.md deleted file mode 100644 index c7ba2a3cb4..0000000000 --- a/docs/api/examples/_https_edge_mutual_tls_module_delete_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X DELETE \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/edges/https/edghts_2rcCvbrhMfV77Brf9Vg5y0qMwF2/mutual_tls -``` diff --git a/docs/api/examples/_https_edge_mutual_tls_module_delete_response.md b/docs/api/examples/_https_edge_mutual_tls_module_delete_response.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/api/examples/_https_edge_mutual_tls_module_get_request.md b/docs/api/examples/_https_edge_mutual_tls_module_get_request.md deleted file mode 100644 index b4019346d4..0000000000 --- a/docs/api/examples/_https_edge_mutual_tls_module_get_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/edges/https/edghts_2rcCvbrhMfV77Brf9Vg5y0qMwF2/mutual_tls -``` diff --git a/docs/api/examples/_https_edge_mutual_tls_module_get_response.md b/docs/api/examples/_https_edge_mutual_tls_module_get_response.md deleted file mode 100644 index ae97266e6b..0000000000 --- a/docs/api/examples/_https_edge_mutual_tls_module_get_response.md +++ /dev/null @@ -1,15 +0,0 @@ - - -#### Example Response - -```json -{ - "certificate_authorities": [ - { - "id": "ca_2rcCvZ3DnEh78JblAEkCFbQc4fi", - "uri": "https://api.ngrok.com/certificate_authorities/ca_2rcCvZ3DnEh78JblAEkCFbQc4fi" - } - ], - "enabled": true -} -``` diff --git a/docs/api/examples/_https_edge_mutual_tls_module_replace_request.md b/docs/api/examples/_https_edge_mutual_tls_module_replace_request.md deleted file mode 100644 index bdf09f315e..0000000000 --- a/docs/api/examples/_https_edge_mutual_tls_module_replace_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X PUT \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"certificate_authority_ids":["ca_2rcCvZ3DnEh78JblAEkCFbQc4fi"],"enabled":true}' \ -https://api.ngrok.com/edges/https/edghts_2rcCvbrhMfV77Brf9Vg5y0qMwF2/mutual_tls -``` diff --git a/docs/api/examples/_https_edge_mutual_tls_module_replace_response.md b/docs/api/examples/_https_edge_mutual_tls_module_replace_response.md deleted file mode 100644 index ae97266e6b..0000000000 --- a/docs/api/examples/_https_edge_mutual_tls_module_replace_response.md +++ /dev/null @@ -1,15 +0,0 @@ - - -#### Example Response - -```json -{ - "certificate_authorities": [ - { - "id": "ca_2rcCvZ3DnEh78JblAEkCFbQc4fi", - "uri": "https://api.ngrok.com/certificate_authorities/ca_2rcCvZ3DnEh78JblAEkCFbQc4fi" - } - ], - "enabled": true -} -``` diff --git a/docs/api/examples/_https_edge_tls_termination_module_delete_request.md b/docs/api/examples/_https_edge_tls_termination_module_delete_request.md deleted file mode 100644 index 0a2dab379f..0000000000 --- a/docs/api/examples/_https_edge_tls_termination_module_delete_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X DELETE \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/edges/https/edghts_2rcCvcjIFS1zA2S4i5UPLnEKOEN/tls_termination -``` diff --git a/docs/api/examples/_https_edge_tls_termination_module_delete_response.md b/docs/api/examples/_https_edge_tls_termination_module_delete_response.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/api/examples/_https_edge_tls_termination_module_get_request.md b/docs/api/examples/_https_edge_tls_termination_module_get_request.md deleted file mode 100644 index 2954bfb8ab..0000000000 --- a/docs/api/examples/_https_edge_tls_termination_module_get_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/edges/https/edghts_2rcCvcjIFS1zA2S4i5UPLnEKOEN/tls_termination -``` diff --git a/docs/api/examples/_https_edge_tls_termination_module_get_response.md b/docs/api/examples/_https_edge_tls_termination_module_get_response.md deleted file mode 100644 index b80c138941..0000000000 --- a/docs/api/examples/_https_edge_tls_termination_module_get_response.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Response - -```json -{ - "enabled": true, - "min_version": "1.3", - "terminate_at": "edge" -} -``` diff --git a/docs/api/examples/_https_edge_tls_termination_module_replace_request.md b/docs/api/examples/_https_edge_tls_termination_module_replace_request.md deleted file mode 100644 index 61b9f1a24c..0000000000 --- a/docs/api/examples/_https_edge_tls_termination_module_replace_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X PUT \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"enabled":true,"min_version":"1.3"}' \ -https://api.ngrok.com/edges/https/edghts_2rcCvcjIFS1zA2S4i5UPLnEKOEN/tls_termination -``` diff --git a/docs/api/examples/_https_edge_tls_termination_module_replace_response.md b/docs/api/examples/_https_edge_tls_termination_module_replace_response.md deleted file mode 100644 index b80c138941..0000000000 --- a/docs/api/examples/_https_edge_tls_termination_module_replace_response.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Response - -```json -{ - "enabled": true, - "min_version": "1.3", - "terminate_at": "edge" -} -``` diff --git a/docs/api/examples/_ip_policies_create_request.md b/docs/api/examples/_ip_policies_create_request.md deleted file mode 100644 index e9360eb480..0000000000 --- a/docs/api/examples/_ip_policies_create_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X POST \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"description":"API Outbound Gateway"}' \ -https://api.ngrok.com/ip_policies -``` diff --git a/docs/api/examples/_ip_policies_create_response.md b/docs/api/examples/_ip_policies_create_response.md deleted file mode 100644 index fb10ba95f0..0000000000 --- a/docs/api/examples/_ip_policies_create_response.md +++ /dev/null @@ -1,12 +0,0 @@ - - -#### Example Response - -```json -{ - "created_at": "2025-01-14T10:06:19Z", - "description": "API Outbound Gateway", - "id": "ipp_2rcCs6cg5fYhIogsPYo7MNzhDKr", - "uri": "https://api.ngrok.com/ip_policies/ipp_2rcCs6cg5fYhIogsPYo7MNzhDKr" -} -``` diff --git a/docs/api/examples/_ip_policies_delete_request.md b/docs/api/examples/_ip_policies_delete_request.md deleted file mode 100644 index a42d2e0ed4..0000000000 --- a/docs/api/examples/_ip_policies_delete_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X DELETE \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/ip_policies/ipp_2rcCs6cg5fYhIogsPYo7MNzhDKr -``` diff --git a/docs/api/examples/_ip_policies_delete_response.md b/docs/api/examples/_ip_policies_delete_response.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/api/examples/_ip_policies_get_request.md b/docs/api/examples/_ip_policies_get_request.md deleted file mode 100644 index 67f0ed042f..0000000000 --- a/docs/api/examples/_ip_policies_get_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/ip_policies/ipp_2rcCs6cg5fYhIogsPYo7MNzhDKr -``` diff --git a/docs/api/examples/_ip_policies_get_response.md b/docs/api/examples/_ip_policies_get_response.md deleted file mode 100644 index 67ccd72493..0000000000 --- a/docs/api/examples/_ip_policies_get_response.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Response - -```json -{ - "created_at": "2025-01-14T10:06:19Z", - "description": "API Outbound Gateway", - "id": "ipp_2rcCs6cg5fYhIogsPYo7MNzhDKr", - "metadata": "metadata={\"pod-id\": \"b3d9c464-4f48-4783-a741-d7d7d5db310f\"}", - "uri": "https://api.ngrok.com/ip_policies/ipp_2rcCs6cg5fYhIogsPYo7MNzhDKr" -} -``` diff --git a/docs/api/examples/_ip_policies_list_request.md b/docs/api/examples/_ip_policies_list_request.md deleted file mode 100644 index 8d8a497789..0000000000 --- a/docs/api/examples/_ip_policies_list_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/ip_policies -``` diff --git a/docs/api/examples/_ip_policies_list_response.md b/docs/api/examples/_ip_policies_list_response.md deleted file mode 100644 index c7d4109716..0000000000 --- a/docs/api/examples/_ip_policies_list_response.md +++ /dev/null @@ -1,24 +0,0 @@ - - -#### Example Response - -```json -{ - "ip_policies": [ - { - "created_at": "2025-01-14T10:06:19Z", - "description": "API Outbound Gateway", - "id": "ipp_2rcCs6cg5fYhIogsPYo7MNzhDKr", - "uri": "https://api.ngrok.com/ip_policies/ipp_2rcCs6cg5fYhIogsPYo7MNzhDKr" - }, - { - "created_at": "2025-01-14T10:06:19Z", - "description": "Developer Environments", - "id": "ipp_2rcCs3wcmdNzWNG7j98UmEERdey", - "uri": "https://api.ngrok.com/ip_policies/ipp_2rcCs3wcmdNzWNG7j98UmEERdey" - } - ], - "next_page_uri": null, - "uri": "https://api.ngrok.com/ip_policies" -} -``` diff --git a/docs/api/examples/_ip_policies_update_request.md b/docs/api/examples/_ip_policies_update_request.md deleted file mode 100644 index e816559b55..0000000000 --- a/docs/api/examples/_ip_policies_update_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X PATCH \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"metadata":"metadata={\"pod-id\": \"b3d9c464-4f48-4783-a741-d7d7d5db310f\"}"}' \ -https://api.ngrok.com/ip_policies/ipp_2rcCs6cg5fYhIogsPYo7MNzhDKr -``` diff --git a/docs/api/examples/_ip_policies_update_response.md b/docs/api/examples/_ip_policies_update_response.md deleted file mode 100644 index 67ccd72493..0000000000 --- a/docs/api/examples/_ip_policies_update_response.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Response - -```json -{ - "created_at": "2025-01-14T10:06:19Z", - "description": "API Outbound Gateway", - "id": "ipp_2rcCs6cg5fYhIogsPYo7MNzhDKr", - "metadata": "metadata={\"pod-id\": \"b3d9c464-4f48-4783-a741-d7d7d5db310f\"}", - "uri": "https://api.ngrok.com/ip_policies/ipp_2rcCs6cg5fYhIogsPYo7MNzhDKr" -} -``` diff --git a/docs/api/examples/_ip_policy_rules_create_request.md b/docs/api/examples/_ip_policy_rules_create_request.md deleted file mode 100644 index 8cfbf865fb..0000000000 --- a/docs/api/examples/_ip_policy_rules_create_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X POST \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"action":"allow","cidr":"212.3.14.0/24","description":"nyc office","ip_policy_id":"ipp_2rcCuy55uP4IJtvmT0SpDWJznJX"}' \ -https://api.ngrok.com/ip_policy_rules -``` diff --git a/docs/api/examples/_ip_policy_rules_create_response.md b/docs/api/examples/_ip_policy_rules_create_response.md deleted file mode 100644 index ff34a7d6b5..0000000000 --- a/docs/api/examples/_ip_policy_rules_create_response.md +++ /dev/null @@ -1,18 +0,0 @@ - - -#### Example Response - -```json -{ - "action": "allow", - "cidr": "212.3.14.0/24", - "created_at": "2025-01-14T10:06:42Z", - "description": "nyc office", - "id": "ipr_2rcCuy5ObXRIYTebpHcJoBeTAih", - "ip_policy": { - "id": "ipp_2rcCuy55uP4IJtvmT0SpDWJznJX", - "uri": "https://api.ngrok.com/ip_policies/ipp_2rcCuy55uP4IJtvmT0SpDWJznJX" - }, - "uri": "https://api.ngrok.com/ip_policy_rules/ipr_2rcCuy5ObXRIYTebpHcJoBeTAih" -} -``` diff --git a/docs/api/examples/_ip_policy_rules_delete_request.md b/docs/api/examples/_ip_policy_rules_delete_request.md deleted file mode 100644 index 487b44d173..0000000000 --- a/docs/api/examples/_ip_policy_rules_delete_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X DELETE \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/ip_policy_rules/ipr_2rcCuy5ObXRIYTebpHcJoBeTAih -``` diff --git a/docs/api/examples/_ip_policy_rules_delete_response.md b/docs/api/examples/_ip_policy_rules_delete_response.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/api/examples/_ip_policy_rules_get_request.md b/docs/api/examples/_ip_policy_rules_get_request.md deleted file mode 100644 index d2ab8656a2..0000000000 --- a/docs/api/examples/_ip_policy_rules_get_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/ip_policy_rules/ipr_2rcCuy5ObXRIYTebpHcJoBeTAih -``` diff --git a/docs/api/examples/_ip_policy_rules_get_response.md b/docs/api/examples/_ip_policy_rules_get_response.md deleted file mode 100644 index 5b8753da4e..0000000000 --- a/docs/api/examples/_ip_policy_rules_get_response.md +++ /dev/null @@ -1,18 +0,0 @@ - - -#### Example Response - -```json -{ - "action": "allow", - "cidr": "212.3.15.0/24", - "created_at": "2025-01-14T10:06:42Z", - "description": "nyc office", - "id": "ipr_2rcCuy5ObXRIYTebpHcJoBeTAih", - "ip_policy": { - "id": "ipp_2rcCuy55uP4IJtvmT0SpDWJznJX", - "uri": "https://api.ngrok.com/ip_policies/ipp_2rcCuy55uP4IJtvmT0SpDWJznJX" - }, - "uri": "https://api.ngrok.com/ip_policy_rules/ipr_2rcCuy5ObXRIYTebpHcJoBeTAih" -} -``` diff --git a/docs/api/examples/_ip_policy_rules_list_request.md b/docs/api/examples/_ip_policy_rules_list_request.md deleted file mode 100644 index a0afefcd68..0000000000 --- a/docs/api/examples/_ip_policy_rules_list_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/ip_policy_rules -``` diff --git a/docs/api/examples/_ip_policy_rules_list_response.md b/docs/api/examples/_ip_policy_rules_list_response.md deleted file mode 100644 index 7879ecb4aa..0000000000 --- a/docs/api/examples/_ip_policy_rules_list_response.md +++ /dev/null @@ -1,48 +0,0 @@ - - -#### Example Response - -```json -{ - "ip_policy_rules": [ - { - "action": "allow", - "cidr": "212.3.14.0/24", - "created_at": "2025-01-14T10:06:42Z", - "description": "nyc office", - "id": "ipr_2rcCuy5ObXRIYTebpHcJoBeTAih", - "ip_policy": { - "id": "ipp_2rcCuy55uP4IJtvmT0SpDWJznJX", - "uri": "https://api.ngrok.com/ip_policies/ipp_2rcCuy55uP4IJtvmT0SpDWJznJX" - }, - "uri": "https://api.ngrok.com/ip_policy_rules/ipr_2rcCuy5ObXRIYTebpHcJoBeTAih" - }, - { - "action": "allow", - "cidr": "2.2.2.2/32", - "created_at": "2025-01-14T10:06:42Z", - "description": "alan laptop", - "id": "ipr_2rcCuxLlKYYmR0Iie91BUDP9SI4", - "ip_policy": { - "id": "ipp_2rcCuy55uP4IJtvmT0SpDWJznJX", - "uri": "https://api.ngrok.com/ip_policies/ipp_2rcCuy55uP4IJtvmT0SpDWJznJX" - }, - "uri": "https://api.ngrok.com/ip_policy_rules/ipr_2rcCuxLlKYYmR0Iie91BUDP9SI4" - }, - { - "action": "allow", - "cidr": "132.2.19.0/24", - "created_at": "2025-01-14T10:06:42Z", - "description": "sf office", - "id": "ipr_2rcCuwVjhQ0glCUnBWdzW5sQRcR", - "ip_policy": { - "id": "ipp_2rcCuy55uP4IJtvmT0SpDWJznJX", - "uri": "https://api.ngrok.com/ip_policies/ipp_2rcCuy55uP4IJtvmT0SpDWJznJX" - }, - "uri": "https://api.ngrok.com/ip_policy_rules/ipr_2rcCuwVjhQ0glCUnBWdzW5sQRcR" - } - ], - "next_page_uri": null, - "uri": "https://api.ngrok.com/ip_policy_rules" -} -``` diff --git a/docs/api/examples/_ip_policy_rules_update_request.md b/docs/api/examples/_ip_policy_rules_update_request.md deleted file mode 100644 index 31b56b6808..0000000000 --- a/docs/api/examples/_ip_policy_rules_update_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X PATCH \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"cidr":"212.3.15.0/24"}' \ -https://api.ngrok.com/ip_policy_rules/ipr_2rcCuy5ObXRIYTebpHcJoBeTAih -``` diff --git a/docs/api/examples/_ip_policy_rules_update_response.md b/docs/api/examples/_ip_policy_rules_update_response.md deleted file mode 100644 index 5b8753da4e..0000000000 --- a/docs/api/examples/_ip_policy_rules_update_response.md +++ /dev/null @@ -1,18 +0,0 @@ - - -#### Example Response - -```json -{ - "action": "allow", - "cidr": "212.3.15.0/24", - "created_at": "2025-01-14T10:06:42Z", - "description": "nyc office", - "id": "ipr_2rcCuy5ObXRIYTebpHcJoBeTAih", - "ip_policy": { - "id": "ipp_2rcCuy55uP4IJtvmT0SpDWJznJX", - "uri": "https://api.ngrok.com/ip_policies/ipp_2rcCuy55uP4IJtvmT0SpDWJznJX" - }, - "uri": "https://api.ngrok.com/ip_policy_rules/ipr_2rcCuy5ObXRIYTebpHcJoBeTAih" -} -``` diff --git a/docs/api/examples/_ip_restrictions_create_request.md b/docs/api/examples/_ip_restrictions_create_request.md deleted file mode 100644 index e9e6710c65..0000000000 --- a/docs/api/examples/_ip_restrictions_create_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X POST \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"ip_policy_ids":["ipp_2rcCv0NvsfNHNG9c0BBTej63cev"],"type":"dashboard"}' \ -https://api.ngrok.com/ip_restrictions -``` diff --git a/docs/api/examples/_ip_restrictions_create_response.md b/docs/api/examples/_ip_restrictions_create_response.md deleted file mode 100644 index 6b461d0f29..0000000000 --- a/docs/api/examples/_ip_restrictions_create_response.md +++ /dev/null @@ -1,19 +0,0 @@ - - -#### Example Response - -```json -{ - "created_at": "2025-01-14T10:06:42Z", - "enforced": false, - "id": "ipx_2rcCuwLi8wMdnWj6h053No9gaWo", - "ip_policies": [ - { - "id": "ipp_2rcCv0NvsfNHNG9c0BBTej63cev", - "uri": "https://api.ngrok.com/ip_policies/ipp_2rcCv0NvsfNHNG9c0BBTej63cev" - } - ], - "type": "dashboard", - "uri": "https://api.ngrok.com/ip_restrictions/ipx_2rcCuwLi8wMdnWj6h053No9gaWo" -} -``` diff --git a/docs/api/examples/_ip_restrictions_delete_request.md b/docs/api/examples/_ip_restrictions_delete_request.md deleted file mode 100644 index 0ab645707d..0000000000 --- a/docs/api/examples/_ip_restrictions_delete_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X DELETE \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/ip_restrictions/ipx_2rcCuwLi8wMdnWj6h053No9gaWo -``` diff --git a/docs/api/examples/_ip_restrictions_delete_response.md b/docs/api/examples/_ip_restrictions_delete_response.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/api/examples/_ip_restrictions_get_request.md b/docs/api/examples/_ip_restrictions_get_request.md deleted file mode 100644 index 702a416d7c..0000000000 --- a/docs/api/examples/_ip_restrictions_get_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/ip_restrictions/ipx_2rcCuwLi8wMdnWj6h053No9gaWo -``` diff --git a/docs/api/examples/_ip_restrictions_get_response.md b/docs/api/examples/_ip_restrictions_get_response.md deleted file mode 100644 index 86d07360fe..0000000000 --- a/docs/api/examples/_ip_restrictions_get_response.md +++ /dev/null @@ -1,23 +0,0 @@ - - -#### Example Response - -```json -{ - "created_at": "2025-01-14T10:06:42Z", - "enforced": false, - "id": "ipx_2rcCuwLi8wMdnWj6h053No9gaWo", - "ip_policies": [ - { - "id": "ipp_2rcCv0NvsfNHNG9c0BBTej63cev", - "uri": "https://api.ngrok.com/ip_policies/ipp_2rcCv0NvsfNHNG9c0BBTej63cev" - }, - { - "id": "ipp_2rcCuy2ecXMC4jiQ0Hb50bVoQIO", - "uri": "https://api.ngrok.com/ip_policies/ipp_2rcCuy2ecXMC4jiQ0Hb50bVoQIO" - } - ], - "type": "dashboard", - "uri": "https://api.ngrok.com/ip_restrictions/ipx_2rcCuwLi8wMdnWj6h053No9gaWo" -} -``` diff --git a/docs/api/examples/_ip_restrictions_list_request.md b/docs/api/examples/_ip_restrictions_list_request.md deleted file mode 100644 index 3b08bb0da7..0000000000 --- a/docs/api/examples/_ip_restrictions_list_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/ip_restrictions -``` diff --git a/docs/api/examples/_ip_restrictions_list_response.md b/docs/api/examples/_ip_restrictions_list_response.md deleted file mode 100644 index 1e51d72067..0000000000 --- a/docs/api/examples/_ip_restrictions_list_response.md +++ /dev/null @@ -1,25 +0,0 @@ - - -#### Example Response - -```json -{ - "ip_restrictions": [ - { - "created_at": "2025-01-14T10:06:42Z", - "enforced": false, - "id": "ipx_2rcCuwLi8wMdnWj6h053No9gaWo", - "ip_policies": [ - { - "id": "ipp_2rcCv0NvsfNHNG9c0BBTej63cev", - "uri": "https://api.ngrok.com/ip_policies/ipp_2rcCv0NvsfNHNG9c0BBTej63cev" - } - ], - "type": "dashboard", - "uri": "https://api.ngrok.com/ip_restrictions/ipx_2rcCuwLi8wMdnWj6h053No9gaWo" - } - ], - "next_page_uri": null, - "uri": "https://api.ngrok.com/ip_restrictions" -} -``` diff --git a/docs/api/examples/_ip_restrictions_update_request.md b/docs/api/examples/_ip_restrictions_update_request.md deleted file mode 100644 index 40b078c133..0000000000 --- a/docs/api/examples/_ip_restrictions_update_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X PATCH \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"ip_policy_ids":["ipp_2rcCv0NvsfNHNG9c0BBTej63cev","ipp_2rcCuy2ecXMC4jiQ0Hb50bVoQIO"]}' \ -https://api.ngrok.com/ip_restrictions/ipx_2rcCuwLi8wMdnWj6h053No9gaWo -``` diff --git a/docs/api/examples/_ip_restrictions_update_response.md b/docs/api/examples/_ip_restrictions_update_response.md deleted file mode 100644 index 86d07360fe..0000000000 --- a/docs/api/examples/_ip_restrictions_update_response.md +++ /dev/null @@ -1,23 +0,0 @@ - - -#### Example Response - -```json -{ - "created_at": "2025-01-14T10:06:42Z", - "enforced": false, - "id": "ipx_2rcCuwLi8wMdnWj6h053No9gaWo", - "ip_policies": [ - { - "id": "ipp_2rcCv0NvsfNHNG9c0BBTej63cev", - "uri": "https://api.ngrok.com/ip_policies/ipp_2rcCv0NvsfNHNG9c0BBTej63cev" - }, - { - "id": "ipp_2rcCuy2ecXMC4jiQ0Hb50bVoQIO", - "uri": "https://api.ngrok.com/ip_policies/ipp_2rcCuy2ecXMC4jiQ0Hb50bVoQIO" - } - ], - "type": "dashboard", - "uri": "https://api.ngrok.com/ip_restrictions/ipx_2rcCuwLi8wMdnWj6h053No9gaWo" -} -``` diff --git a/docs/api/examples/_reserved_addrs_create_request.md b/docs/api/examples/_reserved_addrs_create_request.md deleted file mode 100644 index 630eda8282..0000000000 --- a/docs/api/examples/_reserved_addrs_create_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X POST \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"description":"SSH for device #001","region":"us"}' \ -https://api.ngrok.com/reserved_addrs -``` diff --git a/docs/api/examples/_reserved_addrs_create_response.md b/docs/api/examples/_reserved_addrs_create_response.md deleted file mode 100644 index fcfffb9ddc..0000000000 --- a/docs/api/examples/_reserved_addrs_create_response.md +++ /dev/null @@ -1,15 +0,0 @@ - - -#### Example Response - -```json -{ - "addr": "1.tcp.ngrok.io:20000", - "created_at": "2025-01-14T10:06:20Z", - "description": "SSH for device #001", - "endpoint_configuration": null, - "id": "ra_2rcCsC8wUcmf329OtjmRLtzO55v", - "region": "us", - "uri": "https://api.ngrok.com/reserved_addrs/ra_2rcCsC8wUcmf329OtjmRLtzO55v" -} -``` diff --git a/docs/api/examples/_reserved_addrs_delete_endpoint_config_request.md b/docs/api/examples/_reserved_addrs_delete_endpoint_config_request.md deleted file mode 100644 index c990e13078..0000000000 --- a/docs/api/examples/_reserved_addrs_delete_endpoint_config_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X DELETE \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/reserved_addrs/ra_2rcCsC8wUcmf329OtjmRLtzO55v/endpoint_configuration -``` diff --git a/docs/api/examples/_reserved_addrs_delete_endpoint_config_response.md b/docs/api/examples/_reserved_addrs_delete_endpoint_config_response.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/api/examples/_reserved_addrs_delete_request.md b/docs/api/examples/_reserved_addrs_delete_request.md deleted file mode 100644 index bd8758d768..0000000000 --- a/docs/api/examples/_reserved_addrs_delete_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X DELETE \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/reserved_addrs/ra_2rcCsC8wUcmf329OtjmRLtzO55v -``` diff --git a/docs/api/examples/_reserved_addrs_delete_response.md b/docs/api/examples/_reserved_addrs_delete_response.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/api/examples/_reserved_addrs_get_request.md b/docs/api/examples/_reserved_addrs_get_request.md deleted file mode 100644 index 980a8471b2..0000000000 --- a/docs/api/examples/_reserved_addrs_get_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/reserved_addrs/ra_2rcCsC8wUcmf329OtjmRLtzO55v -``` diff --git a/docs/api/examples/_reserved_addrs_get_response.md b/docs/api/examples/_reserved_addrs_get_response.md deleted file mode 100644 index f7bb3c9abd..0000000000 --- a/docs/api/examples/_reserved_addrs_get_response.md +++ /dev/null @@ -1,19 +0,0 @@ - - -#### Example Response - -```json -{ - "addr": "1.tcp.ngrok.io:20000", - "created_at": "2025-01-14T10:06:20Z", - "description": "SSH for device #001", - "endpoint_configuration": { - "id": "ec_2rcCsATxcaKJt8xdX8CaJQySOI0", - "uri": "https://api.ngrok.com/endpoint_configurations/ec_2rcCsATxcaKJt8xdX8CaJQySOI0" - }, - "id": "ra_2rcCsC8wUcmf329OtjmRLtzO55v", - "metadata": "{\"proto\": \"ssh\"}", - "region": "us", - "uri": "https://api.ngrok.com/reserved_addrs/ra_2rcCsC8wUcmf329OtjmRLtzO55v" -} -``` diff --git a/docs/api/examples/_reserved_addrs_list_request.md b/docs/api/examples/_reserved_addrs_list_request.md deleted file mode 100644 index 91ba67d1f2..0000000000 --- a/docs/api/examples/_reserved_addrs_list_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/reserved_addrs -``` diff --git a/docs/api/examples/_reserved_addrs_list_response.md b/docs/api/examples/_reserved_addrs_list_response.md deleted file mode 100644 index 85313ea0f7..0000000000 --- a/docs/api/examples/_reserved_addrs_list_response.md +++ /dev/null @@ -1,21 +0,0 @@ - - -#### Example Response - -```json -{ - "next_page_uri": null, - "reserved_addrs": [ - { - "addr": "1.tcp.ngrok.io:20000", - "created_at": "2025-01-14T10:06:20Z", - "description": "SSH for device #001", - "endpoint_configuration": null, - "id": "ra_2rcCsC8wUcmf329OtjmRLtzO55v", - "region": "us", - "uri": "https://api.ngrok.com/reserved_addrs/ra_2rcCsC8wUcmf329OtjmRLtzO55v" - } - ], - "uri": "https://api.ngrok.com/reserved_addrs" -} -``` diff --git a/docs/api/examples/_reserved_addrs_update_request.md b/docs/api/examples/_reserved_addrs_update_request.md deleted file mode 100644 index 4af70b501b..0000000000 --- a/docs/api/examples/_reserved_addrs_update_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X PATCH \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"endpoint_configuration_id":"ec_2rcCsATxcaKJt8xdX8CaJQySOI0","metadata":"{\"proto\": \"ssh\"}"}' \ -https://api.ngrok.com/reserved_addrs/ra_2rcCsC8wUcmf329OtjmRLtzO55v -``` diff --git a/docs/api/examples/_reserved_addrs_update_response.md b/docs/api/examples/_reserved_addrs_update_response.md deleted file mode 100644 index f7bb3c9abd..0000000000 --- a/docs/api/examples/_reserved_addrs_update_response.md +++ /dev/null @@ -1,19 +0,0 @@ - - -#### Example Response - -```json -{ - "addr": "1.tcp.ngrok.io:20000", - "created_at": "2025-01-14T10:06:20Z", - "description": "SSH for device #001", - "endpoint_configuration": { - "id": "ec_2rcCsATxcaKJt8xdX8CaJQySOI0", - "uri": "https://api.ngrok.com/endpoint_configurations/ec_2rcCsATxcaKJt8xdX8CaJQySOI0" - }, - "id": "ra_2rcCsC8wUcmf329OtjmRLtzO55v", - "metadata": "{\"proto\": \"ssh\"}", - "region": "us", - "uri": "https://api.ngrok.com/reserved_addrs/ra_2rcCsC8wUcmf329OtjmRLtzO55v" -} -``` diff --git a/docs/api/examples/_reserved_domains_create_request.md b/docs/api/examples/_reserved_domains_create_request.md deleted file mode 100644 index c2aac89523..0000000000 --- a/docs/api/examples/_reserved_domains_create_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X POST \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"certificate_id":"cert_2rcCs2QtJegkrx6XjyNk7c2wjfp","domain":"myapp.mydomain.com","region":"us"}' \ -https://api.ngrok.com/reserved_domains -``` diff --git a/docs/api/examples/_reserved_domains_create_response.md b/docs/api/examples/_reserved_domains_create_response.md deleted file mode 100644 index 0857a4635f..0000000000 --- a/docs/api/examples/_reserved_domains_create_response.md +++ /dev/null @@ -1,24 +0,0 @@ - - -#### Example Response - -```json -{ - "acme_challenge_cname_target": null, - "certificate": { - "id": "cert_2rcCs2QtJegkrx6XjyNk7c2wjfp", - "uri": "https://api.ngrok.com/tls_certificates/cert_2rcCs2QtJegkrx6XjyNk7c2wjfp" - }, - "certificate_management_policy": null, - "certificate_management_status": null, - "cname_target": "2udamkamcl8pjmrff.eajme8nywqbcrdze.local-ngrok-cname.com", - "created_at": "2025-01-14T10:06:19Z", - "domain": "myapp.mydomain.com", - "error_redirect_url": null, - "http_endpoint_configuration": null, - "https_endpoint_configuration": null, - "id": "rd_2rcCsFEeGvfH4xHI6enw7OTrnEt", - "region": "", - "uri": "https://api.ngrok.com/reserved_domains/rd_2rcCsFEeGvfH4xHI6enw7OTrnEt" -} -``` diff --git a/docs/api/examples/_reserved_domains_delete_certificate_management_policy_request.md b/docs/api/examples/_reserved_domains_delete_certificate_management_policy_request.md deleted file mode 100644 index 62a13dc544..0000000000 --- a/docs/api/examples/_reserved_domains_delete_certificate_management_policy_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X DELETE \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/reserved_domains/rd_2rcCsFEeGvfH4xHI6enw7OTrnEt/certificate_management_policy -``` diff --git a/docs/api/examples/_reserved_domains_delete_certificate_management_policy_response.md b/docs/api/examples/_reserved_domains_delete_certificate_management_policy_response.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/api/examples/_reserved_domains_delete_certificate_request.md b/docs/api/examples/_reserved_domains_delete_certificate_request.md deleted file mode 100644 index abea114387..0000000000 --- a/docs/api/examples/_reserved_domains_delete_certificate_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X DELETE \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/reserved_domains/rd_2rcCsFEeGvfH4xHI6enw7OTrnEt/certificate -``` diff --git a/docs/api/examples/_reserved_domains_delete_certificate_response.md b/docs/api/examples/_reserved_domains_delete_certificate_response.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/api/examples/_reserved_domains_delete_http_endpoint_config_request.md b/docs/api/examples/_reserved_domains_delete_http_endpoint_config_request.md deleted file mode 100644 index f4c6998908..0000000000 --- a/docs/api/examples/_reserved_domains_delete_http_endpoint_config_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X DELETE \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/reserved_domains/rd_2rcCsFEeGvfH4xHI6enw7OTrnEt/http_endpoint_configuration -``` diff --git a/docs/api/examples/_reserved_domains_delete_http_endpoint_config_response.md b/docs/api/examples/_reserved_domains_delete_http_endpoint_config_response.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/api/examples/_reserved_domains_delete_https_endpoint_config_request.md b/docs/api/examples/_reserved_domains_delete_https_endpoint_config_request.md deleted file mode 100644 index d56a432f6a..0000000000 --- a/docs/api/examples/_reserved_domains_delete_https_endpoint_config_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X DELETE \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/reserved_domains/rd_2rcCsFEeGvfH4xHI6enw7OTrnEt/https_endpoint_configuration -``` diff --git a/docs/api/examples/_reserved_domains_delete_https_endpoint_config_response.md b/docs/api/examples/_reserved_domains_delete_https_endpoint_config_response.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/api/examples/_reserved_domains_delete_request.md b/docs/api/examples/_reserved_domains_delete_request.md deleted file mode 100644 index 48d747fa3c..0000000000 --- a/docs/api/examples/_reserved_domains_delete_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X DELETE \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/reserved_domains/rd_2rcCsFEeGvfH4xHI6enw7OTrnEt -``` diff --git a/docs/api/examples/_reserved_domains_delete_response.md b/docs/api/examples/_reserved_domains_delete_response.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/api/examples/_reserved_domains_get_request.md b/docs/api/examples/_reserved_domains_get_request.md deleted file mode 100644 index 4138ebf6bf..0000000000 --- a/docs/api/examples/_reserved_domains_get_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/reserved_domains/rd_2rcCsFEeGvfH4xHI6enw7OTrnEt -``` diff --git a/docs/api/examples/_reserved_domains_get_response.md b/docs/api/examples/_reserved_domains_get_response.md deleted file mode 100644 index 162a3305b7..0000000000 --- a/docs/api/examples/_reserved_domains_get_response.md +++ /dev/null @@ -1,32 +0,0 @@ - - -#### Example Response - -```json -{ - "acme_challenge_cname_target": null, - "certificate": null, - "certificate_management_policy": { - "authority": "letsencrypt", - "private_key_type": "ecdsa" - }, - "certificate_management_status": null, - "cname_target": "2udamkamcl8pjmrff.eajme8nywqbcrdze.local-ngrok-cname.com", - "created_at": "2025-01-14T10:06:19Z", - "description": "point-of-sale new york #302", - "domain": "myapp.mydomain.com", - "error_redirect_url": null, - "http_endpoint_configuration": { - "id": "ec_2rcCsG1qTwP7vsyJ6UeKqyyH7oo", - "uri": "https://api.ngrok.com/endpoint_configurations/ec_2rcCsG1qTwP7vsyJ6UeKqyyH7oo" - }, - "https_endpoint_configuration": { - "id": "ec_2rcCsCNMURvk8KnF2aI1vxxq01K", - "uri": "https://api.ngrok.com/endpoint_configurations/ec_2rcCsCNMURvk8KnF2aI1vxxq01K" - }, - "id": "rd_2rcCsFEeGvfH4xHI6enw7OTrnEt", - "metadata": "{env: \"staging\", \"connector_id\":\"64698fcc-5f5c-4b63-910e-8669d04bd943\"}", - "region": "", - "uri": "https://api.ngrok.com/reserved_domains/rd_2rcCsFEeGvfH4xHI6enw7OTrnEt" -} -``` diff --git a/docs/api/examples/_reserved_domains_list_request.md b/docs/api/examples/_reserved_domains_list_request.md deleted file mode 100644 index 23d2a296e1..0000000000 --- a/docs/api/examples/_reserved_domains_list_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/reserved_domains -``` diff --git a/docs/api/examples/_reserved_domains_list_response.md b/docs/api/examples/_reserved_domains_list_response.md deleted file mode 100644 index 27a5880a3a..0000000000 --- a/docs/api/examples/_reserved_domains_list_response.md +++ /dev/null @@ -1,58 +0,0 @@ - - -#### Example Response - -```json -{ - "next_page_uri": null, - "reserved_domains": [ - { - "acme_challenge_cname_target": null, - "certificate": { - "id": "cert_2rcCs2QtJegkrx6XjyNk7c2wjfp", - "uri": "https://api.ngrok.com/tls_certificates/cert_2rcCs2QtJegkrx6XjyNk7c2wjfp" - }, - "certificate_management_policy": null, - "certificate_management_status": null, - "cname_target": "2udamkamcl8pjmrff.eajme8nywqbcrdze.local-ngrok-cname.com", - "created_at": "2025-01-14T10:06:19Z", - "domain": "myapp.mydomain.com", - "error_redirect_url": null, - "http_endpoint_configuration": null, - "https_endpoint_configuration": null, - "id": "rd_2rcCsFEeGvfH4xHI6enw7OTrnEt", - "region": "", - "uri": "https://api.ngrok.com/reserved_domains/rd_2rcCsFEeGvfH4xHI6enw7OTrnEt" - }, - { - "acme_challenge_cname_target": null, - "certificate": null, - "certificate_management_policy": { - "authority": "letsencrypt", - "private_key_type": "ecdsa" - }, - "certificate_management_status": { - "provisioning_job": { - "error_code": null, - "msg": "Managed certificate provisioning in progress.", - "retries_at": null, - "started_at": "2025-01-14T10:06:20Z" - }, - "renews_at": null - }, - "cname_target": "4knqktdwka2umyjjc.eajme8nywqbcrdze.local-ngrok-cname.com", - "created_at": "2025-01-14T10:06:20Z", - "description": "Device 0001 Dashboard", - "domain": "manage-0002.app.example.com", - "error_redirect_url": null, - "http_endpoint_configuration": null, - "https_endpoint_configuration": null, - "id": "rd_2rcCsEmalDeT7tzEQyeFzCZa9br", - "metadata": "{\"service\": \"dashboard\"}", - "region": "", - "uri": "https://api.ngrok.com/reserved_domains/rd_2rcCsEmalDeT7tzEQyeFzCZa9br" - } - ], - "uri": "https://api.ngrok.com/reserved_domains" -} -``` diff --git a/docs/api/examples/_reserved_domains_update_request.md b/docs/api/examples/_reserved_domains_update_request.md deleted file mode 100644 index 56195b801d..0000000000 --- a/docs/api/examples/_reserved_domains_update_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X PATCH \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"certificate_management_policy":{"authority":"letsencrypt"},"description":"point-of-sale new york #302","http_endpoint_configuration_id":"ec_2rcCsG1qTwP7vsyJ6UeKqyyH7oo","https_endpoint_configuration_id":"ec_2rcCsCNMURvk8KnF2aI1vxxq01K","metadata":"{env: \"staging\", \"connector_id\":\"64698fcc-5f5c-4b63-910e-8669d04bd943\"}"}' \ -https://api.ngrok.com/reserved_domains/rd_2rcCsFEeGvfH4xHI6enw7OTrnEt -``` diff --git a/docs/api/examples/_reserved_domains_update_response.md b/docs/api/examples/_reserved_domains_update_response.md deleted file mode 100644 index 162a3305b7..0000000000 --- a/docs/api/examples/_reserved_domains_update_response.md +++ /dev/null @@ -1,32 +0,0 @@ - - -#### Example Response - -```json -{ - "acme_challenge_cname_target": null, - "certificate": null, - "certificate_management_policy": { - "authority": "letsencrypt", - "private_key_type": "ecdsa" - }, - "certificate_management_status": null, - "cname_target": "2udamkamcl8pjmrff.eajme8nywqbcrdze.local-ngrok-cname.com", - "created_at": "2025-01-14T10:06:19Z", - "description": "point-of-sale new york #302", - "domain": "myapp.mydomain.com", - "error_redirect_url": null, - "http_endpoint_configuration": { - "id": "ec_2rcCsG1qTwP7vsyJ6UeKqyyH7oo", - "uri": "https://api.ngrok.com/endpoint_configurations/ec_2rcCsG1qTwP7vsyJ6UeKqyyH7oo" - }, - "https_endpoint_configuration": { - "id": "ec_2rcCsCNMURvk8KnF2aI1vxxq01K", - "uri": "https://api.ngrok.com/endpoint_configurations/ec_2rcCsCNMURvk8KnF2aI1vxxq01K" - }, - "id": "rd_2rcCsFEeGvfH4xHI6enw7OTrnEt", - "metadata": "{env: \"staging\", \"connector_id\":\"64698fcc-5f5c-4b63-910e-8669d04bd943\"}", - "region": "", - "uri": "https://api.ngrok.com/reserved_domains/rd_2rcCsFEeGvfH4xHI6enw7OTrnEt" -} -``` diff --git a/docs/api/examples/_self_request.md b/docs/api/examples/_self_request.md deleted file mode 100644 index c03992c2bf..0000000000 --- a/docs/api/examples/_self_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/self -``` diff --git a/docs/api/examples/_self_response.md b/docs/api/examples/_self_response.md deleted file mode 100644 index 43365e752c..0000000000 --- a/docs/api/examples/_self_response.md +++ /dev/null @@ -1,28 +0,0 @@ - - -#### Example Response - -```json -{ - "account": { - "created_at": "2025-01-14T10:06:19Z", - "enforce_sso": false, - "id": "ac_2rcCs6QHNT2WE5H8uixf6F79LVU", - "min_agent_version": "2.3.0", - "min_api_version": 2, - "name": "api-examples-7b8623844c2b61c9@example.com", - "suspended": false, - "traffic_full_capture": false, - "user_mfa_required": false - }, - "api_key": { - "created_at": "2025-01-14T10:06:19Z", - "description": "api key for example generation", - "id": "ak_2rcCs97dFyv42ODMsLW4ypnRtP1", - "owner_id": "usr_2rcCs3aBfA01H0kq4OxydHqoED0", - "token": null, - "uri": "/api_keys/ak_2rcCs97dFyv42ODMsLW4ypnRtP1" - }, - "user": "api-examples-7b8623844c2b61c9@example.com" -} -``` diff --git a/docs/api/examples/_ssh_certificate_authorities_create_request.md b/docs/api/examples/_ssh_certificate_authorities_create_request.md deleted file mode 100644 index ff893bc5c8..0000000000 --- a/docs/api/examples/_ssh_certificate_authorities_create_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X POST \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"description":"Staging Environment Hosts","private_key_type":"ed25519"}' \ -https://api.ngrok.com/ssh_certificate_authorities -``` diff --git a/docs/api/examples/_ssh_certificate_authorities_create_response.md b/docs/api/examples/_ssh_certificate_authorities_create_response.md deleted file mode 100644 index 41e172b597..0000000000 --- a/docs/api/examples/_ssh_certificate_authorities_create_response.md +++ /dev/null @@ -1,14 +0,0 @@ - - -#### Example Response - -```json -{ - "created_at": "2025-01-14T10:06:43Z", - "description": "Staging Environment Hosts", - "id": "sshca_2rcCv7g5jSq6g1xKB4oJNRRGPwI", - "key_type": "ed25519", - "public_key": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIM1+zPaCvVGkijhLdQ97R4JCDZkevqbmkp/jkNWoDVqk", - "uri": "https://api.ngrok.com/ssh_certificate_authorities/sshca_2rcCv7g5jSq6g1xKB4oJNRRGPwI" -} -``` diff --git a/docs/api/examples/_ssh_certificate_authorities_delete_request.md b/docs/api/examples/_ssh_certificate_authorities_delete_request.md deleted file mode 100644 index 6b9a3b13f5..0000000000 --- a/docs/api/examples/_ssh_certificate_authorities_delete_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X DELETE \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/ssh_certificate_authorities/sshca_2rcCv7g5jSq6g1xKB4oJNRRGPwI -``` diff --git a/docs/api/examples/_ssh_certificate_authorities_delete_response.md b/docs/api/examples/_ssh_certificate_authorities_delete_response.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/api/examples/_ssh_certificate_authorities_get_request.md b/docs/api/examples/_ssh_certificate_authorities_get_request.md deleted file mode 100644 index 54fd58d865..0000000000 --- a/docs/api/examples/_ssh_certificate_authorities_get_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/ssh_certificate_authorities/sshca_2rcCv7g5jSq6g1xKB4oJNRRGPwI -``` diff --git a/docs/api/examples/_ssh_certificate_authorities_get_response.md b/docs/api/examples/_ssh_certificate_authorities_get_response.md deleted file mode 100644 index 95807e35d1..0000000000 --- a/docs/api/examples/_ssh_certificate_authorities_get_response.md +++ /dev/null @@ -1,15 +0,0 @@ - - -#### Example Response - -```json -{ - "created_at": "2025-01-14T10:06:43Z", - "description": "Staging Environment Hosts", - "id": "sshca_2rcCv7g5jSq6g1xKB4oJNRRGPwI", - "key_type": "ed25519", - "metadata": "{\"region\": \"us-east-1\"}", - "public_key": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIM1+zPaCvVGkijhLdQ97R4JCDZkevqbmkp/jkNWoDVqk", - "uri": "https://api.ngrok.com/ssh_certificate_authorities/sshca_2rcCv7g5jSq6g1xKB4oJNRRGPwI" -} -``` diff --git a/docs/api/examples/_ssh_certificate_authorities_list_request.md b/docs/api/examples/_ssh_certificate_authorities_list_request.md deleted file mode 100644 index 6d729fd333..0000000000 --- a/docs/api/examples/_ssh_certificate_authorities_list_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/ssh_certificate_authorities -``` diff --git a/docs/api/examples/_ssh_certificate_authorities_list_response.md b/docs/api/examples/_ssh_certificate_authorities_list_response.md deleted file mode 100644 index ec2882e70a..0000000000 --- a/docs/api/examples/_ssh_certificate_authorities_list_response.md +++ /dev/null @@ -1,20 +0,0 @@ - - -#### Example Response - -```json -{ - "next_page_uri": null, - "ssh_certificate_authorities": [ - { - "created_at": "2025-01-14T10:06:43Z", - "description": "Staging Environment Hosts", - "id": "sshca_2rcCv7g5jSq6g1xKB4oJNRRGPwI", - "key_type": "ed25519", - "public_key": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIM1+zPaCvVGkijhLdQ97R4JCDZkevqbmkp/jkNWoDVqk", - "uri": "https://api.ngrok.com/ssh_certificate_authorities/sshca_2rcCv7g5jSq6g1xKB4oJNRRGPwI" - } - ], - "uri": "https://api.ngrok.com/ssh_certificate_authorities" -} -``` diff --git a/docs/api/examples/_ssh_certificate_authorities_update_request.md b/docs/api/examples/_ssh_certificate_authorities_update_request.md deleted file mode 100644 index f4c5423e10..0000000000 --- a/docs/api/examples/_ssh_certificate_authorities_update_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X PATCH \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"metadata":"{\"region\": \"us-east-1\"}"}' \ -https://api.ngrok.com/ssh_certificate_authorities/sshca_2rcCv7g5jSq6g1xKB4oJNRRGPwI -``` diff --git a/docs/api/examples/_ssh_certificate_authorities_update_response.md b/docs/api/examples/_ssh_certificate_authorities_update_response.md deleted file mode 100644 index 95807e35d1..0000000000 --- a/docs/api/examples/_ssh_certificate_authorities_update_response.md +++ /dev/null @@ -1,15 +0,0 @@ - - -#### Example Response - -```json -{ - "created_at": "2025-01-14T10:06:43Z", - "description": "Staging Environment Hosts", - "id": "sshca_2rcCv7g5jSq6g1xKB4oJNRRGPwI", - "key_type": "ed25519", - "metadata": "{\"region\": \"us-east-1\"}", - "public_key": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIM1+zPaCvVGkijhLdQ97R4JCDZkevqbmkp/jkNWoDVqk", - "uri": "https://api.ngrok.com/ssh_certificate_authorities/sshca_2rcCv7g5jSq6g1xKB4oJNRRGPwI" -} -``` diff --git a/docs/api/examples/_ssh_credentials_create_request.md b/docs/api/examples/_ssh_credentials_create_request.md deleted file mode 100644 index a80a39b0ca..0000000000 --- a/docs/api/examples/_ssh_credentials_create_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X POST \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"acl":["bind:1.tcp.ngrok.io:20002","bind:132.devices.company.com"],"description":"for device #132","public_key":"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDmGS49FkSODAcKhn3+/47DW2zEn19BZvzRQ8RZjL3v6hCIX2qXfsFK35EGxNI0wV23H4xXC2gVRPHKU71YnCb50tad3yMBTM6+2yfGsEDasEH/anmBLclChKvuGiT547RskZlpbAbdq3GvbzmY+R/2EBRMOiObpc8XmSzKAd05j28kqN0+rZO65SWId0MXdvJdSCSAnuRqBNd/aXKlu8hBPDcgwbT2lMkuR+ApoBS2FLRBOiQyt2Ol0T7Uuf7lTLlazpGB3uTw5zFYUNXkuuI6cAP8QYuY1Bne/hNrG8t3Aw9a1yc2C4Fz1hJ/4OMRxTQ8SUQf+Rmxs8DryMlMFJ8r device132@example.com"}' \ -https://api.ngrok.com/ssh_credentials -``` diff --git a/docs/api/examples/_ssh_credentials_create_response.md b/docs/api/examples/_ssh_credentials_create_response.md deleted file mode 100644 index dd3310c13e..0000000000 --- a/docs/api/examples/_ssh_credentials_create_response.md +++ /dev/null @@ -1,15 +0,0 @@ - - -#### Example Response - -```json -{ - "acl": ["bind:1.tcp.ngrok.io:20002", "bind:132.devices.company.com"], - "created_at": "2025-01-14T10:06:42Z", - "description": "for device #132", - "id": "sshcr_2rcCv1qLfkFjQMNXEnB5UoK05yE", - "owner_id": "usr_2rcCs3aBfA01H0kq4OxydHqoED0", - "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDmGS49FkSODAcKhn3+/47DW2zEn19BZvzRQ8RZjL3v6hCIX2qXfsFK35EGxNI0wV23H4xXC2gVRPHKU71YnCb50tad3yMBTM6+2yfGsEDasEH/anmBLclChKvuGiT547RskZlpbAbdq3GvbzmY+R/2EBRMOiObpc8XmSzKAd05j28kqN0+rZO65SWId0MXdvJdSCSAnuRqBNd/aXKlu8hBPDcgwbT2lMkuR+ApoBS2FLRBOiQyt2Ol0T7Uuf7lTLlazpGB3uTw5zFYUNXkuuI6cAP8QYuY1Bne/hNrG8t3Aw9a1yc2C4Fz1hJ/4OMRxTQ8SUQf+Rmxs8DryMlMFJ8r device132@example.com", - "uri": "https://api.ngrok.com/ssh_credentials/sshcr_2rcCv1qLfkFjQMNXEnB5UoK05yE" -} -``` diff --git a/docs/api/examples/_ssh_credentials_delete_request.md b/docs/api/examples/_ssh_credentials_delete_request.md deleted file mode 100644 index e5c19f9491..0000000000 --- a/docs/api/examples/_ssh_credentials_delete_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X DELETE \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/ssh_credentials/sshcr_2rcCv1qLfkFjQMNXEnB5UoK05yE -``` diff --git a/docs/api/examples/_ssh_credentials_delete_response.md b/docs/api/examples/_ssh_credentials_delete_response.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/api/examples/_ssh_credentials_get_request.md b/docs/api/examples/_ssh_credentials_get_request.md deleted file mode 100644 index a428cc2ea7..0000000000 --- a/docs/api/examples/_ssh_credentials_get_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/ssh_credentials/sshcr_2rcCv1qLfkFjQMNXEnB5UoK05yE -``` diff --git a/docs/api/examples/_ssh_credentials_get_response.md b/docs/api/examples/_ssh_credentials_get_response.md deleted file mode 100644 index d995299f9c..0000000000 --- a/docs/api/examples/_ssh_credentials_get_response.md +++ /dev/null @@ -1,16 +0,0 @@ - - -#### Example Response - -```json -{ - "acl": ["bind:1.tcp.ngrok.io:20002", "bind:132.devices.company.com"], - "created_at": "2025-01-14T10:06:42Z", - "description": "my dev machine", - "id": "sshcr_2rcCv1qLfkFjQMNXEnB5UoK05yE", - "metadata": "{\"hostname\": \"macbook.local\"}", - "owner_id": "usr_2rcCs3aBfA01H0kq4OxydHqoED0", - "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDmGS49FkSODAcKhn3+/47DW2zEn19BZvzRQ8RZjL3v6hCIX2qXfsFK35EGxNI0wV23H4xXC2gVRPHKU71YnCb50tad3yMBTM6+2yfGsEDasEH/anmBLclChKvuGiT547RskZlpbAbdq3GvbzmY+R/2EBRMOiObpc8XmSzKAd05j28kqN0+rZO65SWId0MXdvJdSCSAnuRqBNd/aXKlu8hBPDcgwbT2lMkuR+ApoBS2FLRBOiQyt2Ol0T7Uuf7lTLlazpGB3uTw5zFYUNXkuuI6cAP8QYuY1Bne/hNrG8t3Aw9a1yc2C4Fz1hJ/4OMRxTQ8SUQf+Rmxs8DryMlMFJ8r device132@example.com", - "uri": "https://api.ngrok.com/ssh_credentials/sshcr_2rcCv1qLfkFjQMNXEnB5UoK05yE" -} -``` diff --git a/docs/api/examples/_ssh_credentials_list_request.md b/docs/api/examples/_ssh_credentials_list_request.md deleted file mode 100644 index 76763b480a..0000000000 --- a/docs/api/examples/_ssh_credentials_list_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/ssh_credentials -``` diff --git a/docs/api/examples/_ssh_credentials_list_response.md b/docs/api/examples/_ssh_credentials_list_response.md deleted file mode 100644 index b779c5d43e..0000000000 --- a/docs/api/examples/_ssh_credentials_list_response.md +++ /dev/null @@ -1,21 +0,0 @@ - - -#### Example Response - -```json -{ - "next_page_uri": null, - "ssh_credentials": [ - { - "acl": ["bind:1.tcp.ngrok.io:20002", "bind:132.devices.company.com"], - "created_at": "2025-01-14T10:06:42Z", - "description": "for device #132", - "id": "sshcr_2rcCv1qLfkFjQMNXEnB5UoK05yE", - "owner_id": "usr_2rcCs3aBfA01H0kq4OxydHqoED0", - "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDmGS49FkSODAcKhn3+/47DW2zEn19BZvzRQ8RZjL3v6hCIX2qXfsFK35EGxNI0wV23H4xXC2gVRPHKU71YnCb50tad3yMBTM6+2yfGsEDasEH/anmBLclChKvuGiT547RskZlpbAbdq3GvbzmY+R/2EBRMOiObpc8XmSzKAd05j28kqN0+rZO65SWId0MXdvJdSCSAnuRqBNd/aXKlu8hBPDcgwbT2lMkuR+ApoBS2FLRBOiQyt2Ol0T7Uuf7lTLlazpGB3uTw5zFYUNXkuuI6cAP8QYuY1Bne/hNrG8t3Aw9a1yc2C4Fz1hJ/4OMRxTQ8SUQf+Rmxs8DryMlMFJ8r device132@example.com", - "uri": "https://api.ngrok.com/ssh_credentials/sshcr_2rcCv1qLfkFjQMNXEnB5UoK05yE" - } - ], - "uri": "https://api.ngrok.com/ssh_credentials" -} -``` diff --git a/docs/api/examples/_ssh_credentials_update_request.md b/docs/api/examples/_ssh_credentials_update_request.md deleted file mode 100644 index dcf87d156a..0000000000 --- a/docs/api/examples/_ssh_credentials_update_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X PATCH \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"description":"my dev machine","metadata":"{\"hostname\": \"macbook.local\"}"}' \ -https://api.ngrok.com/ssh_credentials/sshcr_2rcCv1qLfkFjQMNXEnB5UoK05yE -``` diff --git a/docs/api/examples/_ssh_credentials_update_response.md b/docs/api/examples/_ssh_credentials_update_response.md deleted file mode 100644 index d995299f9c..0000000000 --- a/docs/api/examples/_ssh_credentials_update_response.md +++ /dev/null @@ -1,16 +0,0 @@ - - -#### Example Response - -```json -{ - "acl": ["bind:1.tcp.ngrok.io:20002", "bind:132.devices.company.com"], - "created_at": "2025-01-14T10:06:42Z", - "description": "my dev machine", - "id": "sshcr_2rcCv1qLfkFjQMNXEnB5UoK05yE", - "metadata": "{\"hostname\": \"macbook.local\"}", - "owner_id": "usr_2rcCs3aBfA01H0kq4OxydHqoED0", - "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDmGS49FkSODAcKhn3+/47DW2zEn19BZvzRQ8RZjL3v6hCIX2qXfsFK35EGxNI0wV23H4xXC2gVRPHKU71YnCb50tad3yMBTM6+2yfGsEDasEH/anmBLclChKvuGiT547RskZlpbAbdq3GvbzmY+R/2EBRMOiObpc8XmSzKAd05j28kqN0+rZO65SWId0MXdvJdSCSAnuRqBNd/aXKlu8hBPDcgwbT2lMkuR+ApoBS2FLRBOiQyt2Ol0T7Uuf7lTLlazpGB3uTw5zFYUNXkuuI6cAP8QYuY1Bne/hNrG8t3Aw9a1yc2C4Fz1hJ/4OMRxTQ8SUQf+Rmxs8DryMlMFJ8r device132@example.com", - "uri": "https://api.ngrok.com/ssh_credentials/sshcr_2rcCv1qLfkFjQMNXEnB5UoK05yE" -} -``` diff --git a/docs/api/examples/_ssh_host_certificates_create_request.md b/docs/api/examples/_ssh_host_certificates_create_request.md deleted file mode 100644 index 20f948f911..0000000000 --- a/docs/api/examples/_ssh_host_certificates_create_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X POST \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"description":"personal server","principals":["inconshreveable.com","10.2.42.9"],"public_key":"ecdsa-sha2-nistp256 AAAAE2VjZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNTYAAABBBI3oSgxrOEJ+tIJ/n6VYtxQIFvynqlOHpfOAJ4x4OfmMYDkbf8dr6RAuUSf+ZC2HMCujta7EjZ9t+6v08Ue+Cgk= inconshreveable.com","ssh_certificate_authority_id":"sshca_2rcCv8OdthfcvpVSuz5aUHCtLFe","valid_until":"2025-04-14T10:06:43Z"}' \ -https://api.ngrok.com/ssh_host_certificates -``` diff --git a/docs/api/examples/_ssh_host_certificates_create_response.md b/docs/api/examples/_ssh_host_certificates_create_response.md deleted file mode 100644 index 1d6579001e..0000000000 --- a/docs/api/examples/_ssh_host_certificates_create_response.md +++ /dev/null @@ -1,19 +0,0 @@ - - -#### Example Response - -```json -{ - "certificate": "ecdsa-sha2-nistp256-cert-v01@openssh.com AAAAKGVjZHNhLXNoYTItbmlzdHAyNTYtY2VydC12MDFAb3BlbnNzaC5jb20AAAAgnUKQKH4Hmay5uUMi1D2MIxFiLx5HSfIBrmUII0QZenAAAAAIbmlzdHAyNTYAAABBBI3oSgxrOEJ+tIJ/n6VYtxQIFvynqlOHpfOAJ4x4OfmMYDkbf8dr6RAuUSf+ZC2HMCujta7EjZ9t+6v08Ue+CgkAAAAAAAAAAAAAAAIAAAAhc2hjcnRfMnJjQ3Y2UGZzTDZ5aEoxeGhtSkhlbXJ2OVlWAAAAJAAAABNpbmNvbnNocmV2ZWFibGUuY29tAAAACTEwLjIuNDIuOQAAAABnhjczAAAAAGf83jMAAAAAAAAAAAAAAAAAAAAzAAAAC3NzaC1lZDI1NTE5AAAAIGtSZGALgpBnzA1+cF3S5IQqBBFb07p1TEuXaRGNncHaAAAAUwAAAAtzc2gtZWQyNTUxOQAAAEDBxpxunKLSPKhaOLDK0pt4ibRUcaGE8EFpZAngmLQRRuRhdmq7QftchCdai+j/TB0fM8WtAH+FyTEG/0AyMK0D shcrt_2rcCv6PfsL6yhJ1xhmJHemrv9YV", - "created_at": "2025-01-14T10:06:43Z", - "description": "personal server", - "id": "shcrt_2rcCv6PfsL6yhJ1xhmJHemrv9YV", - "key_type": "ecdsa", - "principals": ["inconshreveable.com", "10.2.42.9"], - "public_key": "ecdsa-sha2-nistp256 AAAAE2VjZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNTYAAABBBI3oSgxrOEJ+tIJ/n6VYtxQIFvynqlOHpfOAJ4x4OfmMYDkbf8dr6RAuUSf+ZC2HMCujta7EjZ9t+6v08Ue+Cgk= inconshreveable.com", - "ssh_certificate_authority_id": "sshca_2rcCv8OdthfcvpVSuz5aUHCtLFe", - "uri": "https://api.ngrok.com/ssh_host_certificates/shcrt_2rcCv6PfsL6yhJ1xhmJHemrv9YV", - "valid_after": "2025-01-14T10:06:43Z", - "valid_until": "2025-04-14T10:06:43Z" -} -``` diff --git a/docs/api/examples/_ssh_host_certificates_delete_request.md b/docs/api/examples/_ssh_host_certificates_delete_request.md deleted file mode 100644 index 9d017d264f..0000000000 --- a/docs/api/examples/_ssh_host_certificates_delete_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X DELETE \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/ssh_host_certificates/shcrt_2rcCv6PfsL6yhJ1xhmJHemrv9YV -``` diff --git a/docs/api/examples/_ssh_host_certificates_delete_response.md b/docs/api/examples/_ssh_host_certificates_delete_response.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/api/examples/_ssh_host_certificates_get_request.md b/docs/api/examples/_ssh_host_certificates_get_request.md deleted file mode 100644 index c032714f53..0000000000 --- a/docs/api/examples/_ssh_host_certificates_get_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/ssh_host_certificates/shcrt_2rcCv6PfsL6yhJ1xhmJHemrv9YV -``` diff --git a/docs/api/examples/_ssh_host_certificates_get_response.md b/docs/api/examples/_ssh_host_certificates_get_response.md deleted file mode 100644 index 4b36f7a5c1..0000000000 --- a/docs/api/examples/_ssh_host_certificates_get_response.md +++ /dev/null @@ -1,20 +0,0 @@ - - -#### Example Response - -```json -{ - "certificate": "ecdsa-sha2-nistp256-cert-v01@openssh.com AAAAKGVjZHNhLXNoYTItbmlzdHAyNTYtY2VydC12MDFAb3BlbnNzaC5jb20AAAAgnUKQKH4Hmay5uUMi1D2MIxFiLx5HSfIBrmUII0QZenAAAAAIbmlzdHAyNTYAAABBBI3oSgxrOEJ+tIJ/n6VYtxQIFvynqlOHpfOAJ4x4OfmMYDkbf8dr6RAuUSf+ZC2HMCujta7EjZ9t+6v08Ue+CgkAAAAAAAAAAAAAAAIAAAAhc2hjcnRfMnJjQ3Y2UGZzTDZ5aEoxeGhtSkhlbXJ2OVlWAAAAJAAAABNpbmNvbnNocmV2ZWFibGUuY29tAAAACTEwLjIuNDIuOQAAAABnhjczAAAAAGf83jMAAAAAAAAAAAAAAAAAAAAzAAAAC3NzaC1lZDI1NTE5AAAAIGtSZGALgpBnzA1+cF3S5IQqBBFb07p1TEuXaRGNncHaAAAAUwAAAAtzc2gtZWQyNTUxOQAAAEDBxpxunKLSPKhaOLDK0pt4ibRUcaGE8EFpZAngmLQRRuRhdmq7QftchCdai+j/TB0fM8WtAH+FyTEG/0AyMK0D shcrt_2rcCv6PfsL6yhJ1xhmJHemrv9YV", - "created_at": "2025-01-14T10:06:43Z", - "description": "personal server", - "id": "shcrt_2rcCv6PfsL6yhJ1xhmJHemrv9YV", - "key_type": "ecdsa", - "metadata": "{\"region\": \"us-west-2\"}", - "principals": ["inconshreveable.com", "10.2.42.9"], - "public_key": "ecdsa-sha2-nistp256 AAAAE2VjZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNTYAAABBBI3oSgxrOEJ+tIJ/n6VYtxQIFvynqlOHpfOAJ4x4OfmMYDkbf8dr6RAuUSf+ZC2HMCujta7EjZ9t+6v08Ue+Cgk= inconshreveable.com", - "ssh_certificate_authority_id": "sshca_2rcCv8OdthfcvpVSuz5aUHCtLFe", - "uri": "https://api.ngrok.com/ssh_host_certificates/shcrt_2rcCv6PfsL6yhJ1xhmJHemrv9YV", - "valid_after": "2025-01-14T10:06:43Z", - "valid_until": "2025-04-14T10:06:43Z" -} -``` diff --git a/docs/api/examples/_ssh_host_certificates_list_request.md b/docs/api/examples/_ssh_host_certificates_list_request.md deleted file mode 100644 index 2910e844d5..0000000000 --- a/docs/api/examples/_ssh_host_certificates_list_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/ssh_host_certificates -``` diff --git a/docs/api/examples/_ssh_host_certificates_list_response.md b/docs/api/examples/_ssh_host_certificates_list_response.md deleted file mode 100644 index 887bc701da..0000000000 --- a/docs/api/examples/_ssh_host_certificates_list_response.md +++ /dev/null @@ -1,25 +0,0 @@ - - -#### Example Response - -```json -{ - "next_page_uri": null, - "ssh_host_certificates": [ - { - "certificate": "ecdsa-sha2-nistp256-cert-v01@openssh.com AAAAKGVjZHNhLXNoYTItbmlzdHAyNTYtY2VydC12MDFAb3BlbnNzaC5jb20AAAAgnUKQKH4Hmay5uUMi1D2MIxFiLx5HSfIBrmUII0QZenAAAAAIbmlzdHAyNTYAAABBBI3oSgxrOEJ+tIJ/n6VYtxQIFvynqlOHpfOAJ4x4OfmMYDkbf8dr6RAuUSf+ZC2HMCujta7EjZ9t+6v08Ue+CgkAAAAAAAAAAAAAAAIAAAAhc2hjcnRfMnJjQ3Y2UGZzTDZ5aEoxeGhtSkhlbXJ2OVlWAAAAJAAAABNpbmNvbnNocmV2ZWFibGUuY29tAAAACTEwLjIuNDIuOQAAAABnhjczAAAAAGf83jMAAAAAAAAAAAAAAAAAAAAzAAAAC3NzaC1lZDI1NTE5AAAAIGtSZGALgpBnzA1+cF3S5IQqBBFb07p1TEuXaRGNncHaAAAAUwAAAAtzc2gtZWQyNTUxOQAAAEDBxpxunKLSPKhaOLDK0pt4ibRUcaGE8EFpZAngmLQRRuRhdmq7QftchCdai+j/TB0fM8WtAH+FyTEG/0AyMK0D shcrt_2rcCv6PfsL6yhJ1xhmJHemrv9YV", - "created_at": "2025-01-14T10:06:43Z", - "description": "personal server", - "id": "shcrt_2rcCv6PfsL6yhJ1xhmJHemrv9YV", - "key_type": "ecdsa", - "principals": ["inconshreveable.com", "10.2.42.9"], - "public_key": "ecdsa-sha2-nistp256 AAAAE2VjZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNTYAAABBBI3oSgxrOEJ+tIJ/n6VYtxQIFvynqlOHpfOAJ4x4OfmMYDkbf8dr6RAuUSf+ZC2HMCujta7EjZ9t+6v08Ue+Cgk= inconshreveable.com", - "ssh_certificate_authority_id": "sshca_2rcCv8OdthfcvpVSuz5aUHCtLFe", - "uri": "https://api.ngrok.com/ssh_host_certificates/shcrt_2rcCv6PfsL6yhJ1xhmJHemrv9YV", - "valid_after": "2025-01-14T10:06:43Z", - "valid_until": "2025-04-14T10:06:43Z" - } - ], - "uri": "https://api.ngrok.com/ssh_host_certificates" -} -``` diff --git a/docs/api/examples/_ssh_host_certificates_update_request.md b/docs/api/examples/_ssh_host_certificates_update_request.md deleted file mode 100644 index 6c4169f988..0000000000 --- a/docs/api/examples/_ssh_host_certificates_update_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X PATCH \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"metadata":"{\"region\": \"us-west-2\"}"}' \ -https://api.ngrok.com/ssh_host_certificates/shcrt_2rcCv6PfsL6yhJ1xhmJHemrv9YV -``` diff --git a/docs/api/examples/_ssh_host_certificates_update_response.md b/docs/api/examples/_ssh_host_certificates_update_response.md deleted file mode 100644 index 4b36f7a5c1..0000000000 --- a/docs/api/examples/_ssh_host_certificates_update_response.md +++ /dev/null @@ -1,20 +0,0 @@ - - -#### Example Response - -```json -{ - "certificate": "ecdsa-sha2-nistp256-cert-v01@openssh.com AAAAKGVjZHNhLXNoYTItbmlzdHAyNTYtY2VydC12MDFAb3BlbnNzaC5jb20AAAAgnUKQKH4Hmay5uUMi1D2MIxFiLx5HSfIBrmUII0QZenAAAAAIbmlzdHAyNTYAAABBBI3oSgxrOEJ+tIJ/n6VYtxQIFvynqlOHpfOAJ4x4OfmMYDkbf8dr6RAuUSf+ZC2HMCujta7EjZ9t+6v08Ue+CgkAAAAAAAAAAAAAAAIAAAAhc2hjcnRfMnJjQ3Y2UGZzTDZ5aEoxeGhtSkhlbXJ2OVlWAAAAJAAAABNpbmNvbnNocmV2ZWFibGUuY29tAAAACTEwLjIuNDIuOQAAAABnhjczAAAAAGf83jMAAAAAAAAAAAAAAAAAAAAzAAAAC3NzaC1lZDI1NTE5AAAAIGtSZGALgpBnzA1+cF3S5IQqBBFb07p1TEuXaRGNncHaAAAAUwAAAAtzc2gtZWQyNTUxOQAAAEDBxpxunKLSPKhaOLDK0pt4ibRUcaGE8EFpZAngmLQRRuRhdmq7QftchCdai+j/TB0fM8WtAH+FyTEG/0AyMK0D shcrt_2rcCv6PfsL6yhJ1xhmJHemrv9YV", - "created_at": "2025-01-14T10:06:43Z", - "description": "personal server", - "id": "shcrt_2rcCv6PfsL6yhJ1xhmJHemrv9YV", - "key_type": "ecdsa", - "metadata": "{\"region\": \"us-west-2\"}", - "principals": ["inconshreveable.com", "10.2.42.9"], - "public_key": "ecdsa-sha2-nistp256 AAAAE2VjZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNTYAAABBBI3oSgxrOEJ+tIJ/n6VYtxQIFvynqlOHpfOAJ4x4OfmMYDkbf8dr6RAuUSf+ZC2HMCujta7EjZ9t+6v08Ue+Cgk= inconshreveable.com", - "ssh_certificate_authority_id": "sshca_2rcCv8OdthfcvpVSuz5aUHCtLFe", - "uri": "https://api.ngrok.com/ssh_host_certificates/shcrt_2rcCv6PfsL6yhJ1xhmJHemrv9YV", - "valid_after": "2025-01-14T10:06:43Z", - "valid_until": "2025-04-14T10:06:43Z" -} -``` diff --git a/docs/api/examples/_ssh_user_certificates_create_request.md b/docs/api/examples/_ssh_user_certificates_create_request.md deleted file mode 100644 index 0c1903a5a9..0000000000 --- a/docs/api/examples/_ssh_user_certificates_create_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X POST \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"description":"temporary access to staging machine","principals":["ec2-user","root"],"public_key":"ecdsa-sha2-nistp256 AAAAE2VjZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNTYAAABBBK58lFzmWlDimDtBz78wVT4oauA8PjY0CiXTCEIsBNC6UwOJvZ0jdSaYNhDaa7dRV84DfBb/gKzqlXC7cVMZjl0= alan@work-laptop","ssh_certificate_authority_id":"sshca_2rcCv9Bz8O3LFBB8LglGKfoWPbY","valid_until":"2025-04-14T10:06:43Z"}' \ -https://api.ngrok.com/ssh_user_certificates -``` diff --git a/docs/api/examples/_ssh_user_certificates_create_response.md b/docs/api/examples/_ssh_user_certificates_create_response.md deleted file mode 100644 index 402a5f749f..0000000000 --- a/docs/api/examples/_ssh_user_certificates_create_response.md +++ /dev/null @@ -1,24 +0,0 @@ - - -#### Example Response - -```json -{ - "certificate": "ecdsa-sha2-nistp256-cert-v01@openssh.com AAAAKGVjZHNhLXNoYTItbmlzdHAyNTYtY2VydC12MDFAb3BlbnNzaC5jb20AAAAgGwRh3CxiHhxWrKZhdIPsU6dc1h4G+V8LopJjkpfrnXMAAAAIbmlzdHAyNTYAAABBBK58lFzmWlDimDtBz78wVT4oauA8PjY0CiXTCEIsBNC6UwOJvZ0jdSaYNhDaa7dRV84DfBb/gKzqlXC7cVMZjl0AAAAAAAAAAAAAAAEAAAAhc3VjcnRfMnJjQ3Y2bTF1a2ZhQ05JS1dLUWxuVGprZGFHAAAAFAAAAAhlYzItdXNlcgAAAARyb290AAAAAGeGNzMAAAAAZ/zeMwAAAAAAAAAoAAAACnBlcm1pdC1wdHkAAAAAAAAADnBlcm1pdC11c2VyLXJjAAAAAAAAAAAAAAAzAAAAC3NzaC1lZDI1NTE5AAAAIAa4WzefUf1miCDfrFC6hFoJHSBf1c+8LRQ8SbFm480NAAAAUwAAAAtzc2gtZWQyNTUxOQAAAEBRGun6IXKCvjGWj8XxTyG4/tYGKyNYvEk2ZuoLTPid1awRIuNQd+XHP6VUEzfL+XrsXCztIsd5FJm2QeXWSYcG sucrt_2rcCv6m1ukfaCNIKWKQlnTjkdaG", - "created_at": "2025-01-14T10:06:43Z", - "critical_options": {}, - "description": "temporary access to staging machine", - "extensions": { - "permit-pty": "", - "permit-user-rc": "" - }, - "id": "sucrt_2rcCv6m1ukfaCNIKWKQlnTjkdaG", - "key_type": "ecdsa", - "principals": ["ec2-user", "root"], - "public_key": "ecdsa-sha2-nistp256 AAAAE2VjZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNTYAAABBBK58lFzmWlDimDtBz78wVT4oauA8PjY0CiXTCEIsBNC6UwOJvZ0jdSaYNhDaa7dRV84DfBb/gKzqlXC7cVMZjl0= alan@work-laptop", - "ssh_certificate_authority_id": "sshca_2rcCv9Bz8O3LFBB8LglGKfoWPbY", - "uri": "https://api.ngrok.com/ssh_user_certificates/sucrt_2rcCv6m1ukfaCNIKWKQlnTjkdaG", - "valid_after": "2025-01-14T10:06:43Z", - "valid_until": "2025-04-14T10:06:43Z" -} -``` diff --git a/docs/api/examples/_ssh_user_certificates_delete_request.md b/docs/api/examples/_ssh_user_certificates_delete_request.md deleted file mode 100644 index 21f5f9e2fc..0000000000 --- a/docs/api/examples/_ssh_user_certificates_delete_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X DELETE \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/ssh_user_certificates/sucrt_2rcCv6m1ukfaCNIKWKQlnTjkdaG -``` diff --git a/docs/api/examples/_ssh_user_certificates_delete_response.md b/docs/api/examples/_ssh_user_certificates_delete_response.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/api/examples/_ssh_user_certificates_get_request.md b/docs/api/examples/_ssh_user_certificates_get_request.md deleted file mode 100644 index a2a72f5b23..0000000000 --- a/docs/api/examples/_ssh_user_certificates_get_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/ssh_user_certificates/sucrt_2rcCv6m1ukfaCNIKWKQlnTjkdaG -``` diff --git a/docs/api/examples/_ssh_user_certificates_get_response.md b/docs/api/examples/_ssh_user_certificates_get_response.md deleted file mode 100644 index f1594ece5d..0000000000 --- a/docs/api/examples/_ssh_user_certificates_get_response.md +++ /dev/null @@ -1,25 +0,0 @@ - - -#### Example Response - -```json -{ - "certificate": "ecdsa-sha2-nistp256-cert-v01@openssh.com AAAAKGVjZHNhLXNoYTItbmlzdHAyNTYtY2VydC12MDFAb3BlbnNzaC5jb20AAAAgGwRh3CxiHhxWrKZhdIPsU6dc1h4G+V8LopJjkpfrnXMAAAAIbmlzdHAyNTYAAABBBK58lFzmWlDimDtBz78wVT4oauA8PjY0CiXTCEIsBNC6UwOJvZ0jdSaYNhDaa7dRV84DfBb/gKzqlXC7cVMZjl0AAAAAAAAAAAAAAAEAAAAhc3VjcnRfMnJjQ3Y2bTF1a2ZhQ05JS1dLUWxuVGprZGFHAAAAFAAAAAhlYzItdXNlcgAAAARyb290AAAAAGeGNzMAAAAAZ/zeMwAAAAAAAAAoAAAACnBlcm1pdC1wdHkAAAAAAAAADnBlcm1pdC11c2VyLXJjAAAAAAAAAAAAAAAzAAAAC3NzaC1lZDI1NTE5AAAAIAa4WzefUf1miCDfrFC6hFoJHSBf1c+8LRQ8SbFm480NAAAAUwAAAAtzc2gtZWQyNTUxOQAAAEBRGun6IXKCvjGWj8XxTyG4/tYGKyNYvEk2ZuoLTPid1awRIuNQd+XHP6VUEzfL+XrsXCztIsd5FJm2QeXWSYcG sucrt_2rcCv6m1ukfaCNIKWKQlnTjkdaG", - "created_at": "2025-01-14T10:06:43Z", - "critical_options": {}, - "description": "temporary access to staging machine for alan", - "extensions": { - "permit-pty": "", - "permit-user-rc": "" - }, - "id": "sucrt_2rcCv6m1ukfaCNIKWKQlnTjkdaG", - "key_type": "ecdsa", - "metadata": "{\"user_email\": \"alan@example.com\"}", - "principals": ["ec2-user", "root"], - "public_key": "ecdsa-sha2-nistp256 AAAAE2VjZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNTYAAABBBK58lFzmWlDimDtBz78wVT4oauA8PjY0CiXTCEIsBNC6UwOJvZ0jdSaYNhDaa7dRV84DfBb/gKzqlXC7cVMZjl0= alan@work-laptop", - "ssh_certificate_authority_id": "sshca_2rcCv9Bz8O3LFBB8LglGKfoWPbY", - "uri": "https://api.ngrok.com/ssh_user_certificates/sucrt_2rcCv6m1ukfaCNIKWKQlnTjkdaG", - "valid_after": "2025-01-14T10:06:43Z", - "valid_until": "2025-04-14T10:06:43Z" -} -``` diff --git a/docs/api/examples/_ssh_user_certificates_list_request.md b/docs/api/examples/_ssh_user_certificates_list_request.md deleted file mode 100644 index 51d22b22ab..0000000000 --- a/docs/api/examples/_ssh_user_certificates_list_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/ssh_user_certificates -``` diff --git a/docs/api/examples/_ssh_user_certificates_list_response.md b/docs/api/examples/_ssh_user_certificates_list_response.md deleted file mode 100644 index 6fff209023..0000000000 --- a/docs/api/examples/_ssh_user_certificates_list_response.md +++ /dev/null @@ -1,30 +0,0 @@ - - -#### Example Response - -```json -{ - "next_page_uri": null, - "ssh_user_certificates": [ - { - "certificate": "ecdsa-sha2-nistp256-cert-v01@openssh.com AAAAKGVjZHNhLXNoYTItbmlzdHAyNTYtY2VydC12MDFAb3BlbnNzaC5jb20AAAAgGwRh3CxiHhxWrKZhdIPsU6dc1h4G+V8LopJjkpfrnXMAAAAIbmlzdHAyNTYAAABBBK58lFzmWlDimDtBz78wVT4oauA8PjY0CiXTCEIsBNC6UwOJvZ0jdSaYNhDaa7dRV84DfBb/gKzqlXC7cVMZjl0AAAAAAAAAAAAAAAEAAAAhc3VjcnRfMnJjQ3Y2bTF1a2ZhQ05JS1dLUWxuVGprZGFHAAAAFAAAAAhlYzItdXNlcgAAAARyb290AAAAAGeGNzMAAAAAZ/zeMwAAAAAAAAAoAAAACnBlcm1pdC1wdHkAAAAAAAAADnBlcm1pdC11c2VyLXJjAAAAAAAAAAAAAAAzAAAAC3NzaC1lZDI1NTE5AAAAIAa4WzefUf1miCDfrFC6hFoJHSBf1c+8LRQ8SbFm480NAAAAUwAAAAtzc2gtZWQyNTUxOQAAAEBRGun6IXKCvjGWj8XxTyG4/tYGKyNYvEk2ZuoLTPid1awRIuNQd+XHP6VUEzfL+XrsXCztIsd5FJm2QeXWSYcG sucrt_2rcCv6m1ukfaCNIKWKQlnTjkdaG", - "created_at": "2025-01-14T10:06:43Z", - "critical_options": {}, - "description": "temporary access to staging machine", - "extensions": { - "permit-pty": "", - "permit-user-rc": "" - }, - "id": "sucrt_2rcCv6m1ukfaCNIKWKQlnTjkdaG", - "key_type": "ecdsa", - "principals": ["ec2-user", "root"], - "public_key": "ecdsa-sha2-nistp256 AAAAE2VjZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNTYAAABBBK58lFzmWlDimDtBz78wVT4oauA8PjY0CiXTCEIsBNC6UwOJvZ0jdSaYNhDaa7dRV84DfBb/gKzqlXC7cVMZjl0= alan@work-laptop", - "ssh_certificate_authority_id": "sshca_2rcCv9Bz8O3LFBB8LglGKfoWPbY", - "uri": "https://api.ngrok.com/ssh_user_certificates/sucrt_2rcCv6m1ukfaCNIKWKQlnTjkdaG", - "valid_after": "2025-01-14T10:06:43Z", - "valid_until": "2025-04-14T10:06:43Z" - } - ], - "uri": "https://api.ngrok.com/ssh_user_certificates" -} -``` diff --git a/docs/api/examples/_ssh_user_certificates_update_request.md b/docs/api/examples/_ssh_user_certificates_update_request.md deleted file mode 100644 index 593c03b7a0..0000000000 --- a/docs/api/examples/_ssh_user_certificates_update_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X PATCH \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"description":"temporary access to staging machine for alan","metadata":"{\"user_email\": \"alan@example.com\"}"}' \ -https://api.ngrok.com/ssh_user_certificates/sucrt_2rcCv6m1ukfaCNIKWKQlnTjkdaG -``` diff --git a/docs/api/examples/_ssh_user_certificates_update_response.md b/docs/api/examples/_ssh_user_certificates_update_response.md deleted file mode 100644 index f1594ece5d..0000000000 --- a/docs/api/examples/_ssh_user_certificates_update_response.md +++ /dev/null @@ -1,25 +0,0 @@ - - -#### Example Response - -```json -{ - "certificate": "ecdsa-sha2-nistp256-cert-v01@openssh.com AAAAKGVjZHNhLXNoYTItbmlzdHAyNTYtY2VydC12MDFAb3BlbnNzaC5jb20AAAAgGwRh3CxiHhxWrKZhdIPsU6dc1h4G+V8LopJjkpfrnXMAAAAIbmlzdHAyNTYAAABBBK58lFzmWlDimDtBz78wVT4oauA8PjY0CiXTCEIsBNC6UwOJvZ0jdSaYNhDaa7dRV84DfBb/gKzqlXC7cVMZjl0AAAAAAAAAAAAAAAEAAAAhc3VjcnRfMnJjQ3Y2bTF1a2ZhQ05JS1dLUWxuVGprZGFHAAAAFAAAAAhlYzItdXNlcgAAAARyb290AAAAAGeGNzMAAAAAZ/zeMwAAAAAAAAAoAAAACnBlcm1pdC1wdHkAAAAAAAAADnBlcm1pdC11c2VyLXJjAAAAAAAAAAAAAAAzAAAAC3NzaC1lZDI1NTE5AAAAIAa4WzefUf1miCDfrFC6hFoJHSBf1c+8LRQ8SbFm480NAAAAUwAAAAtzc2gtZWQyNTUxOQAAAEBRGun6IXKCvjGWj8XxTyG4/tYGKyNYvEk2ZuoLTPid1awRIuNQd+XHP6VUEzfL+XrsXCztIsd5FJm2QeXWSYcG sucrt_2rcCv6m1ukfaCNIKWKQlnTjkdaG", - "created_at": "2025-01-14T10:06:43Z", - "critical_options": {}, - "description": "temporary access to staging machine for alan", - "extensions": { - "permit-pty": "", - "permit-user-rc": "" - }, - "id": "sucrt_2rcCv6m1ukfaCNIKWKQlnTjkdaG", - "key_type": "ecdsa", - "metadata": "{\"user_email\": \"alan@example.com\"}", - "principals": ["ec2-user", "root"], - "public_key": "ecdsa-sha2-nistp256 AAAAE2VjZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNTYAAABBBK58lFzmWlDimDtBz78wVT4oauA8PjY0CiXTCEIsBNC6UwOJvZ0jdSaYNhDaa7dRV84DfBb/gKzqlXC7cVMZjl0= alan@work-laptop", - "ssh_certificate_authority_id": "sshca_2rcCv9Bz8O3LFBB8LglGKfoWPbY", - "uri": "https://api.ngrok.com/ssh_user_certificates/sucrt_2rcCv6m1ukfaCNIKWKQlnTjkdaG", - "valid_after": "2025-01-14T10:06:43Z", - "valid_until": "2025-04-14T10:06:43Z" -} -``` diff --git a/docs/api/examples/_static_backends_create_request.md b/docs/api/examples/_static_backends_create_request.md deleted file mode 100644 index 136c4425c9..0000000000 --- a/docs/api/examples/_static_backends_create_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X POST \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"address":"example.com:8080","description":"acme weighted","metadata":"{\"environment\": \"staging\"}","tls":{}}' \ -https://api.ngrok.com/backends/static -``` diff --git a/docs/api/examples/_static_backends_create_response.md b/docs/api/examples/_static_backends_create_response.md deleted file mode 100644 index c84f5d2053..0000000000 --- a/docs/api/examples/_static_backends_create_response.md +++ /dev/null @@ -1,17 +0,0 @@ - - -#### Example Response - -```json -{ - "address": "example.com:8080", - "created_at": "2025-01-14T10:06:43Z", - "description": "acme weighted", - "id": "bkdsc_2rcCv8WuQnFLmgfqH6RjRPXqTSE", - "metadata": "{\"environment\": \"staging\"}", - "tls": { - "enabled": false - }, - "uri": "https://api.ngrok.com/backends/static/bkdsc_2rcCv8WuQnFLmgfqH6RjRPXqTSE" -} -``` diff --git a/docs/api/examples/_static_backends_delete_request.md b/docs/api/examples/_static_backends_delete_request.md deleted file mode 100644 index cfda8ce4f8..0000000000 --- a/docs/api/examples/_static_backends_delete_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X DELETE \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/backends/static/bkdsc_2rcCv9gLEIj0nLxTanLVju9cKHV -``` diff --git a/docs/api/examples/_static_backends_delete_response.md b/docs/api/examples/_static_backends_delete_response.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/api/examples/_static_backends_get_request.md b/docs/api/examples/_static_backends_get_request.md deleted file mode 100644 index 136c4425c9..0000000000 --- a/docs/api/examples/_static_backends_get_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X POST \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"address":"example.com:8080","description":"acme weighted","metadata":"{\"environment\": \"staging\"}","tls":{}}' \ -https://api.ngrok.com/backends/static -``` diff --git a/docs/api/examples/_static_backends_get_response.md b/docs/api/examples/_static_backends_get_response.md deleted file mode 100644 index c900c6f60e..0000000000 --- a/docs/api/examples/_static_backends_get_response.md +++ /dev/null @@ -1,17 +0,0 @@ - - -#### Example Response - -```json -{ - "address": "example.com:8080", - "created_at": "2025-01-14T10:06:43Z", - "description": "acme weighted", - "id": "bkdsc_2rcCv4iTNYACNFdTqaCZBb9ak5E", - "metadata": "{\"environment\": \"staging\"}", - "tls": { - "enabled": false - }, - "uri": "https://api.ngrok.com/backends/static/bkdsc_2rcCv4iTNYACNFdTqaCZBb9ak5E" -} -``` diff --git a/docs/api/examples/_static_backends_list_request.md b/docs/api/examples/_static_backends_list_request.md deleted file mode 100644 index e82d144a34..0000000000 --- a/docs/api/examples/_static_backends_list_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/backends/static -``` diff --git a/docs/api/examples/_static_backends_list_response.md b/docs/api/examples/_static_backends_list_response.md deleted file mode 100644 index c1829ca4e1..0000000000 --- a/docs/api/examples/_static_backends_list_response.md +++ /dev/null @@ -1,45 +0,0 @@ - - -#### Example Response - -```json -{ - "backends": [ - { - "address": "example.com:8080", - "created_at": "2025-01-14T10:06:43Z", - "description": "acme weighted", - "id": "bkdsc_2rcCv9gLEIj0nLxTanLVju9cKHV", - "metadata": "{\"environment\": \"staging\"}", - "tls": { - "enabled": false - }, - "uri": "https://api.ngrok.com/backends/static/bkdsc_2rcCv9gLEIj0nLxTanLVju9cKHV" - }, - { - "address": "example.com:8080", - "created_at": "2025-01-14T10:06:43Z", - "description": "acme weighted", - "id": "bkdsc_2rcCv8WuQnFLmgfqH6RjRPXqTSE", - "metadata": "{\"environment\": \"staging\"}", - "tls": { - "enabled": false - }, - "uri": "https://api.ngrok.com/backends/static/bkdsc_2rcCv8WuQnFLmgfqH6RjRPXqTSE" - }, - { - "address": "example.com:8080", - "created_at": "2025-01-14T10:06:43Z", - "description": "acme weighted", - "id": "bkdsc_2rcCv4iTNYACNFdTqaCZBb9ak5E", - "metadata": "{\"environment\": \"staging\"}", - "tls": { - "enabled": false - }, - "uri": "https://api.ngrok.com/backends/static/bkdsc_2rcCv4iTNYACNFdTqaCZBb9ak5E" - } - ], - "next_page_uri": null, - "uri": "https://api.ngrok.com/backends/static" -} -``` diff --git a/docs/api/examples/_static_backends_update_request.md b/docs/api/examples/_static_backends_update_request.md deleted file mode 100644 index 7a3b88ead3..0000000000 --- a/docs/api/examples/_static_backends_update_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X PATCH \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"address":"example.com:8080","metadata":"{\"environment\": \"production\"}","tls":{}}' \ -https://api.ngrok.com/backends/static/bkdsc_2rcCv9gLEIj0nLxTanLVju9cKHV -``` diff --git a/docs/api/examples/_static_backends_update_response.md b/docs/api/examples/_static_backends_update_response.md deleted file mode 100644 index 31b6d716ec..0000000000 --- a/docs/api/examples/_static_backends_update_response.md +++ /dev/null @@ -1,17 +0,0 @@ - - -#### Example Response - -```json -{ - "address": "example.com:8080", - "created_at": "2025-01-14T10:06:43Z", - "description": "acme weighted", - "id": "bkdsc_2rcCv9gLEIj0nLxTanLVju9cKHV", - "metadata": "{\"environment\": \"production\"}", - "tls": { - "enabled": false - }, - "uri": "https://api.ngrok.com/backends/static/bkdsc_2rcCv9gLEIj0nLxTanLVju9cKHV" -} -``` diff --git a/docs/api/examples/_tcp_edge_backend_module_delete_request.md b/docs/api/examples/_tcp_edge_backend_module_delete_request.md deleted file mode 100644 index 8041bc1954..0000000000 --- a/docs/api/examples/_tcp_edge_backend_module_delete_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X DELETE \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/edges/tcp/edgtcp_2rcCveEM4s7CGK22Jf6n0LyETDH/backend -``` diff --git a/docs/api/examples/_tcp_edge_backend_module_delete_response.md b/docs/api/examples/_tcp_edge_backend_module_delete_response.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/api/examples/_tcp_edge_backend_module_get_request.md b/docs/api/examples/_tcp_edge_backend_module_get_request.md deleted file mode 100644 index 0409af755f..0000000000 --- a/docs/api/examples/_tcp_edge_backend_module_get_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/edges/tcp/edgtcp_2rcCveEM4s7CGK22Jf6n0LyETDH/backend -``` diff --git a/docs/api/examples/_tcp_edge_backend_module_get_response.md b/docs/api/examples/_tcp_edge_backend_module_get_response.md deleted file mode 100644 index 8572ae271c..0000000000 --- a/docs/api/examples/_tcp_edge_backend_module_get_response.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Response - -```json -{ - "backend": { - "id": "bkdtg_2rcCvefULUOtwbzrP4WoyQa6xsb", - "uri": "https://api.ngrok.com/backends/tunnel_group/bkdtg_2rcCvefULUOtwbzrP4WoyQa6xsb" - }, - "enabled": true -} -``` diff --git a/docs/api/examples/_tcp_edge_backend_module_replace_request.md b/docs/api/examples/_tcp_edge_backend_module_replace_request.md deleted file mode 100644 index 799d13a031..0000000000 --- a/docs/api/examples/_tcp_edge_backend_module_replace_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X PUT \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"backend_id":"bkdtg_2rcCvefULUOtwbzrP4WoyQa6xsb","enabled":true}' \ -https://api.ngrok.com/edges/tcp/edgtcp_2rcCveEM4s7CGK22Jf6n0LyETDH/backend -``` diff --git a/docs/api/examples/_tcp_edge_backend_module_replace_response.md b/docs/api/examples/_tcp_edge_backend_module_replace_response.md deleted file mode 100644 index 8572ae271c..0000000000 --- a/docs/api/examples/_tcp_edge_backend_module_replace_response.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Response - -```json -{ - "backend": { - "id": "bkdtg_2rcCvefULUOtwbzrP4WoyQa6xsb", - "uri": "https://api.ngrok.com/backends/tunnel_group/bkdtg_2rcCvefULUOtwbzrP4WoyQa6xsb" - }, - "enabled": true -} -``` diff --git a/docs/api/examples/_tcp_edge_ip_restriction_module_delete_request.md b/docs/api/examples/_tcp_edge_ip_restriction_module_delete_request.md deleted file mode 100644 index 843171e693..0000000000 --- a/docs/api/examples/_tcp_edge_ip_restriction_module_delete_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X DELETE \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/edges/tcp/edgtcp_2rcCvfnnQoOaG0t7ziLUTHJkUqh/ip_restriction -``` diff --git a/docs/api/examples/_tcp_edge_ip_restriction_module_delete_response.md b/docs/api/examples/_tcp_edge_ip_restriction_module_delete_response.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/api/examples/_tcp_edge_ip_restriction_module_get_request.md b/docs/api/examples/_tcp_edge_ip_restriction_module_get_request.md deleted file mode 100644 index c9b3555dff..0000000000 --- a/docs/api/examples/_tcp_edge_ip_restriction_module_get_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/edges/tcp/edgtcp_2rcCvfnnQoOaG0t7ziLUTHJkUqh/ip_restriction -``` diff --git a/docs/api/examples/_tcp_edge_ip_restriction_module_get_response.md b/docs/api/examples/_tcp_edge_ip_restriction_module_get_response.md deleted file mode 100644 index 5c30d68ef9..0000000000 --- a/docs/api/examples/_tcp_edge_ip_restriction_module_get_response.md +++ /dev/null @@ -1,15 +0,0 @@ - - -#### Example Response - -```json -{ - "enabled": true, - "ip_policies": [ - { - "id": "ipp_2rcCvbxeuRAOYeSI8nkswuVJqfn", - "uri": "https://api.ngrok.com/ip_policies/ipp_2rcCvbxeuRAOYeSI8nkswuVJqfn" - } - ] -} -``` diff --git a/docs/api/examples/_tcp_edge_ip_restriction_module_replace_request.md b/docs/api/examples/_tcp_edge_ip_restriction_module_replace_request.md deleted file mode 100644 index d08592c567..0000000000 --- a/docs/api/examples/_tcp_edge_ip_restriction_module_replace_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X PUT \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"enabled":true,"ip_policy_ids":["ipp_2rcCvbxeuRAOYeSI8nkswuVJqfn"]}' \ -https://api.ngrok.com/edges/tcp/edgtcp_2rcCvfnnQoOaG0t7ziLUTHJkUqh/ip_restriction -``` diff --git a/docs/api/examples/_tcp_edge_ip_restriction_module_replace_response.md b/docs/api/examples/_tcp_edge_ip_restriction_module_replace_response.md deleted file mode 100644 index 5c30d68ef9..0000000000 --- a/docs/api/examples/_tcp_edge_ip_restriction_module_replace_response.md +++ /dev/null @@ -1,15 +0,0 @@ - - -#### Example Response - -```json -{ - "enabled": true, - "ip_policies": [ - { - "id": "ipp_2rcCvbxeuRAOYeSI8nkswuVJqfn", - "uri": "https://api.ngrok.com/ip_policies/ipp_2rcCvbxeuRAOYeSI8nkswuVJqfn" - } - ] -} -``` diff --git a/docs/api/examples/_tcp_edge_traffic_policy_module_delete_request.md b/docs/api/examples/_tcp_edge_traffic_policy_module_delete_request.md deleted file mode 100644 index 760aff53cc..0000000000 --- a/docs/api/examples/_tcp_edge_traffic_policy_module_delete_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X DELETE \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/edges/tcp/edgtcp_2rcCvct4Rfd5av6lsv8xNVrqohO/traffic_policy -``` diff --git a/docs/api/examples/_tcp_edge_traffic_policy_module_delete_response.md b/docs/api/examples/_tcp_edge_traffic_policy_module_delete_response.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/api/examples/_tcp_edge_traffic_policy_module_get_request.md b/docs/api/examples/_tcp_edge_traffic_policy_module_get_request.md deleted file mode 100644 index 8f7a480ba8..0000000000 --- a/docs/api/examples/_tcp_edge_traffic_policy_module_get_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/edges/tcp/edgtcp_2rcCvct4Rfd5av6lsv8xNVrqohO/traffic_policy -``` diff --git a/docs/api/examples/_tcp_edge_traffic_policy_module_get_response.md b/docs/api/examples/_tcp_edge_traffic_policy_module_get_response.md deleted file mode 100644 index 931f745858..0000000000 --- a/docs/api/examples/_tcp_edge_traffic_policy_module_get_response.md +++ /dev/null @@ -1,10 +0,0 @@ - - -#### Example Response - -```json -{ - "enabled": true, - "value": "{\"on_tcp_connect\":[{\"name\":\"Block IP\",\"expressions\":[\"conn.client_ip == '192.0.2.0'\"],\"actions\":[{\"type\":\"deny\"}]}]}" -} -``` diff --git a/docs/api/examples/_tcp_edge_traffic_policy_module_replace_request.md b/docs/api/examples/_tcp_edge_traffic_policy_module_replace_request.md deleted file mode 100644 index b6cce3a307..0000000000 --- a/docs/api/examples/_tcp_edge_traffic_policy_module_replace_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X PUT \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"enabled":true,"value":"{\"on_tcp_connect\":[{\"name\":\"Block IP\",\"expressions\":[\"conn.client_ip == '192.0.2.0'\"],\"actions\":[{\"type\":\"deny\"}]}]}"}' \ -https://api.ngrok.com/edges/tcp/edgtcp_2rcCvct4Rfd5av6lsv8xNVrqohO/traffic_policy -``` diff --git a/docs/api/examples/_tcp_edge_traffic_policy_module_replace_response.md b/docs/api/examples/_tcp_edge_traffic_policy_module_replace_response.md deleted file mode 100644 index 931f745858..0000000000 --- a/docs/api/examples/_tcp_edge_traffic_policy_module_replace_response.md +++ /dev/null @@ -1,10 +0,0 @@ - - -#### Example Response - -```json -{ - "enabled": true, - "value": "{\"on_tcp_connect\":[{\"name\":\"Block IP\",\"expressions\":[\"conn.client_ip == '192.0.2.0'\"],\"actions\":[{\"type\":\"deny\"}]}]}" -} -``` diff --git a/docs/api/examples/_tls_certificates_create_request.md b/docs/api/examples/_tls_certificates_create_request.md deleted file mode 100644 index 053485bf2d..0000000000 --- a/docs/api/examples/_tls_certificates_create_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X POST \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"certificate_pem":"-----BEGIN CERTIFICATE-----\nMIIDDTCCAfWgAwIBAgIUBUunDdA4gjgtEbZA8w9Ljhvl3bEwDQYJKoZIhvcNAQEL\nBQAwFjEUMBIGA1UEAwwLZXhhbXBsZS5jb20wHhcNMjAwMzI0MTgxODE5WhcNMjAw\nNDIzMTgxODE5WjAWMRQwEgYDVQQDDAtleGFtcGxlLmNvbTCCASIwDQYJKoZIhvcN\nAQEBBQADggEPADCCAQoCggEBAPKVkkKYNl3d9cqrz4tIFlwsohED5W4y1dcBixy4\nGANFFnw43nc2wPyKwYXumJqJIFrcW/NkUZL07bd+dou6mT6Gh/zbaTW91IkREPXL\n7b3KfVu4XkFosVXpWs0U6o4GrZ81CLiKBWI+H03x/ij5OSiJ1l71pqLeTJLOydAR\nAl8kpp7axeHU4UbDrAZkW5SnuZTjIKwVg0UNsBg1yNfUOu1Uah3BYaqPgQitC0Yg\nLW+NUGu/T91bkD7tLsVInkQXeQGdXBAqOycfJ7wj8OlIpyuXjTnGFA0izVmbQw5f\nrQnZ0geGyhLamvz9Gcd7mIlD/+/AEN9Lht82tAOzKG98/O8CAwEAAaNTMFEwHQYD\nVR0OBBYEFKv6RsvEC6T+zCtJZwB0FCR1sEkhMB8GA1UdIwQYMBaAFKv6RsvEC6T+\nzCtJZwB0FCR1sEkhMA8GA1UdEwEB/wQFMAMBAf8wDQYJKoZIhvcNAQELBQADggEB\nAC5fBrouinespo5+9AipjhY/HOKTg+OCnppFnSnqeU1eXZZJ0oakdHTpTNxtbQP9\ntOJTA2f3KWvmpNDMohEQXZz8wHDkdbrIXJKVp6zs1pEp+0BIjA4y9mSywa5xuyk0\noGeChRgGqp2JujDyPCb7LEaKKQEEdMqy73QG+jEAh14+wKixlAf1nATBdeCUvssK\n2x1uZMyqjJFB5y/5EdnWQzD4WJkrsCkxsZHVMN1d+dqf2sf3dTRV8fzsFGOG17NS\n6u2n9iGcFdBA82XN8yeLIWhy1t3GWutG1sdxENbFRRXea+iUqzDsmRtkaBma2GLQ\nd6JTpFbsCtwDjP23UEi7SZo=\n-----END CERTIFICATE-----","private_key_pem":"-----BEGIN PRIVATE KEY-----\nMIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDylZJCmDZd3fXK\nq8+LSBZcLKIRA+VuMtXXAYscuBgDRRZ8ON53NsD8isGF7piaiSBa3FvzZFGS9O23\nfnaLupk+hof822k1vdSJERD1y+29yn1buF5BaLFV6VrNFOqOBq2fNQi4igViPh9N\n8f4o+TkoidZe9aai3kySzsnQEQJfJKae2sXh1OFGw6wGZFuUp7mU4yCsFYNFDbAY\nNcjX1DrtVGodwWGqj4EIrQtGIC1vjVBrv0/dW5A+7S7FSJ5EF3kBnVwQKjsnHye8\nI/DpSKcrl405xhQNIs1Zm0MOX60J2dIHhsoS2pr8/RnHe5iJQ//vwBDfS4bfNrQD\nsyhvfPzvAgMBAAECggEBALLv7YE98exvi5zB+0fMFuJK8gkHDLequ93q/4hhqyTO\nU3WyJTdepiAi4fk/NEXZnIopPZJdj2aNUMQnfp43OE7MwYac+hBwRFQOyKnmkSmM\nMcf0SWKKLTUn+piIMzQsbOmhHxuwg6QiGslOFaJ3o9fpRL2rCg3dWDJ6Ypcd1NgE\nK0uy7gg+DwIpU6MeG6lA+HbxbGi+yd2x88Gjn9dGr7FZK34RUDooH60BCX9P8N9X\nT+n10MzzX7ZQOsLfe8FKc1/X8AybI5SYm1GMyfKD4QBt6JG4HKAjPHzBzcIpfN3d\n7BM11Imkrz7LcbUG+F23NVsi6n5IIGT1WqwCRIH2PpECgYEA/SJ5Ra4d0hUS5RYB\nzABquM3sp7JsKxCn7O5PqNLB4TgH9dXtWFhaFVB6juMGyHbvktVH0j4lps/Te0rk\nVU2zU1XxvCTFhtcCYUtNk0cRw6LH8feKiorXHdDRB33t0c47QSD/6AGOjBtxqD7B\n3ZxyR3P+7RdQopLLRFN+FHAnmzsCgYEA9VSGZDFSK+fbg4CgwkWdzuHrAXaUEv0U\novqqWd/yXB9wauEvRHnOrSgW6hFZQiatJOXx0KnalJQzohz/SLGO0MqGtwQbYWVT\nWiJgjUbNeiPEHBeUA6U55lVQr26kQSUWdXEtRbDz+hqV1K+6tTEMzaSPmJiHNgki\nlNMO2gqGQd0CgYBJ268qx5zn2UJEGWG41j5NYbg1TfgFsLxugzI2/heX0TNxZVP1\nPQI7ydmYq2ElSJ6qZxSnoX5255i7FqT8xskV/bOkw83mhAGrxb8Cw+/I90wDq8h+\nl/ggOPdkijfDybq8TBae6SVgd/l3r6f9M1KcypmNMApVBSPN8daNvBOyVQKBgQDo\nsj2utyFrx8Xsm4rf+kxOuPbBMooM4MQ8OmpuSP6G5sMofWLqHmcs0sO5TK9PEYRV\nZU3ST+ml2FSJRdvWRaRi4laZLWoTHZrL+aN/HVM0sMwIoUyhkIy0ruOTIuzlZZpB\n1xHL8qXX6nOHgw8jYdz1CUuyv6owVMXaR77kjer+eQKBgByYZlR/eNTzlot0SdFl\nIbgQ9bV7VLIo+vKzOXE3trfzRJMgUosLTp+5wdSVSW/VBdYZ7Ir3n0bbpY/dGinI\nVShxPbChhCZnhvG2lEEiekI44m5jHSA6hhtRdt/CrhL65Rw2SE5lMEe8htg1UGus\nwzLHWHBl72FjbjdhvEgrq60W\n-----END PRIVATE KEY-----"}' \ -https://api.ngrok.com/tls_certificates -``` diff --git a/docs/api/examples/_tls_certificates_create_response.md b/docs/api/examples/_tls_certificates_create_response.md deleted file mode 100644 index 14bd8f587f..0000000000 --- a/docs/api/examples/_tls_certificates_create_response.md +++ /dev/null @@ -1,30 +0,0 @@ - - -#### Example Response - -```json -{ - "certificate_pem": "-----BEGIN CERTIFICATE-----\nMIIDDTCCAfWgAwIBAgIUBUunDdA4gjgtEbZA8w9Ljhvl3bEwDQYJKoZIhvcNAQEL\nBQAwFjEUMBIGA1UEAwwLZXhhbXBsZS5jb20wHhcNMjAwMzI0MTgxODE5WhcNMjAw\nNDIzMTgxODE5WjAWMRQwEgYDVQQDDAtleGFtcGxlLmNvbTCCASIwDQYJKoZIhvcN\nAQEBBQADggEPADCCAQoCggEBAPKVkkKYNl3d9cqrz4tIFlwsohED5W4y1dcBixy4\nGANFFnw43nc2wPyKwYXumJqJIFrcW/NkUZL07bd+dou6mT6Gh/zbaTW91IkREPXL\n7b3KfVu4XkFosVXpWs0U6o4GrZ81CLiKBWI+H03x/ij5OSiJ1l71pqLeTJLOydAR\nAl8kpp7axeHU4UbDrAZkW5SnuZTjIKwVg0UNsBg1yNfUOu1Uah3BYaqPgQitC0Yg\nLW+NUGu/T91bkD7tLsVInkQXeQGdXBAqOycfJ7wj8OlIpyuXjTnGFA0izVmbQw5f\nrQnZ0geGyhLamvz9Gcd7mIlD/+/AEN9Lht82tAOzKG98/O8CAwEAAaNTMFEwHQYD\nVR0OBBYEFKv6RsvEC6T+zCtJZwB0FCR1sEkhMB8GA1UdIwQYMBaAFKv6RsvEC6T+\nzCtJZwB0FCR1sEkhMA8GA1UdEwEB/wQFMAMBAf8wDQYJKoZIhvcNAQELBQADggEB\nAC5fBrouinespo5+9AipjhY/HOKTg+OCnppFnSnqeU1eXZZJ0oakdHTpTNxtbQP9\ntOJTA2f3KWvmpNDMohEQXZz8wHDkdbrIXJKVp6zs1pEp+0BIjA4y9mSywa5xuyk0\noGeChRgGqp2JujDyPCb7LEaKKQEEdMqy73QG+jEAh14+wKixlAf1nATBdeCUvssK\n2x1uZMyqjJFB5y/5EdnWQzD4WJkrsCkxsZHVMN1d+dqf2sf3dTRV8fzsFGOG17NS\n6u2n9iGcFdBA82XN8yeLIWhy1t3GWutG1sdxENbFRRXea+iUqzDsmRtkaBma2GLQ\nd6JTpFbsCtwDjP23UEi7SZo=\n-----END CERTIFICATE-----\n", - "created_at": "2025-01-14T10:06:43Z", - "extended_key_usages": [], - "id": "cert_2rcCv3b6WQcJH88QmE53sVrAD4x", - "issued_at": null, - "issuer_common_name": "example.com", - "key_usages": [], - "not_after": "2020-04-23T18:18:19Z", - "not_before": "2020-03-24T18:18:19Z", - "private_key_type": "rsa", - "serial_number": "054ba70dd03882382d11b640f30f4b8e1be5ddb1", - "subject_alternative_names": { - "dns_names": [], - "ips": [] - }, - "subject_common_name": "example.com", - "subject_country": "", - "subject_locality": "", - "subject_organization": "", - "subject_organizational_unit": "", - "subject_province": "", - "uri": "https://api.ngrok.com/tls_certificates/cert_2rcCv3b6WQcJH88QmE53sVrAD4x" -} -``` diff --git a/docs/api/examples/_tls_certificates_delete_request.md b/docs/api/examples/_tls_certificates_delete_request.md deleted file mode 100644 index 68f372a643..0000000000 --- a/docs/api/examples/_tls_certificates_delete_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X DELETE \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/tls_certificates/cert_2rcCv3b6WQcJH88QmE53sVrAD4x -``` diff --git a/docs/api/examples/_tls_certificates_delete_response.md b/docs/api/examples/_tls_certificates_delete_response.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/api/examples/_tls_certificates_get_request.md b/docs/api/examples/_tls_certificates_get_request.md deleted file mode 100644 index 1ae2399fc4..0000000000 --- a/docs/api/examples/_tls_certificates_get_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/tls_certificates/cert_2rcCv3b6WQcJH88QmE53sVrAD4x -``` diff --git a/docs/api/examples/_tls_certificates_get_response.md b/docs/api/examples/_tls_certificates_get_response.md deleted file mode 100644 index 6554e7275b..0000000000 --- a/docs/api/examples/_tls_certificates_get_response.md +++ /dev/null @@ -1,31 +0,0 @@ - - -#### Example Response - -```json -{ - "certificate_pem": "-----BEGIN CERTIFICATE-----\nMIIDDTCCAfWgAwIBAgIUBUunDdA4gjgtEbZA8w9Ljhvl3bEwDQYJKoZIhvcNAQEL\nBQAwFjEUMBIGA1UEAwwLZXhhbXBsZS5jb20wHhcNMjAwMzI0MTgxODE5WhcNMjAw\nNDIzMTgxODE5WjAWMRQwEgYDVQQDDAtleGFtcGxlLmNvbTCCASIwDQYJKoZIhvcN\nAQEBBQADggEPADCCAQoCggEBAPKVkkKYNl3d9cqrz4tIFlwsohED5W4y1dcBixy4\nGANFFnw43nc2wPyKwYXumJqJIFrcW/NkUZL07bd+dou6mT6Gh/zbaTW91IkREPXL\n7b3KfVu4XkFosVXpWs0U6o4GrZ81CLiKBWI+H03x/ij5OSiJ1l71pqLeTJLOydAR\nAl8kpp7axeHU4UbDrAZkW5SnuZTjIKwVg0UNsBg1yNfUOu1Uah3BYaqPgQitC0Yg\nLW+NUGu/T91bkD7tLsVInkQXeQGdXBAqOycfJ7wj8OlIpyuXjTnGFA0izVmbQw5f\nrQnZ0geGyhLamvz9Gcd7mIlD/+/AEN9Lht82tAOzKG98/O8CAwEAAaNTMFEwHQYD\nVR0OBBYEFKv6RsvEC6T+zCtJZwB0FCR1sEkhMB8GA1UdIwQYMBaAFKv6RsvEC6T+\nzCtJZwB0FCR1sEkhMA8GA1UdEwEB/wQFMAMBAf8wDQYJKoZIhvcNAQELBQADggEB\nAC5fBrouinespo5+9AipjhY/HOKTg+OCnppFnSnqeU1eXZZJ0oakdHTpTNxtbQP9\ntOJTA2f3KWvmpNDMohEQXZz8wHDkdbrIXJKVp6zs1pEp+0BIjA4y9mSywa5xuyk0\noGeChRgGqp2JujDyPCb7LEaKKQEEdMqy73QG+jEAh14+wKixlAf1nATBdeCUvssK\n2x1uZMyqjJFB5y/5EdnWQzD4WJkrsCkxsZHVMN1d+dqf2sf3dTRV8fzsFGOG17NS\n6u2n9iGcFdBA82XN8yeLIWhy1t3GWutG1sdxENbFRRXea+iUqzDsmRtkaBma2GLQ\nd6JTpFbsCtwDjP23UEi7SZo=\n-----END CERTIFICATE-----\n", - "created_at": "2025-01-14T10:06:43Z", - "extended_key_usages": [], - "id": "cert_2rcCv3b6WQcJH88QmE53sVrAD4x", - "issued_at": null, - "issuer_common_name": "example.com", - "key_usages": [], - "metadata": "{\"example\": true}", - "not_after": "2020-04-23T18:18:19Z", - "not_before": "2020-03-24T18:18:19Z", - "private_key_type": "rsa", - "serial_number": "054ba70dd03882382d11b640f30f4b8e1be5ddb1", - "subject_alternative_names": { - "dns_names": [], - "ips": [] - }, - "subject_common_name": "example.com", - "subject_country": "", - "subject_locality": "", - "subject_organization": "", - "subject_organizational_unit": "", - "subject_province": "", - "uri": "https://api.ngrok.com/tls_certificates/cert_2rcCv3b6WQcJH88QmE53sVrAD4x" -} -``` diff --git a/docs/api/examples/_tls_certificates_list_request.md b/docs/api/examples/_tls_certificates_list_request.md deleted file mode 100644 index feaa70b9c8..0000000000 --- a/docs/api/examples/_tls_certificates_list_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/tls_certificates -``` diff --git a/docs/api/examples/_tls_certificates_list_response.md b/docs/api/examples/_tls_certificates_list_response.md deleted file mode 100644 index 84bb2a42bf..0000000000 --- a/docs/api/examples/_tls_certificates_list_response.md +++ /dev/null @@ -1,60 +0,0 @@ - - -#### Example Response - -```json -{ - "next_page_uri": null, - "tls_certificates": [ - { - "certificate_pem": "-----BEGIN CERTIFICATE-----\nMIIDDTCCAfWgAwIBAgIUBUunDdA4gjgtEbZA8w9Ljhvl3bEwDQYJKoZIhvcNAQEL\nBQAwFjEUMBIGA1UEAwwLZXhhbXBsZS5jb20wHhcNMjAwMzI0MTgxODE5WhcNMjAw\nNDIzMTgxODE5WjAWMRQwEgYDVQQDDAtleGFtcGxlLmNvbTCCASIwDQYJKoZIhvcN\nAQEBBQADggEPADCCAQoCggEBAPKVkkKYNl3d9cqrz4tIFlwsohED5W4y1dcBixy4\nGANFFnw43nc2wPyKwYXumJqJIFrcW/NkUZL07bd+dou6mT6Gh/zbaTW91IkREPXL\n7b3KfVu4XkFosVXpWs0U6o4GrZ81CLiKBWI+H03x/ij5OSiJ1l71pqLeTJLOydAR\nAl8kpp7axeHU4UbDrAZkW5SnuZTjIKwVg0UNsBg1yNfUOu1Uah3BYaqPgQitC0Yg\nLW+NUGu/T91bkD7tLsVInkQXeQGdXBAqOycfJ7wj8OlIpyuXjTnGFA0izVmbQw5f\nrQnZ0geGyhLamvz9Gcd7mIlD/+/AEN9Lht82tAOzKG98/O8CAwEAAaNTMFEwHQYD\nVR0OBBYEFKv6RsvEC6T+zCtJZwB0FCR1sEkhMB8GA1UdIwQYMBaAFKv6RsvEC6T+\nzCtJZwB0FCR1sEkhMA8GA1UdEwEB/wQFMAMBAf8wDQYJKoZIhvcNAQELBQADggEB\nAC5fBrouinespo5+9AipjhY/HOKTg+OCnppFnSnqeU1eXZZJ0oakdHTpTNxtbQP9\ntOJTA2f3KWvmpNDMohEQXZz8wHDkdbrIXJKVp6zs1pEp+0BIjA4y9mSywa5xuyk0\noGeChRgGqp2JujDyPCb7LEaKKQEEdMqy73QG+jEAh14+wKixlAf1nATBdeCUvssK\n2x1uZMyqjJFB5y/5EdnWQzD4WJkrsCkxsZHVMN1d+dqf2sf3dTRV8fzsFGOG17NS\n6u2n9iGcFdBA82XN8yeLIWhy1t3GWutG1sdxENbFRRXea+iUqzDsmRtkaBma2GLQ\nd6JTpFbsCtwDjP23UEi7SZo=\n-----END CERTIFICATE-----\n", - "created_at": "2025-01-14T10:06:19Z", - "extended_key_usages": [], - "id": "cert_2rcCs2QtJegkrx6XjyNk7c2wjfp", - "issued_at": null, - "issuer_common_name": "example.com", - "key_usages": [], - "not_after": "2020-04-23T18:18:19Z", - "not_before": "2020-03-24T18:18:19Z", - "private_key_type": "rsa", - "serial_number": "054ba70dd03882382d11b640f30f4b8e1be5ddb1", - "subject_alternative_names": { - "dns_names": [], - "ips": [] - }, - "subject_common_name": "example.com", - "subject_country": "", - "subject_locality": "", - "subject_organization": "", - "subject_organizational_unit": "", - "subject_province": "", - "uri": "https://api.ngrok.com/tls_certificates/cert_2rcCs2QtJegkrx6XjyNk7c2wjfp" - }, - { - "certificate_pem": "-----BEGIN CERTIFICATE-----\nMIIDDTCCAfWgAwIBAgIUBUunDdA4gjgtEbZA8w9Ljhvl3bEwDQYJKoZIhvcNAQEL\nBQAwFjEUMBIGA1UEAwwLZXhhbXBsZS5jb20wHhcNMjAwMzI0MTgxODE5WhcNMjAw\nNDIzMTgxODE5WjAWMRQwEgYDVQQDDAtleGFtcGxlLmNvbTCCASIwDQYJKoZIhvcN\nAQEBBQADggEPADCCAQoCggEBAPKVkkKYNl3d9cqrz4tIFlwsohED5W4y1dcBixy4\nGANFFnw43nc2wPyKwYXumJqJIFrcW/NkUZL07bd+dou6mT6Gh/zbaTW91IkREPXL\n7b3KfVu4XkFosVXpWs0U6o4GrZ81CLiKBWI+H03x/ij5OSiJ1l71pqLeTJLOydAR\nAl8kpp7axeHU4UbDrAZkW5SnuZTjIKwVg0UNsBg1yNfUOu1Uah3BYaqPgQitC0Yg\nLW+NUGu/T91bkD7tLsVInkQXeQGdXBAqOycfJ7wj8OlIpyuXjTnGFA0izVmbQw5f\nrQnZ0geGyhLamvz9Gcd7mIlD/+/AEN9Lht82tAOzKG98/O8CAwEAAaNTMFEwHQYD\nVR0OBBYEFKv6RsvEC6T+zCtJZwB0FCR1sEkhMB8GA1UdIwQYMBaAFKv6RsvEC6T+\nzCtJZwB0FCR1sEkhMA8GA1UdEwEB/wQFMAMBAf8wDQYJKoZIhvcNAQELBQADggEB\nAC5fBrouinespo5+9AipjhY/HOKTg+OCnppFnSnqeU1eXZZJ0oakdHTpTNxtbQP9\ntOJTA2f3KWvmpNDMohEQXZz8wHDkdbrIXJKVp6zs1pEp+0BIjA4y9mSywa5xuyk0\noGeChRgGqp2JujDyPCb7LEaKKQEEdMqy73QG+jEAh14+wKixlAf1nATBdeCUvssK\n2x1uZMyqjJFB5y/5EdnWQzD4WJkrsCkxsZHVMN1d+dqf2sf3dTRV8fzsFGOG17NS\n6u2n9iGcFdBA82XN8yeLIWhy1t3GWutG1sdxENbFRRXea+iUqzDsmRtkaBma2GLQ\nd6JTpFbsCtwDjP23UEi7SZo=\n-----END CERTIFICATE-----\n", - "created_at": "2025-01-14T10:06:43Z", - "extended_key_usages": [], - "id": "cert_2rcCv3b6WQcJH88QmE53sVrAD4x", - "issued_at": null, - "issuer_common_name": "example.com", - "key_usages": [], - "not_after": "2020-04-23T18:18:19Z", - "not_before": "2020-03-24T18:18:19Z", - "private_key_type": "rsa", - "serial_number": "054ba70dd03882382d11b640f30f4b8e1be5ddb1", - "subject_alternative_names": { - "dns_names": [], - "ips": [] - }, - "subject_common_name": "example.com", - "subject_country": "", - "subject_locality": "", - "subject_organization": "", - "subject_organizational_unit": "", - "subject_province": "", - "uri": "https://api.ngrok.com/tls_certificates/cert_2rcCv3b6WQcJH88QmE53sVrAD4x" - } - ], - "uri": "https://api.ngrok.com/tls_certificates" -} -``` diff --git a/docs/api/examples/_tls_certificates_update_request.md b/docs/api/examples/_tls_certificates_update_request.md deleted file mode 100644 index b45c3d5c7b..0000000000 --- a/docs/api/examples/_tls_certificates_update_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X PATCH \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"metadata":"{\"example\": true}"}' \ -https://api.ngrok.com/tls_certificates/cert_2rcCv3b6WQcJH88QmE53sVrAD4x -``` diff --git a/docs/api/examples/_tls_certificates_update_response.md b/docs/api/examples/_tls_certificates_update_response.md deleted file mode 100644 index 6554e7275b..0000000000 --- a/docs/api/examples/_tls_certificates_update_response.md +++ /dev/null @@ -1,31 +0,0 @@ - - -#### Example Response - -```json -{ - "certificate_pem": "-----BEGIN CERTIFICATE-----\nMIIDDTCCAfWgAwIBAgIUBUunDdA4gjgtEbZA8w9Ljhvl3bEwDQYJKoZIhvcNAQEL\nBQAwFjEUMBIGA1UEAwwLZXhhbXBsZS5jb20wHhcNMjAwMzI0MTgxODE5WhcNMjAw\nNDIzMTgxODE5WjAWMRQwEgYDVQQDDAtleGFtcGxlLmNvbTCCASIwDQYJKoZIhvcN\nAQEBBQADggEPADCCAQoCggEBAPKVkkKYNl3d9cqrz4tIFlwsohED5W4y1dcBixy4\nGANFFnw43nc2wPyKwYXumJqJIFrcW/NkUZL07bd+dou6mT6Gh/zbaTW91IkREPXL\n7b3KfVu4XkFosVXpWs0U6o4GrZ81CLiKBWI+H03x/ij5OSiJ1l71pqLeTJLOydAR\nAl8kpp7axeHU4UbDrAZkW5SnuZTjIKwVg0UNsBg1yNfUOu1Uah3BYaqPgQitC0Yg\nLW+NUGu/T91bkD7tLsVInkQXeQGdXBAqOycfJ7wj8OlIpyuXjTnGFA0izVmbQw5f\nrQnZ0geGyhLamvz9Gcd7mIlD/+/AEN9Lht82tAOzKG98/O8CAwEAAaNTMFEwHQYD\nVR0OBBYEFKv6RsvEC6T+zCtJZwB0FCR1sEkhMB8GA1UdIwQYMBaAFKv6RsvEC6T+\nzCtJZwB0FCR1sEkhMA8GA1UdEwEB/wQFMAMBAf8wDQYJKoZIhvcNAQELBQADggEB\nAC5fBrouinespo5+9AipjhY/HOKTg+OCnppFnSnqeU1eXZZJ0oakdHTpTNxtbQP9\ntOJTA2f3KWvmpNDMohEQXZz8wHDkdbrIXJKVp6zs1pEp+0BIjA4y9mSywa5xuyk0\noGeChRgGqp2JujDyPCb7LEaKKQEEdMqy73QG+jEAh14+wKixlAf1nATBdeCUvssK\n2x1uZMyqjJFB5y/5EdnWQzD4WJkrsCkxsZHVMN1d+dqf2sf3dTRV8fzsFGOG17NS\n6u2n9iGcFdBA82XN8yeLIWhy1t3GWutG1sdxENbFRRXea+iUqzDsmRtkaBma2GLQ\nd6JTpFbsCtwDjP23UEi7SZo=\n-----END CERTIFICATE-----\n", - "created_at": "2025-01-14T10:06:43Z", - "extended_key_usages": [], - "id": "cert_2rcCv3b6WQcJH88QmE53sVrAD4x", - "issued_at": null, - "issuer_common_name": "example.com", - "key_usages": [], - "metadata": "{\"example\": true}", - "not_after": "2020-04-23T18:18:19Z", - "not_before": "2020-03-24T18:18:19Z", - "private_key_type": "rsa", - "serial_number": "054ba70dd03882382d11b640f30f4b8e1be5ddb1", - "subject_alternative_names": { - "dns_names": [], - "ips": [] - }, - "subject_common_name": "example.com", - "subject_country": "", - "subject_locality": "", - "subject_organization": "", - "subject_organizational_unit": "", - "subject_province": "", - "uri": "https://api.ngrok.com/tls_certificates/cert_2rcCv3b6WQcJH88QmE53sVrAD4x" -} -``` diff --git a/docs/api/examples/_tls_edge_backend_module_delete_request.md b/docs/api/examples/_tls_edge_backend_module_delete_request.md deleted file mode 100644 index 0984b02de7..0000000000 --- a/docs/api/examples/_tls_edge_backend_module_delete_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X DELETE \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/edges/tls/edgtls_2rcCvcqSVhXk4Jb55qH0IDQBh6Q/backend -``` diff --git a/docs/api/examples/_tls_edge_backend_module_delete_response.md b/docs/api/examples/_tls_edge_backend_module_delete_response.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/api/examples/_tls_edge_backend_module_get_request.md b/docs/api/examples/_tls_edge_backend_module_get_request.md deleted file mode 100644 index 9689e7ec66..0000000000 --- a/docs/api/examples/_tls_edge_backend_module_get_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/edges/tls/edgtls_2rcCvcqSVhXk4Jb55qH0IDQBh6Q/backend -``` diff --git a/docs/api/examples/_tls_edge_backend_module_get_response.md b/docs/api/examples/_tls_edge_backend_module_get_response.md deleted file mode 100644 index eade6049a1..0000000000 --- a/docs/api/examples/_tls_edge_backend_module_get_response.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Response - -```json -{ - "backend": { - "id": "bkdtg_2rcCveZx2pkjT3J9VVwOKvHbB6k", - "uri": "https://api.ngrok.com/backends/tunnel_group/bkdtg_2rcCveZx2pkjT3J9VVwOKvHbB6k" - }, - "enabled": true -} -``` diff --git a/docs/api/examples/_tls_edge_backend_module_replace_request.md b/docs/api/examples/_tls_edge_backend_module_replace_request.md deleted file mode 100644 index dfcc3cf3d4..0000000000 --- a/docs/api/examples/_tls_edge_backend_module_replace_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X PUT \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"backend_id":"bkdtg_2rcCveZx2pkjT3J9VVwOKvHbB6k","enabled":true}' \ -https://api.ngrok.com/edges/tls/edgtls_2rcCvcqSVhXk4Jb55qH0IDQBh6Q/backend -``` diff --git a/docs/api/examples/_tls_edge_backend_module_replace_response.md b/docs/api/examples/_tls_edge_backend_module_replace_response.md deleted file mode 100644 index eade6049a1..0000000000 --- a/docs/api/examples/_tls_edge_backend_module_replace_response.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Response - -```json -{ - "backend": { - "id": "bkdtg_2rcCveZx2pkjT3J9VVwOKvHbB6k", - "uri": "https://api.ngrok.com/backends/tunnel_group/bkdtg_2rcCveZx2pkjT3J9VVwOKvHbB6k" - }, - "enabled": true -} -``` diff --git a/docs/api/examples/_tls_edge_ip_restriction_module_delete_request.md b/docs/api/examples/_tls_edge_ip_restriction_module_delete_request.md deleted file mode 100644 index ee6a6ffadc..0000000000 --- a/docs/api/examples/_tls_edge_ip_restriction_module_delete_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X DELETE \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/edges/tls/edgtls_2rcCvlyxKGx3KFK2cjIbAcHKPgp/ip_restriction -``` diff --git a/docs/api/examples/_tls_edge_ip_restriction_module_delete_response.md b/docs/api/examples/_tls_edge_ip_restriction_module_delete_response.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/api/examples/_tls_edge_ip_restriction_module_get_request.md b/docs/api/examples/_tls_edge_ip_restriction_module_get_request.md deleted file mode 100644 index 4c754b18df..0000000000 --- a/docs/api/examples/_tls_edge_ip_restriction_module_get_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/edges/tls/edgtls_2rcCvlyxKGx3KFK2cjIbAcHKPgp/ip_restriction -``` diff --git a/docs/api/examples/_tls_edge_ip_restriction_module_get_response.md b/docs/api/examples/_tls_edge_ip_restriction_module_get_response.md deleted file mode 100644 index dd88f4e15d..0000000000 --- a/docs/api/examples/_tls_edge_ip_restriction_module_get_response.md +++ /dev/null @@ -1,19 +0,0 @@ - - -#### Example Response - -```json -{ - "enabled": true, - "ip_policies": [ - { - "id": "ipp_2rcCvn1rEmB5C5kN06onguw8f73", - "uri": "https://api.ngrok.com/ip_policies/ipp_2rcCvn1rEmB5C5kN06onguw8f73" - }, - { - "id": "ipp_2rcCvgJigl5R0YXLcv34BdCF4px", - "uri": "https://api.ngrok.com/ip_policies/ipp_2rcCvgJigl5R0YXLcv34BdCF4px" - } - ] -} -``` diff --git a/docs/api/examples/_tls_edge_ip_restriction_module_replace_request.md b/docs/api/examples/_tls_edge_ip_restriction_module_replace_request.md deleted file mode 100644 index 05007fdcdd..0000000000 --- a/docs/api/examples/_tls_edge_ip_restriction_module_replace_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X PUT \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"enabled":true,"ip_policy_ids":["ipp_2rcCvn1rEmB5C5kN06onguw8f73","ipp_2rcCvgJigl5R0YXLcv34BdCF4px"]}' \ -https://api.ngrok.com/edges/tls/edgtls_2rcCvlyxKGx3KFK2cjIbAcHKPgp/ip_restriction -``` diff --git a/docs/api/examples/_tls_edge_ip_restriction_module_replace_response.md b/docs/api/examples/_tls_edge_ip_restriction_module_replace_response.md deleted file mode 100644 index dd88f4e15d..0000000000 --- a/docs/api/examples/_tls_edge_ip_restriction_module_replace_response.md +++ /dev/null @@ -1,19 +0,0 @@ - - -#### Example Response - -```json -{ - "enabled": true, - "ip_policies": [ - { - "id": "ipp_2rcCvn1rEmB5C5kN06onguw8f73", - "uri": "https://api.ngrok.com/ip_policies/ipp_2rcCvn1rEmB5C5kN06onguw8f73" - }, - { - "id": "ipp_2rcCvgJigl5R0YXLcv34BdCF4px", - "uri": "https://api.ngrok.com/ip_policies/ipp_2rcCvgJigl5R0YXLcv34BdCF4px" - } - ] -} -``` diff --git a/docs/api/examples/_tls_edge_mutual_tls_module_delete_request.md b/docs/api/examples/_tls_edge_mutual_tls_module_delete_request.md deleted file mode 100644 index 0c72c223f1..0000000000 --- a/docs/api/examples/_tls_edge_mutual_tls_module_delete_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X DELETE \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/edges/tls/edgtls_2rcCvmq6QmOt6hygli7b6Iydvlz/mutual_tls -``` diff --git a/docs/api/examples/_tls_edge_mutual_tls_module_delete_response.md b/docs/api/examples/_tls_edge_mutual_tls_module_delete_response.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/api/examples/_tls_edge_mutual_tls_module_get_request.md b/docs/api/examples/_tls_edge_mutual_tls_module_get_request.md deleted file mode 100644 index 0d212b86aa..0000000000 --- a/docs/api/examples/_tls_edge_mutual_tls_module_get_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/edges/tls/edgtls_2rcCvmq6QmOt6hygli7b6Iydvlz/mutual_tls -``` diff --git a/docs/api/examples/_tls_edge_mutual_tls_module_get_response.md b/docs/api/examples/_tls_edge_mutual_tls_module_get_response.md deleted file mode 100644 index 278944931d..0000000000 --- a/docs/api/examples/_tls_edge_mutual_tls_module_get_response.md +++ /dev/null @@ -1,15 +0,0 @@ - - -#### Example Response - -```json -{ - "certificate_authorities": [ - { - "id": "ca_2rcCvnhuFnc5dnlk2myrv1aTmKj", - "uri": "https://api.ngrok.com/certificate_authorities/ca_2rcCvnhuFnc5dnlk2myrv1aTmKj" - } - ], - "enabled": true -} -``` diff --git a/docs/api/examples/_tls_edge_mutual_tls_module_replace_request.md b/docs/api/examples/_tls_edge_mutual_tls_module_replace_request.md deleted file mode 100644 index 626fa90451..0000000000 --- a/docs/api/examples/_tls_edge_mutual_tls_module_replace_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X PUT \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"certificate_authority_ids":["ca_2rcCvnhuFnc5dnlk2myrv1aTmKj"],"enabled":true}' \ -https://api.ngrok.com/edges/tls/edgtls_2rcCvmq6QmOt6hygli7b6Iydvlz/mutual_tls -``` diff --git a/docs/api/examples/_tls_edge_mutual_tls_module_replace_response.md b/docs/api/examples/_tls_edge_mutual_tls_module_replace_response.md deleted file mode 100644 index 278944931d..0000000000 --- a/docs/api/examples/_tls_edge_mutual_tls_module_replace_response.md +++ /dev/null @@ -1,15 +0,0 @@ - - -#### Example Response - -```json -{ - "certificate_authorities": [ - { - "id": "ca_2rcCvnhuFnc5dnlk2myrv1aTmKj", - "uri": "https://api.ngrok.com/certificate_authorities/ca_2rcCvnhuFnc5dnlk2myrv1aTmKj" - } - ], - "enabled": true -} -``` diff --git a/docs/api/examples/_tls_edge_tls_termination_module_delete_request.md b/docs/api/examples/_tls_edge_tls_termination_module_delete_request.md deleted file mode 100644 index 59f4ec750b..0000000000 --- a/docs/api/examples/_tls_edge_tls_termination_module_delete_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X DELETE \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/edges/tls/edgtls_2rcCvgt8gt7Gz4lvsoF778zD5zD/tls_termination -``` diff --git a/docs/api/examples/_tls_edge_tls_termination_module_delete_response.md b/docs/api/examples/_tls_edge_tls_termination_module_delete_response.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/api/examples/_tls_edge_tls_termination_module_get_request.md b/docs/api/examples/_tls_edge_tls_termination_module_get_request.md deleted file mode 100644 index d36f404995..0000000000 --- a/docs/api/examples/_tls_edge_tls_termination_module_get_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/edges/tls/edgtls_2rcCvgt8gt7Gz4lvsoF778zD5zD/tls_termination -``` diff --git a/docs/api/examples/_tls_edge_tls_termination_module_get_response.md b/docs/api/examples/_tls_edge_tls_termination_module_get_response.md deleted file mode 100644 index b80c138941..0000000000 --- a/docs/api/examples/_tls_edge_tls_termination_module_get_response.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Response - -```json -{ - "enabled": true, - "min_version": "1.3", - "terminate_at": "edge" -} -``` diff --git a/docs/api/examples/_tls_edge_tls_termination_module_replace_request.md b/docs/api/examples/_tls_edge_tls_termination_module_replace_request.md deleted file mode 100644 index a68e3e5fee..0000000000 --- a/docs/api/examples/_tls_edge_tls_termination_module_replace_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X PUT \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"enabled":true,"min_version":"1.3","terminate_at":"edge"}' \ -https://api.ngrok.com/edges/tls/edgtls_2rcCvgt8gt7Gz4lvsoF778zD5zD/tls_termination -``` diff --git a/docs/api/examples/_tls_edge_tls_termination_module_replace_response.md b/docs/api/examples/_tls_edge_tls_termination_module_replace_response.md deleted file mode 100644 index b80c138941..0000000000 --- a/docs/api/examples/_tls_edge_tls_termination_module_replace_response.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Response - -```json -{ - "enabled": true, - "min_version": "1.3", - "terminate_at": "edge" -} -``` diff --git a/docs/api/examples/_tls_edge_traffic_policy_module_delete_request.md b/docs/api/examples/_tls_edge_traffic_policy_module_delete_request.md deleted file mode 100644 index e2847bae14..0000000000 --- a/docs/api/examples/_tls_edge_traffic_policy_module_delete_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X DELETE \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/edges/tls/edgtls_2rcCvhV3B5wtBf9q9ohXFTqwoPv/traffic_policy -``` diff --git a/docs/api/examples/_tls_edge_traffic_policy_module_delete_response.md b/docs/api/examples/_tls_edge_traffic_policy_module_delete_response.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/api/examples/_tls_edge_traffic_policy_module_get_request.md b/docs/api/examples/_tls_edge_traffic_policy_module_get_request.md deleted file mode 100644 index d56fb3f8a7..0000000000 --- a/docs/api/examples/_tls_edge_traffic_policy_module_get_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/edges/tls/edgtls_2rcCvhV3B5wtBf9q9ohXFTqwoPv/traffic_policy -``` diff --git a/docs/api/examples/_tls_edge_traffic_policy_module_get_response.md b/docs/api/examples/_tls_edge_traffic_policy_module_get_response.md deleted file mode 100644 index e653c3f173..0000000000 --- a/docs/api/examples/_tls_edge_traffic_policy_module_get_response.md +++ /dev/null @@ -1,10 +0,0 @@ - - -#### Example Response - -```json -{ - "enabled": true, - "value": "{\n\t\"on_tcp_connect\": [\n\t\t{\n\t\t\t\"name\": \"Block requests from certain countries\",\n\t\t\t\"expressions\":[\"conn.geo.country_code in ['BR', 'CN', 'CU', 'IR', 'NG', 'RO', 'RU', 'SD', 'SY', 'UA']\"],\n\t\t\t\"actions\":[\n\t\t\t\t{\n\t\t\t\t\t\"type\":\"log\",\n\t\t\t\t\t\"config\":{\n\t\t\t\t\t\t\"metadata\":{\n\t\t\t\t\t\t\t\"blockedCountry\":\"${conn.geo.country_code}\",\n\t\t\t\t\t\t\t\"edgeId\": \"edgtls_2rcCvhV3B5wtBf9q9ohXFTqwoPv\"\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"type\":\"deny\"\n\t\t\t\t}\n\t\t\t]\n\t\t}\n\t]\n}" -} -``` diff --git a/docs/api/examples/_tls_edge_traffic_policy_module_replace_request.md b/docs/api/examples/_tls_edge_traffic_policy_module_replace_request.md deleted file mode 100644 index a0409aad26..0000000000 --- a/docs/api/examples/_tls_edge_traffic_policy_module_replace_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X PUT \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"enabled":true,"value":"{\n\t\"on_tcp_connect\": [\n\t\t{\n\t\t\t\"name\": \"Block requests from certain countries\",\n\t\t\t\"expressions\":[\"conn.geo.country_code in ['BR', 'CN', 'CU', 'IR', 'NG', 'RO', 'RU', 'SD', 'SY', 'UA']\"],\n\t\t\t\"actions\":[\n\t\t\t\t{\n\t\t\t\t\t\"type\":\"log\",\n\t\t\t\t\t\"config\":{\n\t\t\t\t\t\t\"metadata\":{\n\t\t\t\t\t\t\t\"blockedCountry\":\"${conn.geo.country_code}\",\n\t\t\t\t\t\t\t\"edgeId\": \"edgtls_2rcCvhV3B5wtBf9q9ohXFTqwoPv\"\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"type\":\"deny\"\n\t\t\t\t}\n\t\t\t]\n\t\t}\n\t]\n}"}' \ -https://api.ngrok.com/edges/tls/edgtls_2rcCvhV3B5wtBf9q9ohXFTqwoPv/traffic_policy -``` diff --git a/docs/api/examples/_tls_edge_traffic_policy_module_replace_response.md b/docs/api/examples/_tls_edge_traffic_policy_module_replace_response.md deleted file mode 100644 index e653c3f173..0000000000 --- a/docs/api/examples/_tls_edge_traffic_policy_module_replace_response.md +++ /dev/null @@ -1,10 +0,0 @@ - - -#### Example Response - -```json -{ - "enabled": true, - "value": "{\n\t\"on_tcp_connect\": [\n\t\t{\n\t\t\t\"name\": \"Block requests from certain countries\",\n\t\t\t\"expressions\":[\"conn.geo.country_code in ['BR', 'CN', 'CU', 'IR', 'NG', 'RO', 'RU', 'SD', 'SY', 'UA']\"],\n\t\t\t\"actions\":[\n\t\t\t\t{\n\t\t\t\t\t\"type\":\"log\",\n\t\t\t\t\t\"config\":{\n\t\t\t\t\t\t\"metadata\":{\n\t\t\t\t\t\t\t\"blockedCountry\":\"${conn.geo.country_code}\",\n\t\t\t\t\t\t\t\"edgeId\": \"edgtls_2rcCvhV3B5wtBf9q9ohXFTqwoPv\"\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"type\":\"deny\"\n\t\t\t\t}\n\t\t\t]\n\t\t}\n\t]\n}" -} -``` diff --git a/docs/api/examples/_tunnel_group_backends_create_request.md b/docs/api/examples/_tunnel_group_backends_create_request.md deleted file mode 100644 index 97a937ee56..0000000000 --- a/docs/api/examples/_tunnel_group_backends_create_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X POST \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"description":"acme tunnel group","labels":{"baz":"qux","foo":"bar"},"metadata":"{\"environment\": \"staging\"}"}' \ -https://api.ngrok.com/backends/tunnel_group -``` diff --git a/docs/api/examples/_tunnel_group_backends_create_response.md b/docs/api/examples/_tunnel_group_backends_create_response.md deleted file mode 100644 index 1dc552bca7..0000000000 --- a/docs/api/examples/_tunnel_group_backends_create_response.md +++ /dev/null @@ -1,18 +0,0 @@ - - -#### Example Response - -```json -{ - "created_at": "2025-01-14T10:06:43Z", - "description": "acme tunnel group", - "id": "bkdtg_2rcCv6KsW4uhmT159BdDTjx3ZEc", - "labels": { - "baz": "qux", - "foo": "bar" - }, - "metadata": "{\"environment\": \"staging\"}", - "tunnels": [], - "uri": "https://api.ngrok.com/backends/tunnel_group/bkdtg_2rcCv6KsW4uhmT159BdDTjx3ZEc" -} -``` diff --git a/docs/api/examples/_tunnel_group_backends_delete_request.md b/docs/api/examples/_tunnel_group_backends_delete_request.md deleted file mode 100644 index c72f2a5374..0000000000 --- a/docs/api/examples/_tunnel_group_backends_delete_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X DELETE \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/backends/tunnel_group/bkdtg_2rcCv6KsW4uhmT159BdDTjx3ZEc -``` diff --git a/docs/api/examples/_tunnel_group_backends_delete_response.md b/docs/api/examples/_tunnel_group_backends_delete_response.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/api/examples/_tunnel_group_backends_get_request.md b/docs/api/examples/_tunnel_group_backends_get_request.md deleted file mode 100644 index 156ae86dda..0000000000 --- a/docs/api/examples/_tunnel_group_backends_get_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/backends/tunnel_group/bkdtg_2rcCv6KsW4uhmT159BdDTjx3ZEc -``` diff --git a/docs/api/examples/_tunnel_group_backends_get_response.md b/docs/api/examples/_tunnel_group_backends_get_response.md deleted file mode 100644 index 1dc552bca7..0000000000 --- a/docs/api/examples/_tunnel_group_backends_get_response.md +++ /dev/null @@ -1,18 +0,0 @@ - - -#### Example Response - -```json -{ - "created_at": "2025-01-14T10:06:43Z", - "description": "acme tunnel group", - "id": "bkdtg_2rcCv6KsW4uhmT159BdDTjx3ZEc", - "labels": { - "baz": "qux", - "foo": "bar" - }, - "metadata": "{\"environment\": \"staging\"}", - "tunnels": [], - "uri": "https://api.ngrok.com/backends/tunnel_group/bkdtg_2rcCv6KsW4uhmT159BdDTjx3ZEc" -} -``` diff --git a/docs/api/examples/_tunnel_group_backends_list_request.md b/docs/api/examples/_tunnel_group_backends_list_request.md deleted file mode 100644 index cd8f2bff31..0000000000 --- a/docs/api/examples/_tunnel_group_backends_list_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/backends/tunnel_group -``` diff --git a/docs/api/examples/_tunnel_group_backends_list_response.md b/docs/api/examples/_tunnel_group_backends_list_response.md deleted file mode 100644 index 40e4f8256c..0000000000 --- a/docs/api/examples/_tunnel_group_backends_list_response.md +++ /dev/null @@ -1,24 +0,0 @@ - - -#### Example Response - -```json -{ - "backends": [ - { - "created_at": "2025-01-14T10:06:43Z", - "description": "acme tunnel group", - "id": "bkdtg_2rcCv6KsW4uhmT159BdDTjx3ZEc", - "labels": { - "baz": "qux", - "foo": "bar" - }, - "metadata": "{\"environment\": \"staging\"}", - "tunnels": [], - "uri": "https://api.ngrok.com/backends/tunnel_group/bkdtg_2rcCv6KsW4uhmT159BdDTjx3ZEc" - } - ], - "next_page_uri": null, - "uri": "https://api.ngrok.com/backends/tunnel_group" -} -``` diff --git a/docs/api/examples/_tunnel_group_backends_update_request.md b/docs/api/examples/_tunnel_group_backends_update_request.md deleted file mode 100644 index 77d552d2da..0000000000 --- a/docs/api/examples/_tunnel_group_backends_update_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X PATCH \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"metadata":"{\"environment\": \"production\"}"}' \ -https://api.ngrok.com/backends/tunnel_group/bkdtg_2rcCv6KsW4uhmT159BdDTjx3ZEc -``` diff --git a/docs/api/examples/_tunnel_group_backends_update_response.md b/docs/api/examples/_tunnel_group_backends_update_response.md deleted file mode 100644 index 0132f3c91a..0000000000 --- a/docs/api/examples/_tunnel_group_backends_update_response.md +++ /dev/null @@ -1,18 +0,0 @@ - - -#### Example Response - -```json -{ - "created_at": "2025-01-14T10:06:43Z", - "description": "acme tunnel group", - "id": "bkdtg_2rcCv6KsW4uhmT159BdDTjx3ZEc", - "labels": { - "baz": "qux", - "foo": "bar" - }, - "metadata": "{\"environment\": \"production\"}", - "tunnels": [], - "uri": "https://api.ngrok.com/backends/tunnel_group/bkdtg_2rcCv6KsW4uhmT159BdDTjx3ZEc" -} -``` diff --git a/docs/api/examples/_tunnel_sessions_get_request.md b/docs/api/examples/_tunnel_sessions_get_request.md deleted file mode 100644 index e6c25be11f..0000000000 --- a/docs/api/examples/_tunnel_sessions_get_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/tunnel_sessions/ts_2rcCtpVFV3ngMDVUpwuyFpeb2iK -``` diff --git a/docs/api/examples/_tunnel_sessions_get_response.md b/docs/api/examples/_tunnel_sessions_get_response.md deleted file mode 100644 index 534c954ea1..0000000000 --- a/docs/api/examples/_tunnel_sessions_get_response.md +++ /dev/null @@ -1,20 +0,0 @@ - - -#### Example Response - -```json -{ - "agent_version": "3.1000.0-development", - "credential": { - "id": "cr_2rcCtSprQjrKwFvCgZ5XCmvbkWs", - "uri": "https://api.ngrok.com/credentials/cr_2rcCtSprQjrKwFvCgZ5XCmvbkWs" - }, - "id": "ts_2rcCtpVFV3ngMDVUpwuyFpeb2iK", - "ip": "10.110.2.2", - "os": "linux", - "region": "us", - "started_at": "2025-01-14T10:06:33Z", - "transport": "ngrok/2", - "uri": "https://api.ngrok.com/tunnel_sessions/ts_2rcCtpVFV3ngMDVUpwuyFpeb2iK" -} -``` diff --git a/docs/api/examples/_tunnel_sessions_list_request.md b/docs/api/examples/_tunnel_sessions_list_request.md deleted file mode 100644 index 49eb12dc8e..0000000000 --- a/docs/api/examples/_tunnel_sessions_list_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/tunnel_sessions -``` diff --git a/docs/api/examples/_tunnel_sessions_list_response.md b/docs/api/examples/_tunnel_sessions_list_response.md deleted file mode 100644 index 2a61b48b08..0000000000 --- a/docs/api/examples/_tunnel_sessions_list_response.md +++ /dev/null @@ -1,26 +0,0 @@ - - -#### Example Response - -```json -{ - "next_page_uri": null, - "tunnel_sessions": [ - { - "agent_version": "3.1000.0-development", - "credential": { - "id": "cr_2rcCtSprQjrKwFvCgZ5XCmvbkWs", - "uri": "https://api.ngrok.com/credentials/cr_2rcCtSprQjrKwFvCgZ5XCmvbkWs" - }, - "id": "ts_2rcCtpVFV3ngMDVUpwuyFpeb2iK", - "ip": "10.110.2.2", - "os": "linux", - "region": "us", - "started_at": "2025-01-14T10:06:33Z", - "transport": "ngrok/2", - "uri": "https://api.ngrok.com/tunnel_sessions/ts_2rcCtpVFV3ngMDVUpwuyFpeb2iK" - } - ], - "uri": "https://api.ngrok.com/tunnel_sessions" -} -``` diff --git a/docs/api/examples/_tunnel_sessions_restart_request.md b/docs/api/examples/_tunnel_sessions_restart_request.md deleted file mode 100644 index 01612a7c9a..0000000000 --- a/docs/api/examples/_tunnel_sessions_restart_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X POST \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{}' \ -https://api.ngrok.com/tunnel_sessions/ts_1vcl4fYZxXY0zNFbpCloylDCG0S/restart -``` diff --git a/docs/api/examples/_tunnel_sessions_restart_response.md b/docs/api/examples/_tunnel_sessions_restart_response.md deleted file mode 100644 index f87a1877f9..0000000000 --- a/docs/api/examples/_tunnel_sessions_restart_response.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Response - -```json -{ - "details": { - "operation_id": "op_2rcCu8jNclvbobKBzkVjCtZUEqs" - }, - "msg": "Resource not found", - "status_code": 404 -} -``` diff --git a/docs/api/examples/_tunnel_sessions_stop_request.md b/docs/api/examples/_tunnel_sessions_stop_request.md deleted file mode 100644 index 9974d54b14..0000000000 --- a/docs/api/examples/_tunnel_sessions_stop_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X POST \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{}' \ -https://api.ngrok.com/tunnel_sessions/ts_1vcl4fYZxXY0zNFbpCloylDCG0S/stop -``` diff --git a/docs/api/examples/_tunnel_sessions_stop_response.md b/docs/api/examples/_tunnel_sessions_stop_response.md deleted file mode 100644 index c8af4450d9..0000000000 --- a/docs/api/examples/_tunnel_sessions_stop_response.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Response - -```json -{ - "details": { - "operation_id": "op_2rcCu7cktekjkWc0zZUDg4o6rVA" - }, - "msg": "Resource not found", - "status_code": 404 -} -``` diff --git a/docs/api/examples/_tunnel_sessions_update_request.md b/docs/api/examples/_tunnel_sessions_update_request.md deleted file mode 100644 index 1a3c45163e..0000000000 --- a/docs/api/examples/_tunnel_sessions_update_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X POST \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{}' \ -https://api.ngrok.com/tunnel_sessions/ts_1vcl4fYZxXY0zNFbpCloylDCG0S/update -``` diff --git a/docs/api/examples/_tunnel_sessions_update_response.md b/docs/api/examples/_tunnel_sessions_update_response.md deleted file mode 100644 index 1caf342364..0000000000 --- a/docs/api/examples/_tunnel_sessions_update_response.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Response - -```json -{ - "details": { - "operation_id": "op_2rcCu6DraRfwHGDnA93NjaXWMk1" - }, - "msg": "Resource not found", - "status_code": 404 -} -``` diff --git a/docs/api/examples/_tunnels_get_request.md b/docs/api/examples/_tunnels_get_request.md deleted file mode 100644 index 845c8ef997..0000000000 --- a/docs/api/examples/_tunnels_get_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/tunnels/tn_2rcCtOidtgIIdOxWw45YFeCF6Fw -``` diff --git a/docs/api/examples/_tunnels_get_response.md b/docs/api/examples/_tunnels_get_response.md deleted file mode 100644 index 04dda6eadb..0000000000 --- a/docs/api/examples/_tunnels_get_response.md +++ /dev/null @@ -1,22 +0,0 @@ - - -#### Example Response - -```json -{ - "endpoint": { - "id": "ep_2rcCtOidtgIIdOxWw45YFeCF6Fw", - "uri": "https://api.ngrok.com/endpoints/ep_2rcCtOidtgIIdOxWw45YFeCF6Fw" - }, - "forwards_to": "http://localhost:80", - "id": "tn_2rcCtOidtgIIdOxWw45YFeCF6Fw", - "proto": "https", - "public_url": "https://249e96dce152.ngrok.paid", - "region": "us", - "started_at": "2025-01-14T10:06:29Z", - "tunnel_session": { - "id": "ts_2rcCtCgTW2lK3bVKaPBCB88Nm38", - "uri": "https://api.ngrok.com/tunnel_sessions/ts_2rcCtCgTW2lK3bVKaPBCB88Nm38" - } -} -``` diff --git a/docs/api/examples/_tunnels_list_request.md b/docs/api/examples/_tunnels_list_request.md deleted file mode 100644 index a1b2cf4afa..0000000000 --- a/docs/api/examples/_tunnels_list_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/tunnels -``` diff --git a/docs/api/examples/_tunnels_list_response.md b/docs/api/examples/_tunnels_list_response.md deleted file mode 100644 index 191d491472..0000000000 --- a/docs/api/examples/_tunnels_list_response.md +++ /dev/null @@ -1,42 +0,0 @@ - - -#### Example Response - -```json -{ - "next_page_uri": null, - "tunnels": [ - { - "endpoint": { - "id": "ep_2rcCtOidtgIIdOxWw45YFeCF6Fw", - "uri": "https://api.ngrok.com/endpoints/ep_2rcCtOidtgIIdOxWw45YFeCF6Fw" - }, - "forwards_to": "http://localhost:80", - "id": "tn_2rcCtOidtgIIdOxWw45YFeCF6Fw", - "proto": "https", - "public_url": "https://249e96dce152.ngrok.paid", - "region": "us", - "started_at": "2025-01-14T10:06:29Z", - "tunnel_session": { - "id": "ts_2rcCtCgTW2lK3bVKaPBCB88Nm38", - "uri": "https://api.ngrok.com/tunnel_sessions/ts_2rcCtCgTW2lK3bVKaPBCB88Nm38" - } - }, - { - "forwards_to": "http://localhost:80", - "id": "tn_2rcCss3frBug9CSU0TcsKJxYNwd", - "labels": { - "baz": "qux", - "foo": "bar" - }, - "region": "us", - "started_at": "2025-01-14T10:06:25Z", - "tunnel_session": { - "id": "ts_2rcCssYH2LhLwCglC5aScUB91aT", - "uri": "https://api.ngrok.com/tunnel_sessions/ts_2rcCssYH2LhLwCglC5aScUB91aT" - } - } - ], - "uri": "https://api.ngrok.com/tunnels" -} -``` diff --git a/docs/api/examples/_weighted_backends_create_request.md b/docs/api/examples/_weighted_backends_create_request.md deleted file mode 100644 index a79fcf037f..0000000000 --- a/docs/api/examples/_weighted_backends_create_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X POST \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"backends":{"bkdhr_2rcCv42M49sznEmtykY1uXBWIvq":1,"bkdhr_2rcCv6vGnWzvPWGryyNzP5CE4SI":0},"description":"acme weighted","metadata":"{\"environment\": \"staging\"}"}' \ -https://api.ngrok.com/backends/weighted -``` diff --git a/docs/api/examples/_weighted_backends_create_response.md b/docs/api/examples/_weighted_backends_create_response.md deleted file mode 100644 index 43e536822a..0000000000 --- a/docs/api/examples/_weighted_backends_create_response.md +++ /dev/null @@ -1,17 +0,0 @@ - - -#### Example Response - -```json -{ - "backends": { - "bkdhr_2rcCv42M49sznEmtykY1uXBWIvq": 1, - "bkdhr_2rcCv6vGnWzvPWGryyNzP5CE4SI": 0 - }, - "created_at": "2025-01-14T10:06:43Z", - "description": "acme weighted", - "id": "bkdwd_2rcCv6ft3MEVEppz9xOmdXdLTty", - "metadata": "{\"environment\": \"staging\"}", - "uri": "https://api.ngrok.com/backends/weighted/bkdwd_2rcCv6ft3MEVEppz9xOmdXdLTty" -} -``` diff --git a/docs/api/examples/_weighted_backends_delete_request.md b/docs/api/examples/_weighted_backends_delete_request.md deleted file mode 100644 index 84e3d86859..0000000000 --- a/docs/api/examples/_weighted_backends_delete_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X DELETE \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/backends/weighted/bkdwd_2rcCv6ft3MEVEppz9xOmdXdLTty -``` diff --git a/docs/api/examples/_weighted_backends_delete_response.md b/docs/api/examples/_weighted_backends_delete_response.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/api/examples/_weighted_backends_get_request.md b/docs/api/examples/_weighted_backends_get_request.md deleted file mode 100644 index ac569bf121..0000000000 --- a/docs/api/examples/_weighted_backends_get_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/backends/weighted/bkdwd_2rcCv6ft3MEVEppz9xOmdXdLTty -``` diff --git a/docs/api/examples/_weighted_backends_get_response.md b/docs/api/examples/_weighted_backends_get_response.md deleted file mode 100644 index 43e536822a..0000000000 --- a/docs/api/examples/_weighted_backends_get_response.md +++ /dev/null @@ -1,17 +0,0 @@ - - -#### Example Response - -```json -{ - "backends": { - "bkdhr_2rcCv42M49sznEmtykY1uXBWIvq": 1, - "bkdhr_2rcCv6vGnWzvPWGryyNzP5CE4SI": 0 - }, - "created_at": "2025-01-14T10:06:43Z", - "description": "acme weighted", - "id": "bkdwd_2rcCv6ft3MEVEppz9xOmdXdLTty", - "metadata": "{\"environment\": \"staging\"}", - "uri": "https://api.ngrok.com/backends/weighted/bkdwd_2rcCv6ft3MEVEppz9xOmdXdLTty" -} -``` diff --git a/docs/api/examples/_weighted_backends_list_request.md b/docs/api/examples/_weighted_backends_list_request.md deleted file mode 100644 index a1cca9cfe5..0000000000 --- a/docs/api/examples/_weighted_backends_list_request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X GET \ --H "Authorization: Bearer {API_KEY}" \ --H "Ngrok-Version: 2" \ -https://api.ngrok.com/backends/weighted -``` diff --git a/docs/api/examples/_weighted_backends_list_response.md b/docs/api/examples/_weighted_backends_list_response.md deleted file mode 100644 index a8cbf90fe7..0000000000 --- a/docs/api/examples/_weighted_backends_list_response.md +++ /dev/null @@ -1,23 +0,0 @@ - - -#### Example Response - -```json -{ - "backends": [ - { - "backends": { - "bkdhr_2rcCv42M49sznEmtykY1uXBWIvq": 1, - "bkdhr_2rcCv6vGnWzvPWGryyNzP5CE4SI": 0 - }, - "created_at": "2025-01-14T10:06:43Z", - "description": "acme weighted", - "id": "bkdwd_2rcCv6ft3MEVEppz9xOmdXdLTty", - "metadata": "{\"environment\": \"staging\"}", - "uri": "https://api.ngrok.com/backends/weighted/bkdwd_2rcCv6ft3MEVEppz9xOmdXdLTty" - } - ], - "next_page_uri": null, - "uri": "https://api.ngrok.com/backends/weighted" -} -``` diff --git a/docs/api/examples/_weighted_backends_update_request.md b/docs/api/examples/_weighted_backends_update_request.md deleted file mode 100644 index 654f9e034e..0000000000 --- a/docs/api/examples/_weighted_backends_update_request.md +++ /dev/null @@ -1,13 +0,0 @@ - - -#### Example Request - -```bash -curl \ --X PATCH \ --H "Authorization: Bearer {API_KEY}" \ --H "Content-Type: application/json" \ --H "Ngrok-Version: 2" \ --d '{"metadata":"{\"environment\": \"production\"}"}' \ -https://api.ngrok.com/backends/weighted/bkdwd_2rcCv6ft3MEVEppz9xOmdXdLTty -``` diff --git a/docs/api/examples/_weighted_backends_update_response.md b/docs/api/examples/_weighted_backends_update_response.md deleted file mode 100644 index c22cd3ce6c..0000000000 --- a/docs/api/examples/_weighted_backends_update_response.md +++ /dev/null @@ -1,14 +0,0 @@ - - -#### Example Response - -```json -{ - "backends": {}, - "created_at": "2025-01-14T10:06:43Z", - "description": "acme weighted", - "id": "bkdwd_2rcCv6ft3MEVEppz9xOmdXdLTty", - "metadata": "{\"environment\": \"production\"}", - "uri": "https://api.ngrok.com/backends/weighted/bkdwd_2rcCv6ft3MEVEppz9xOmdXdLTty" -} -```