Hosterra/netbox-php
Hosterra/netbox-php
1
0
Fork 0
Code Issues Pull requests Releases 5 Packages Activity
NetBox API client for PHP
82 commits 1 branch 31 tags 215 KiB
  • PHP 100%
Find a file
Exact
Pierre Lannoy bf928b746a
 Bump version for packagist auto-update.
2024-03-30 15:17:27 +01:00
src Bump version for packagist auto-update. 2024-03-30 15:17:27 +01:00
.gitignore Initial commit 2024-02-12 10:46:19 +01:00
composer.json Fixes PSR-4 namespace 2024-02-12 12:25:25 +01:00
LICENSE.md Initial commit 2024-02-12 10:46:19 +01:00
README.md Adds badges 2024-02-12 14:23:54 +01:00

README.md

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()

Variable Type Default Description
NETBOX_API string "" the NetBox API Endpoint (e.g. http://localhost:8080/api)
NETBOX_API_KEY string "" 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