hosterra/netbox

NetBox PHP

Maintainers

Details

hosterra.dev/Hosterra/netbox-php.git

Installs: 10

Dependents: 0

Suggesters: 0

Security: 0

3.1.4 2024-03-30 14:17 UTC

Requires

MIT bf928b746a8e5d1c32b5c8ef51730edb47fc1a0d

netbox

This package is auto-updated.

Last update: 2024-10-30 15:48:14 UTC

README

netbox php license

NetBox PHP

A PHP "SDK" to use NetBox APIs.

>Note: this package is a fork of the Christian Bönning NetBox PHP package wich is itself a fork of the Wicked Software Corp. "Laravel NetBox" package; original credits go to them.

Installation

composer require hosterra/netbox-php

Environment Variables

The package requires 2 environment variables being set accessible through getenv()

VariableTypeDefaultDescription
NETBOX_APIstring""the NetBox API Endpoint (e.g. http://localhost:8080/api)
NETBOX_API_KEYstring""The NetBox API Key created from eg http://127.0.0.1:8080/user/api-tokens/

Example Usage

$api = new \Hosterra\NetBox\Api\IPAM\IpAddresses(new \Hosterra\NetBox\Client());
$result = $api->add([
    'address'  => '11.22.33.44/32',
    'dns_name' => 'foo.example.com'
]);

$result = $api->list(['address' => '11.22.33.44/32'])

Supported NetBox APIs