Skip to content

Latest commit

 

History

History
79 lines (55 loc) · 2.66 KB

ProxyChecksApi.md

File metadata and controls

79 lines (55 loc) · 2.66 KB
Raw

ClerkBackend::ProxyChecksApi

All URIs are relative to https://api.clerk.com/v1

Method HTTP request Description
verify_domain_proxy POST /proxy_checks Verify the proxy configuration for your domain

verify_domain_proxy

verify_domain_proxy(opts)

Verify the proxy configuration for your domain

This endpoint can be used to validate that a proxy-enabled domain is operational. It tries to verify that the proxy URL provided in the parameters maps to a functional proxy that can reach the Clerk Frontend API. You can use this endpoint before you set a proxy URL for a domain. This way you can ensure that switching to proxy-based configuration will not lead to downtime for your instance. The proxy_url parameter allows for testing proxy configurations for domains that don't have a proxy URL yet, or operate on a different proxy URL than the one provided. It can also be used to re-validate a domain that is already configured to work with a proxy.

Examples

require 'time'
require 'clerk-sdk-ruby-backend'
# setup authorization
ClerkBackend.configure do |config|
  # Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = ClerkBackend::ProxyChecksApi.new
opts = {
  verify_domain_proxy_request: ClerkBackend::VerifyDomainProxyRequest.new # VerifyDomainProxyRequest | 
}

begin
  # Verify the proxy configuration for your domain
  result = api_instance.verify_domain_proxy(opts)
  p result
rescue ClerkBackend::ApiError => e
  puts "Error when calling ProxyChecksApi->verify_domain_proxy: #{e}"
end

Using the verify_domain_proxy_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> verify_domain_proxy_with_http_info(opts)

begin
  # Verify the proxy configuration for your domain
  data, status_code, headers = api_instance.verify_domain_proxy_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ProxyCheck>
rescue ClerkBackend::ApiError => e
  puts "Error when calling ProxyChecksApi->verify_domain_proxy_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
verify_domain_proxy_request VerifyDomainProxyRequest [optional]

Return type

ProxyCheck

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json