Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Netbox API Client

This project is an API client for [Netbox](https://netbox.dev/)

## To iterate over your netbox entities

```php
<?php

use ND\Netbox\Client;

$netbox = new Client("https://your-netbox/", "your-api-key");

foreach ($netbox->getSites() as $site) {
echo $site["name"]."\n";
}
```

Read entities attribues as an associative array

## Retrieve an entity

```php
<?php

$site = $netbox->getSite(42);
```

## To update an entity

after retrieve

```php
$site['comments'] = "This is a test";
$site->save();
```
Loading