Keitaro icon

Keitaro

Работа с API Keitaro

Overview

This node interacts with the Keitaro API to perform various operations on different resources, including the 'blacklist' resource. Specifically, for the 'blacklist' resource and the 'get' operation, it retrieves information about a specific blacklist entry by its ID. This is useful for scenarios where you need to fetch details of a particular blacklist record from Keitaro, such as for monitoring or managing blacklisted entities.

Use Case Examples

  1. Retrieve details of a blacklist entry by providing its ID to check if a certain IP or user is blacklisted.
  2. Use the node to fetch blacklist information as part of an automated workflow to handle traffic filtering or user management.

Properties

Name Meaning
ID Блэклиста The unique identifier of the blacklist entry to retrieve.

Output

JSON

  • request
    • url - The URL of the API request made to Keitaro.
    • method - The HTTP method used for the API request.
    • headers - Headers sent with the API request, with the API key masked.
  • resource - The resource type involved in the operation, e.g., 'blacklist'.
  • operation - The operation performed, e.g., 'get'.
  • data - The data returned from the Keitaro API for the requested blacklist entry.
  • success - Indicates if the operation was successful (true for successful operations).
  • error - Indicates if there was an error during the operation (true if an error occurred).

Dependencies

  • Requires an API key credential for Keitaro API access and the domain URL of the Keitaro instance.

Troubleshooting

  • Ensure the 'blacklistId' parameter is provided and valid; missing or invalid IDs will cause errors.
  • Verify that the API key and domain are correctly set in the credentials; missing credentials will prevent API access.
  • Check the API response for error messages indicating issues such as invalid permissions or resource not found.
  • If the node throws an error about unsupported operations for the 'stats' resource, ensure only the 'getAll' operation is used for 'stats'.
  • For network or connectivity issues, verify that the Keitaro domain is reachable and the API key is active.

Links

  • Keitaro API Documentation - Official documentation for the Keitaro API, useful for understanding available endpoints and data structures.

Discussion