{"id":37235693,"url":"https://github.com/sandwave-io/freenas-php","last_synced_at":"2026-01-16T04:51:15.564Z","repository":{"id":57047878,"uuid":"276683919","full_name":"sandwave-io/freenas-php","owner":"sandwave-io","description":"A PHP SDK for the FreeNAS v2 REST API","archived":false,"fork":false,"pushed_at":"2023-03-13T10:11:59.000Z","size":75,"stargazers_count":7,"open_issues_count":0,"forks_count":0,"subscribers_count":12,"default_branch":"master","last_synced_at":"2025-07-14T16:43:48.533Z","etag":null,"topics":["freenas","freenas-api","php","php-sdk","sdk"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sandwave-io.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-07-02T15:36:07.000Z","updated_at":"2024-03-25T14:54:31.000Z","dependencies_parsed_at":"2022-08-23T18:50:59.492Z","dependency_job_id":null,"html_url":"https://github.com/sandwave-io/freenas-php","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"purl":"pkg:github/sandwave-io/freenas-php","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sandwave-io%2Ffreenas-php","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sandwave-io%2Ffreenas-php/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sandwave-io%2Ffreenas-php/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sandwave-io%2Ffreenas-php/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sandwave-io","download_url":"https://codeload.github.com/sandwave-io/freenas-php/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sandwave-io%2Ffreenas-php/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28420801,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-14T10:47:48.104Z","status":"ssl_error","status_checked_at":"2026-01-14T10:46:19.031Z","response_time":107,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["freenas","freenas-api","php","php-sdk","sdk"],"created_at":"2026-01-15T04:04:04.728Z","updated_at":"2026-01-15T04:04:05.376Z","avatar_url":"https://github.com/sandwave-io.png","language":"PHP","readme":"[![](https://user-images.githubusercontent.com/60096509/91668964-54ecd500-eb11-11ea-9c35-e8f0b20b277a.png)](https://sandwave.io)\n\n# FreeNAS RESTful API (v2) - PHP SDK\n\n![Codecov](https://img.shields.io/codecov/c/github/sandwave-io/freenas-php?style=flat-square)\n![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/sandwave-io/freenas-php/ci.yml?branch=main)\n![Packagist PHP Version Support](https://img.shields.io/packagist/php-v/sandwave-io/freenas?style=flat-square)\n![Packagist PHP Version Support](https://img.shields.io/packagist/v/sandwave-io/freenas?style=flat-square)\n![Packagist Downloads](https://img.shields.io/packagist/dt/sandwave-io/freenas?style=flat-square)\n\nThis package is built upon the v2.0 of the FreeNAS API.\n* [FreeNAS API v2.0 REST documentation](https://api.ixsystems.com/freenas/)\n\n\n## How to use\n\n```bash\ncomposer require sandwave-io/freenas-php\n```\n\n```php\n$freenas = new \\SandwaveIo\\FreeNAS\\RestClient(\n    'https://my-freenas-install.io/api/v2.0/', // base url\n    'root',                  // user\n    'SuperSecretPassword123' // password\n);\n\n// This example shows how to create a dataset, and a user that has access rights to that dataset.\n\n$dataset = $freenas-\u003ecreateDataset(\n    'store01',    // pool\n    'my-dataset', // dataset\n    20 * 1024**3  // size in bytes\n);\n\n$user = $freenas-\u003ecreateUser(\n    1001,                        // uid\n    'my-user',                   // username\n    $dataset-\u003egetMountPoint(),   // homedir\n    'SuperSecretUserPassword123' // password\n);\n```\n\n\n## How to contribute\n\nFeel free to create a PR if you have any ideas for improvements. Or create an issue.\n\n* When adding code, make sure to add tests for it (phpunit).\n* Make sure the code adheres to our coding standards (use php-cs-fixer to check/fix). \n* Also make sure PHPStan does not find any bugs.\n\n```bash\n\nvendor/bin/php-cs-fixer fix\n\nvendor/bin/phpstan analyze\n\nvendor/bin/phpunit --coverage-text\n\n```\n\nThese tools will also run in GitHub actions on PR's and pushes on master.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsandwave-io%2Ffreenas-php","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsandwave-io%2Ffreenas-php","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsandwave-io%2Ffreenas-php/lists"}