PhpIPAM FirstFree

PhpIPAM FirstFree

Certified

Get the first free IP address in a subnet

Returns the first unallocated IP address within the given subnet. Raises an error if the subnet is full. Combine with Create to atomically reserve the next available address.

yaml
type: io.kestra.plugin.phpipam.ipam.address.FirstFree

Get first free address

yaml
id: phpipam_address_first_free
namespace: company.team
tasks:
  - id: first_free
    type: io.kestra.plugin.phpipam.ipam.address.FirstFree
    baseUrl: "https://ipam.example.com"
    appId: myapp
    auth:
      appToken: "{{ secret('PHPIPAM_APP_TOKEN') }}"
    subnetId: "10"
Properties

Application ID

The API application identifier configured in phpIPAM under Administration → API. It appears in the path segment /api/{appId}/.

Authentication

Provide either appToken for static App-token authentication, or username + password to obtain a per-run session token. Supplying both, or neither, raises a validation error.

Definitions
appTokenstring

Static App token

A token generated in the phpIPAM administration panel under Administration → API. Sent to phpIPAM via the token request header. Mutually exclusive with username / password.

passwordstring

Password

Password for the phpIPAM user. Must be provided together with username.

usernamestring

Username

phpIPAM username used to obtain a per-session token via POST /api/{appId}/user/. Must be provided together with password. Mutually exclusive with appToken.

Base URL of the phpIPAM instance

Root URL of the phpIPAM instance, e.g. https://ipam.example.com. No trailing slash needed.

Subnet ID

Numeric ID of the subnet from which the first free IP address is requested.

Defaultfalse

Disable TLS certificate validation

Set to true to trust all TLS certificates, including self-signed ones. Intended for development or internal deployments only.

Reference (ref) of the pluginDefaults to apply to this task.

First free IP

The first unallocated IP address in the subnet.

More Plugins in this Category

NetBox (EE)
NetBox
Enterprise

Enterprise NetBox tasks to create, update, and query devices, IP addresses, and sites over the NetBox API.

Infrastructure

7 tasks

4 blueprints

AS400
AS400

Tasks that connect to AS400 via JDBC to run queries and loads.

DataInfrastructure

3 tasks