
PhpIPAM Create
CertifiedCreate a phpIPAM address
PhpIPAM Create
Create a phpIPAM address
Registers a new IP address in the specified subnet.
type: io.kestra.plugin.phpipam.ipam.address.CreateExamples
Create an address
id: phpipam_address_create
namespace: company.team
tasks:
- id: create_address
type: io.kestra.plugin.phpipam.ipam.address.Create
baseUrl: "https://ipam.example.com"
appId: myapp
auth:
appToken: "{{ secret('PHPIPAM_APP_TOKEN') }}"
subnetId: "10"
ip: "192.168.1.100"
hostname: "server01.example.com"
description: "Web server"
Properties
appId *Requiredstring
Application ID
The API application identifier configured in phpIPAM under Administration → API.
It appears in the path segment /api/{appId}/.
auth *RequiredNon-dynamic
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.
io.kestra.plugin.phpipam.PhpipamAuthentication
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.
Password
Password for the phpIPAM user. Must be provided together with username.
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.
baseUrl *Requiredstring
Base URL of the phpIPAM instance
Root URL of the phpIPAM instance, e.g. https://ipam.example.com. No trailing slash needed.
ip *Requiredstring
IP address
The IPv4 or IPv6 address to register, e.g. 192.168.1.100.
subnetId *Requiredstring
Subnet ID
Numeric ID of the subnet the address belongs to.
hostname string
Hostname
Optional hostname to associate with the address.
insecureTls booleanstring
falseDisable TLS certificate validation
Set to true to trust all TLS certificates, including self-signed ones.
Intended for development or internal deployments only.
owner string
Owner
Optional owner name for this address.
pluginDefaultsRef Non-dynamicstring
Reference (ref) of the pluginDefaults to apply to this task.
resourceDescription string
Description
Optional description of the address.
Outputs
id string
Created address ID
Numeric ID of the newly created address record.