Ze da API icon

Ze da API

WhatsApp API powered by Ze da API - Send messages, manage groups, contacts and more

Actions137

Proxy → Get Health

AI-generated

Summary

Check proxy health

Inputs

  • requestOptions — Options for the request, including batching configuration such as batchSize and batchInterval.
  • allowUnauthorizedCerts — Whether to accept the response even if SSL certificate validation fails.
  • proxy — HTTP proxy URL to use, e.g. http://username:password@myproxy:3128.
  • timeout — Request timeout in milliseconds.

Output shape

a health status object

Typically returns a JSON object containing a 'status' field (e.g., 'ok' or 'healthy'); may include additional diagnostic fields; success responses are 200 OK, errors may return detailed error objects.

Examples

Example 1: Verify proxy connectivity with default settings

Leave requestOptions empty, do not set proxy, use default timeout of 10000 ms, and keep allowUnauthorizedCerts false.

Example 2: Perform a batch health check

Set requestOptions.batchSize to 10 and requestOptions.batchInterval to 2000, leave other fields at defaults.

Example 3: Ignore SSL certificate errors while checking health

Enable allowUnauthorizedCerts true, set a custom proxy if needed, and use default timeout.

Links

Discussion