Actions778
- Acl Role Actions
- App Actions
- App Action Button Actions
- App Administration Snippet Actions
- App Cms Block Actions
- App Flow Action Actions
- App Flow Event Actions
- App Payment Method Actions
- App Script Condition Actions
- App Shipping Method Actions
- App Template Actions
- Category Actions
- Cms Block Actions
- Cms Page Actions
- Cms Section Actions
- Cms Slot Actions
- Country Actions
- Country State Actions
- Currency Actions
- Currency Country Rounding Actions
- Custom Entity Actions
- Custom Field Actions
- Custom Field Set Actions
- Custom Field Set Relation Actions
- Customer Actions
- Customer Address Actions
- Customer Group Actions
- Customer Recovery Actions
- Customer Wishlist Actions
- Customer Wishlist Product Actions
- Delivery Time Actions
- Document Actions
- Document Base Config Actions
- Document Base Config Sales Channel Actions
- Document Type Actions
- Flow Actions
- Flow Sequence Actions
- Flow Template Actions
- Import Export File Actions
- Import Export Log Actions
- Import Export Profile Actions
- Integration Actions
- Landing Page Actions
- Language Actions
- Locale Actions
- Log Entry Actions
- Mail Header Footer Actions
- Mail Template Actions
- Mail Template Type Actions
- Main Category Actions
- Media Actions
- Media Default Folder Actions
- Media Folder Actions
- Media Folder Configuration Actions
- Media Thumbnail Actions
- Media Thumbnail Size Actions
- Newsletter Recipient Actions
- Notification Actions
- Number Range Actions
- Number Range Sales Channel Actions
- Number Range State Actions
- Number Range Type Actions
- Order Actions
- Order Customer Actions
- Order Delivery Actions
- Order Delivery Position Actions
- Order Line Item Actions
- Order Line Item Download Actions
- Order Transaction Actions
- Order Transaction Capture Actions
- Order Transaction Capture Refund Actions
- Order Transaction Capture Refund Position Actions
- Payment Method Actions
- Plugin Actions
- Product Actions
- Product Configurator Setting Actions
- Product Cross Selling Actions
- Product Cross Selling Assigned Products Actions
- Product Download Actions
- Product Export Actions
- Product Feature Set Actions
- Product Keyword Dictionary Actions
- Product Manufacturer Actions
- Product Media Actions
- Product Price Actions
- Product Review Actions
- Product Search Config Actions
- Product Search Config Field Actions
- Product Search Keyword Actions
- Product Sorting Actions
- Product Stream Actions
- Product Stream Filter Actions
- Product Visibility Actions
- Promotion Actions
- Promotion Discount Actions
- Promotion Discount Prices Actions
- Promotion Individual Code Actions
- Promotion Sales Channel Actions
- Promotion Setgroup Actions
- Property Group Actions
- Property Group Option Actions
- Rule Actions
- Rule Condition Actions
- Sales Channel Actions
- Sales Channel Analytics Actions
- Sales Channel Domain Actions
- Sales Channel Type Actions
- Salutation Actions
- Scheduled Task Actions
- State Machine Transition Actions
- System Config Actions
- Tag Actions
- Tax Actions
- Tax Provider Actions
- Tax Rule Actions
- Tax Rule Type Actions
- Theme Actions
- Unit Actions
- User Actions
- User Access Key Actions
- User Config Actions
- User Recovery Actions
- Webhook Actions
- Webhook Event Log Actions
- System Info Health Check Actions
- Bulk Operations Actions
- Document Management Actions
- Asset Management Actions
- Mail Operations Actions
- System Operations Actions
- Customer Impersonation Actions
- Order Management Actions
- Order Address Actions
- Authorization Authentication Actions
System Info Health Check → Api Info
AI-generatedOverview
This node performs a system information health check by making an API call to retrieve API information. It supports specifying the type of API response expected (either 'jsonapi' or 'json') and allows customization of request options such as batching, SSL certificate validation, proxy usage, and request timeout. This node is useful for monitoring and verifying the health and status of an API endpoint, ensuring it is responsive and returning expected data.
Use Case Examples
- Checking the health status of a system API by requesting its info in JSON API format.
- Using the node to fetch API info with custom request options like proxy and timeout to handle network configurations.
Properties
| Name | Meaning |
|---|---|
| Type | Specifies the type of the API response expected, either 'jsonapi' or 'json'. |
| Request Options | Collection of optional settings to customize the API request, including batching, SSL certificate validation, proxy, and timeout. |
Output
JSON
apiInfo- The JSON response containing the API information retrieved from the system health check.
Dependencies
- An API key credential for authenticating with the target system's API.
Troubleshooting
- Ensure the API endpoint URL is correctly configured in the node credentials to avoid connection errors.
- If SSL certificate validation fails and the node is set to reject unauthorized certificates, enable the 'Ignore SSL Issues' option to bypass this check (use with caution).
- Check proxy settings if the node cannot connect to the API due to network restrictions.
- Adjust the timeout setting if the API server is slow to respond to prevent premature request abortion.