Phpipam icon

Phpipam

Consume Phpipam API (v.0.4.1)

Overview

This node interacts with the Phpipam API to perform various operations related to IP address management. Specifically, for the 'Addresses' resource and 'Ping Address' operation, it sends a GET request to ping a specified IP address by its ID. This is useful for network administrators who want to verify the availability or status of an IP address within their Phpipam-managed network. For example, it can be used to check if a device at a given IP address is reachable.

Use Case Examples

  1. Ping an IP address by providing its Address Id to check network connectivity.
  2. Retrieve information about an IP address or list all addresses in the Phpipam system.

Properties

Name Meaning
Address Id The unique identifier of the IP address to be pinged. This is a required string input.

Output

JSON

  • success - Indicates if the API request was successful.
  • data - Contains the response data from the ping operation, typically details about the ping result.

Dependencies

  • Requires Phpipam API credentials including URL, app ID, user, and password for authentication.

Troubleshooting

  • Common issues include missing or incorrect API credentials, resulting in authentication errors.
  • Invalid or non-existent Address Id may cause the API to return errors or empty results.
  • Network issues or incorrect Phpipam URL can lead to connection timeouts or failures.

Links

Discussion