PHPackages                             sandwave-io/freenas - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. sandwave-io/freenas

AbandonedArchivedLibrary[API Development](/categories/api)

sandwave-io/freenas
===================

A PHP SDK for the FreeNAS RESTful API (v2)

1.0.0(5y ago)7153MITPHPPHP ^7.1

Since Jul 3Pushed 3y ago12 watchersCompare

[ Source](https://github.com/sandwave-io/freenas-php)[ Packagist](https://packagist.org/packages/sandwave-io/freenas)[ RSS](/packages/sandwave-io-freenas/feed)WikiDiscussions master Synced today

READMEChangelogDependencies (5)Versions (10)Used By (0)

[![](https://user-images.githubusercontent.com/60096509/91668964-54ecd500-eb11-11ea-9c35-e8f0b20b277a.png)](https://sandwave.io)

FreeNAS RESTful API (v2) - PHP SDK
==================================

[](#freenas-restful-api-v2---php-sdk)

[![Codecov](https://camo.githubusercontent.com/34677e01c1cd6a7a9fb30278c2cb07a11233af4afdab04be698a890d4376442d/68747470733a2f2f696d672e736869656c64732e696f2f636f6465636f762f632f6769746875622f73616e64776176652d696f2f667265656e61732d7068703f7374796c653d666c61742d737175617265)](https://camo.githubusercontent.com/34677e01c1cd6a7a9fb30278c2cb07a11233af4afdab04be698a890d4376442d/68747470733a2f2f696d672e736869656c64732e696f2f636f6465636f762f632f6769746875622f73616e64776176652d696f2f667265656e61732d7068703f7374796c653d666c61742d737175617265)[![GitHub Workflow Status](https://camo.githubusercontent.com/4958e3144534c350989ffcf692e997e4ac397d234f92fc50cf58cade04410091/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f616374696f6e732f776f726b666c6f772f7374617475732f73616e64776176652d696f2f667265656e61732d7068702f63692e796d6c3f6272616e63683d6d61696e)](https://camo.githubusercontent.com/4958e3144534c350989ffcf692e997e4ac397d234f92fc50cf58cade04410091/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f616374696f6e732f776f726b666c6f772f7374617475732f73616e64776176652d696f2f667265656e61732d7068702f63692e796d6c3f6272616e63683d6d61696e)[![Packagist PHP Version Support](https://camo.githubusercontent.com/680253c381c0b8536662b2ae3220ed0b2573e41676a6bcd58a1e177899199ed7/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f7068702d762f73616e64776176652d696f2f667265656e61733f7374796c653d666c61742d737175617265)](https://camo.githubusercontent.com/680253c381c0b8536662b2ae3220ed0b2573e41676a6bcd58a1e177899199ed7/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f7068702d762f73616e64776176652d696f2f667265656e61733f7374796c653d666c61742d737175617265)[![Packagist PHP Version Support](https://camo.githubusercontent.com/59530a8902cb1862f440a93febd16b81c443e69fe65148b9f0e77dd3f712e729/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f73616e64776176652d696f2f667265656e61733f7374796c653d666c61742d737175617265)](https://camo.githubusercontent.com/59530a8902cb1862f440a93febd16b81c443e69fe65148b9f0e77dd3f712e729/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f73616e64776176652d696f2f667265656e61733f7374796c653d666c61742d737175617265)[![Packagist Downloads](https://camo.githubusercontent.com/3be660a67dd87c6525781936e5bbbd54da5af0296bb2fc958b67048f933bf8bf/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f73616e64776176652d696f2f667265656e61733f7374796c653d666c61742d737175617265)](https://camo.githubusercontent.com/3be660a67dd87c6525781936e5bbbd54da5af0296bb2fc958b67048f933bf8bf/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f73616e64776176652d696f2f667265656e61733f7374796c653d666c61742d737175617265)

This package is built upon the v2.0 of the FreeNAS API.

- [FreeNAS API v2.0 REST documentation](https://api.ixsystems.com/freenas/)

How to use
----------

[](#how-to-use)

```
composer require sandwave-io/freenas-php
```

```
$freenas = new \SandwaveIo\FreeNAS\RestClient(
    'https://my-freenas-install.io/api/v2.0/', // base url
    'root',                  // user
    'SuperSecretPassword123' // password
);

// This example shows how to create a dataset, and a user that has access rights to that dataset.

$dataset = $freenas->createDataset(
    'store01',    // pool
    'my-dataset', // dataset
    20 * 1024**3  // size in bytes
);

$user = $freenas->createUser(
    1001,                        // uid
    'my-user',                   // username
    $dataset->getMountPoint(),   // homedir
    'SuperSecretUserPassword123' // password
);
```

How to contribute
-----------------

[](#how-to-contribute)

Feel free to create a PR if you have any ideas for improvements. Or create an issue.

- When adding code, make sure to add tests for it (phpunit).
- Make sure the code adheres to our coding standards (use php-cs-fixer to check/fix).
- Also make sure PHPStan does not find any bugs.

```
vendor/bin/php-cs-fixer fix

vendor/bin/phpstan analyze

vendor/bin/phpunit --coverage-text
```

These tools will also run in GitHub actions on PR's and pushes on master.

###  Health Score

28

—

LowBetter than 54% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity15

Limited adoption so far

Community13

Small or concentrated contributor base

Maturity56

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 97% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~2 days

Total

9

Last Release

2120d ago

Major Versions

0.1.7 → 1.0.02020-07-21

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/16303480?v=4)[Jesse Kramer](/maintainers/FrontEndCoffee)[@FrontEndCoffee](https://github.com/FrontEndCoffee)

![](https://avatars.githubusercontent.com/u/13864206?v=4)[sandwave](/maintainers/sandwave)[@sandwave](https://github.com/sandwave)

---

Top Contributors

[![FrontEndCoffee](https://avatars.githubusercontent.com/u/16303480?v=4)](https://github.com/FrontEndCoffee "FrontEndCoffee (32 commits)")[![arnowest](https://avatars.githubusercontent.com/u/827502?v=4)](https://github.com/arnowest "arnowest (1 commits)")

---

Tags

freenasfreenas-apiphpphp-sdksdk

###  Code Quality

TestsPHPUnit

Static AnalysisPHPStan

Code StylePHP CS Fixer

Type Coverage Yes

### Embed Badge

![Health badge](/badges/sandwave-io-freenas/health.svg)

```
[![Health](https://phpackages.com/badges/sandwave-io-freenas/health.svg)](https://phpackages.com/packages/sandwave-io-freenas)
```

###  Alternatives

[tencentcloud/tencentcloud-sdk-php

TencentCloudApi php sdk

3731.2M42](/packages/tencentcloud-tencentcloud-sdk-php)[convertkit/convertkitapi

Kit PHP SDK for the Kit API

2167.1k1](/packages/convertkit-convertkitapi)[mapado/rest-client-sdk

Rest Client SDK for hydra API

1125.9k2](/packages/mapado-rest-client-sdk)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)