PhpIPAM Create

PhpIPAM Create

Certified

Create a phpIPAM address

Registers a new IP address in the specified subnet.

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

Create an address

yaml
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

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.

IP address

The IPv4 or IPv6 address to register, e.g. 192.168.1.100.

Subnet ID

Numeric ID of the subnet the address belongs to.

Hostname

Optional hostname to associate with the address.

Defaultfalse

Disable TLS certificate validation

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

Owner

Optional owner name for this address.

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

Description

Optional description of the address.

Created address ID

Numeric ID of the newly created address record.