Yext Knowledge API icon

Yext Knowledge API

Interact with Yext Knowledge API

Actions176

Health Check → Health Check

AI-generated

Summary

Execute a health check request against the Yext Knowledge API to verify service availability and connectivity.

Inputs

  • Request Options — Optional settings to customize the request behavior, including batching (items per batch and batch interval in milliseconds), whether to ignore SSL certificate validation errors, proxy URL for routing the request, and request timeout in milliseconds.

Output shape

a single JSON object containing the health check response from the Yext Knowledge API

The response typically includes status information indicating the API health; no pagination or batch outputs are applicable for this operation.

Discussion