PhpIPAM Create

PhpIPAM Create

Certified

Create a phpIPAM section

Creates a new section in phpIPAM.

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

Create a section

yaml
id: phpipam_section_create
namespace: company.team
tasks:
  - id: create_section
    type: io.kestra.plugin.phpipam.ipam.section.Create
    baseUrl: "https://ipam.example.com"
    appId: myapp
    auth:
      appToken: "{{ secret('PHPIPAM_APP_TOKEN') }}"
    name: "Production"
    description: "Production network section"
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.

Section name

Unique name for the new section.

Defaultfalse

Disable TLS certificate validation

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

Master section ID

ID of the parent section, if this is a sub-section.

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

Description

Optional description of the section.

Created section ID

The numeric ID of the newly created section.