verifyDomainProxyWithHttpInfo method

Future<Response> verifyDomainProxyWithHttpInfo({
  1. VerifyDomainProxyRequest? verifyDomainProxyRequest,
})

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.

Note: This method returns the HTTP Response.

Parameters:

Implementation

Future<http.Response> verifyDomainProxyWithHttpInfo({
  VerifyDomainProxyRequest? verifyDomainProxyRequest,
}) async {
  // ignore: prefer_const_declarations
  final path = r'/proxy_checks';

  // ignore: prefer_final_locals
  Object? postBody = verifyDomainProxyRequest;

  final queryParams = <QueryParam>[];
  final headerParams = <String, String>{};
  final formParams = <String, String>{};

  const contentTypes = <String>['application/json'];

  return apiClient.invokeAPI(
    path,
    'POST',
    queryParams,
    postBody,
    headerParams,
    formParams,
    contentTypes.isEmpty ? null : contentTypes.first,
  );
}