PHPackages fernleafsystems/apiwrappers-serverpilot - 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. fernleafsystems/apiwrappers-serverpilot ActiveLibrary[API Development](/categories/api) fernleafsystems/apiwrappers-serverpilot ======================================= ServerPilot: the best way to run PHP websites. 2.0.2(5y ago)0210↑500%1MITPHPPHP >=7.4 Since Aug 7Pushed 5y agoCompare [ Source](https://github.com/FernleafSystems/apiwrappers-serverpilot)[ Packagist](https://packagist.org/packages/fernleafsystems/apiwrappers-serverpilot)[ Docs](https://serverpilot.io/)[ RSS](/packages/fernleafsystems-apiwrappers-serverpilot/feed)WikiDiscussions master Synced 1mo ago READMEChangelogDependenciesVersions (9)Used By (0) serverpilot-php =============== [](#serverpilot-php) [![Latest Stable Version](https://camo.githubusercontent.com/249d81e1f56e6a69f7b5989251eabc3ac5f6e375b52ea4bd4dca54917829a82a/68747470733a2f2f706f7365722e707567782e6f72672f64617665726f676572732f73657276657270696c6f742d7068702f762f737461626c652e737667)](https://packagist.org/packages/daverogers/serverpilot-php) [![Total Downloads](https://camo.githubusercontent.com/0d22ae6a0e2f077ce33e19023567b8658309bc3c83b7087185d2ac631c4352ab/68747470733a2f2f706f7365722e707567782e6f72672f64617665726f676572732f73657276657270696c6f742d7068702f646f776e6c6f6164732e737667)](https://packagist.org/packages/daverogers/serverpilot-php) [![License](https://camo.githubusercontent.com/56831cc104e4cff236c6109d1855f3e79ef9e3dbae3cf216af971057aac05c67/68747470733a2f2f706f7365722e707567782e6f72672f64617665726f676572732f73657276657270696c6f742d7068702f6c6963656e73652e737667)](https://packagist.org/packages/daverogers/serverpilot-php) This simple PHP API client binds to ServerPilot's RESTful [API](https://github.com/ServerPilot/API) that allows you to manage [ServerPilot](https://serverpilot.io) resources. All responses return JSON objects, including errors. Installation ------------ [](#installation) You can install the bindings via [Composer](http://getcomposer.org/). Add this to your `composer.json`: ``` { "require": { "daverogers/serverpilot-php": "1.*" } } ``` ...and then install ``` composer.phar install ``` Or you can include manually: ``` include_once('/path/to/this/lib/ServerPilot.php'); ``` Usage ----- [](#usage) **General** - [Connect](#connect) - [Catch errors](#catch-errors) - [Actions](#actions) **Servers** - [List all servers](#list-all-servers) - [Retrieve an existing server](#retrieve-an-existing-server) - [Connect a new server](#connect-a-new-server) - [Update an existing server](#update-an-existing-server) - [Remove an existing server](#remove-an-existing-server) **System users** - [List all system users](#list-all-system-users) - [Retrieve an existing system user](#retrieve-an-existing-system-user) - [Create a new system user](#create-a-new-system-user) - [Update an existing system user](#update-an-existing-system-user) - [Remove an existing system user](#remove-an-existing-system-user) **Apps** - [List all apps](#list-all-apps) - [Retrieve an existing app](#retrieve-an-existing-app) - [Create a new app](#create-a-new-app) - [Update an existing app](#update-an-existing-app) - [Remove an existing app](#remove-an-existing-app) **Databases** - [List all databases](#list-all-databases) - [Retrieve an existing database](#retrieve-an-existing-database) - [Create a new database](#create-a-new-database) - [Update an existing database](#update-an-existing-database) - [Remove an existing database](#remove-an-existing-database) **SSL** - [Add custom SSL to an app](#add-custom-ssl-to-an-app) - [Remove custom SSL from an app](#remove-custom-ssl-from-an-app) - [Enable AutoSSL for an app](#enable-autossl-for-an-app) - [Force HTTP to HTTPS redirect for an app](#force-ssl-redirect-for-an-app) ### Connect [](#connect) With your API `key` and `id` from ServerPilot, set up the config values and pass them to the ServerPilot class. You may alternatively include a `'decode' => false` config value if you just want the raw JSON-encoded value returned. ``` $config = array( 'id' => 'YOURID', 'key' => 'YOURKEY' ); $sp = new ServerPilot($config); ``` From there, you can call any number of functions to manage your ServerPilot servers, apps, system users, databases, etc. ### Catch errors [](#catch-errors) If there's a problem with any request a `ServerPilotException` is thrown. You can retrieve the error message with `getMessage()` and the actual HTTP code with `getCode()`. ``` try { $servers = $sp->server_list(); } catch(ServerPilotException $e) { echo $e->getCode() . ': ' .$e->getMessage(); } ``` ### Actions [](#actions) Actions are a record of work done on ServerPilot resources. These can be things like the creation of an App, deploying SSL, deleting an old Database, etc. All methods that modify a resource will return an `actionid` which can be used to track the status of said action. **Possible values of an action status** StatusDescription`open`Action has not completed yet.`success`Action was completed successfully.`error`Action has completed but there were errors.``` $sp->action_info('ACTIONID'); ``` ``` { "data": { "id": "g3kiiYzxPgAjbwcY", "serverid": "4zGDDO2xg30yEeum", "status": "success", "datecreated": 1403138066 } } ``` ### Servers [](#servers) #### List all servers [](#list-all-servers) ``` $servers = $sp->server_list(); ``` ``` { "data": [ { "id": "FqHWrrcUfRI18F0l", "name": "www1", "autoupdates": true, "firewall": true, "lastaddress": "1.2.3.4", "lastconn": 1403130552, "datecreated": 1403130551 }, { "id": "4zGDDO2xg30yEeum", "name": "vagrant", "autoupdates": true, "firewall": true, "lastaddress": "1.2.3.4", "lastconn": 1403130554, "datecreated": 1403130553 } ] } ``` #### Retrieve an existing server [](#retrieve-an-existing-server) ``` $server = $sp->server_info('SERVERID'); ``` ``` { "data": { "id": "UXOSIYrdtL4cSGp3", "name": "www2", "autoupdates": true, "firewall": true, "lastaddress": "1.2.3.4", "lastconn": 1403130554, "datecreated": 1403130553 } } ``` #### Connect a new server [](#connect-a-new-server) Use this method to tell ServerPilot that you plan to connect a new server. ``` $server = $sp->server_create('SERVERNAME'); ``` When the request goes through successfully you should get this returned: ``` { "actionid": "tW2fu4hjHnsix6Rn", "data": { "id": "`UXOSIYrdtL4cSGp3`", "name": "www2", "autoupdates": true, "firewall": true, "lastaddress": null, "lastconn": null, "datecreated": 1403130553, "apikey": "nqXUevYSkpW09YKy7CY7PdnL14Q1HIlAfniJZwzjqNQ" } } ``` With `data.id` and `data.apikey` you can run the serverpilot installer on the server you just registered. ``` $ export SERVERID=UXOSIYrdtL4cSGp3 $ export SERVERAPIKEY=nqXUevYSkpW09YKy7CY7PdnL14Q1HIlAfniJZwzjqNQ $ sudo apt-get update && sudo apt-get -y install wget ca-certificates && \ sudo wget -nv -O serverpilot-installer https://download.serverpilot.io/serverpilot-installer && \ sudo sh serverpilot-installer \ --server-id=$SERVERID \ --server-apikey=$SERVERAPIKEY ``` #### Update an existing server [](#update-an-existing-server) There are 2 options you can change on each server; firewall and auto updates. Both of these options are `booleans` (if you don't want to change an option you can define it as `null`. ``` $response = $sp->server_update('SERVERID', 'FIREWALL':bool, 'AUTOUPDATES':bool); ``` ``` { "data": { "id": "UXOSIYrdtL4cSGp3", "name": "www2", "autoupdates": true, "firewall": true, "lastaddress": "1.2.3.4", "lastconn": 1403130554, "datecreated": 1403130553 } } ``` #### Remove an existing server [](#remove-an-existing-server) ``` $response = $sp->server_delete('SERVERID'); ``` ``` { "data": {} } ``` ### System users [](#system-users) #### List all system users [](#list-all-system-users) ``` $systemUsers = $sp->sysuser_list(); ``` ``` { "data": [ { "id": "PdmHhsb3fnaZ2r5f", "name": "serverpilot", "serverid": "FqHWrrcUfRI18F0l" }, { "id": "RvnwAIfuENyjUVnl", "name": "serverpilot", "serverid": "4zGDDO2xg30yEeum" } ] } ``` #### Retrieve an existing system user [](#retrieve-an-existing-system-user) ``` $systemUser = $sp->sysuser_info('SERVERID'); ``` ``` { "data": { "id": "PPkfc1NECzvwiEBI", "name": "derek", "serverid": "FqHWrrcUfRI18F0l" } } ``` #### Create a new system user [](#create-a-new-system-user) **Parameters** NameTypeDescription`serverid``string`**Required**. The id of the Server.`name``string`**Required**. The name of the System User. Length must be between 3 and 32 characters. Characters can be of lowercase ascii letters, digits, or a dash ('abcdefghijklmnopqrstuvwxyz0123456789-'), but must start with a lowercase ascii letter. `user-32` is a valid name, while `3po` is not.`password``string`The password of the System User. If user has no password, they will not be able to log in with a password. No leading or trailing whitespace is allowed and the password must be at least 8 and no more than 200 characters long.``` $systemUser = $sp->sysuser_create('SERVERID', 'NAME', 'PASSWORD'); ``` When the request goes through successfully you should get this returned: ``` { "actionid": "nnpgQoNzSK11fuTe", "data": { "id": "PPkfc1NECzvwiEBI", "name": "derek", "serverid": "FqHWrrcUfRI18F0l" } } ``` #### Update an existing system user [](#update-an-existing-system-user) **Parameters** NameTypeDescription`sysuserid``string`**Required**. The id of the System User.`password``string`The password of the System User. If user has no password, they will not be able to log in with a password. No leading or trailing whitespace is allowed and the password must be at least 8 and no more than 200 characters long.Every parameter except for app id is optional (meaning that by providing `null` nothing will be changed). ``` $response = $sp->sysuser_update('SERVERID', 'PASSWORD'); ``` ``` { "actionid": "OF42xCWkKcaX3qG2", "data": { "id": "RvnwAIfuENyjUVnl", "name": "serverpilot", "serverid": "4zGDDO2xg30yEeum" } } ``` #### Remove an existing system user [](#remove-an-existing-system-user) ``` $response = $sp->sysuser_delete('SYSUSERID'); ``` ``` { "actionid": "9tvygrrXZulYuizz", "data": {} } ``` ### Apps [](#apps) #### List all apps [](#list-all-apps) ``` $apps = $sp->app_list(); ``` ``` { "data": [ { "id": "c77JD4gZooGjrF8K", "datecreated": 1403139066, "name": "blog", "sysuserid": "RvnwAIfuENyjUVnl", "domains": ["www.myblog.com", "blog.com"], "ssl": null, "serverid": "4zGDDO2xg30yEeum", "runtime": "php7.0" }, { "id": "B1w7yc1tfUPQLIKS", "datecreated": 1403143012, "name": "store", "sysuserid": "RvnwAIfuENyjUVnl", "domains": ["www.mystore.com", "mystore.com"], "ssl": { "key": "-----BEGIN PRIVATE KEY----- ...", "cert": "-----BEGIN CERTIFICATE----- ...", "cacerts": "-----BEGIN CERTIFICATE----- ...", "auto": false, "force": false }, "serverid": "4zGDDO2xg30yEeum", "runtime": "php7.0" } ] } ``` #### Retrieve an existing app [](#retrieve-an-existing-app) ``` $app = $sp->app_info('APPID'); ``` ``` { "data": { "id": "UXOSIYrdtL4cSGp3", "name": "www2", "autoupdates": true, "firewall": true, "lastaddress": "1.2.3.4", "lastconn": 1403130554, "datecreated": 1403130553 } } ``` #### Create a new app [](#create-a-new-app) **Parameters** NameTypeDescription`name``string`**Required**. The nickname of the App. Length must be between 3 and 30 characters. Characters can be of lowercase ascii letters and digits.`sysuserid``string`**Required**. The System User that will "own" this App. Since every System User is specific to a Server, this implicitly determines on which Server the App will be created.`runtime``string`**Required**. The PHP runtime for an App. Choose from `php5.4`, `php5.5`, `php5.6`, `php7.0`, or `php7.1`.`domains``array`An array of domains that will be used in the webserver's configuration. If you set your app's domain name to *example.com*, Nginx and Apache will be configured to listen for both *example.com* and *[www.example.com](http://www.example.com)*. **Note**: The complete list of domains must be included in every update to this field.`wordpress``array`An array containing the following keys: ` site_title` , ` admin_user` , ` admin_password` , and ` admin_email```` $app = $sp->app_create('APPNAME', 'SYSUSERID', 'RUNTIME', 'DOMAINS', 'WORDPRESS'); ``` When the request goes through successfully you should get this returned: ``` { "actionid": "dIrCNoWunW92lPjw", "data": { "id": "nlcN0TwdZAyNEgdp", "datecreated": 1403143012, "name": "gallery", "sysuserid": "RvnwAIfuENyjUVnl", "domains": ["www.example.com", "example.com"], "ssl": null, "serverid": "4zGDDO2xg30yEeum", "runtime": "php7.0" } } ``` #### Update an existing app [](#update-an-existing-app) **Parameters** NameTypeDescription`runtime``string`The PHP runtime for an App. Choose from `php5.4`, `php5.5`, `php5.6`, `php7.0`, or `php7.1`.`domains``array`An array of domains that will be used in the webserver's configuration. If you set your app's domain name to *example.com*, Nginx and Apache will be configured to listen for both *example.com* and *[www.example.com](http://www.example.com)*. **Note**: The complete list of domains must be included in every update to this field.Every parameter except for app id is optional (meaning that by providing `null` nothing will be changed). ``` $response = $sp->app_update('APPID', 'RUNTIME', 'DOMAINS'); ``` ``` { "actionid": "KlsNzLikw3BRvShc", "data": { "id": "nlcN0TwdZAyNEgdp", "datecreated": 1403143012, "name": "gallery", "sysuserid": "RvnwAIfuENyjUVnl", "domains": ["www.example.com", "example.com"], "ssl": null, "serverid": "4zGDDO2xg30yEeum", "runtime": "php5.6" } } ``` #### Remove an existing app [](#remove-an-existing-app) ``` $response = $sp->app_delete('APPID'); ``` ``` { "actionid": "88Ypexhx28Y63eyA", "data": {} } ``` ### Databases [](#databases) #### List all databases [](#list-all-databases) ``` $databases = $sp->database_list(); ``` ``` { "data": [ { "id": "hdXkAZchuj27Hm1L", "name": "wordpress", "appid": "c77JD4gZooGjrF8K", "serverid": "4zGDDO2xg30yEeum", "user": { "id": "vt08Qz9kjOC3RVLr", "name": "robert" } } ] } ``` #### Retrieve an existing database [](#retrieve-an-existing-database) ``` $app = $sp->database_info('DBID'); ``` ``` { "data": { "id": "8PV1OIAlAW3jbGmM", "name": "gallerydb", "appid": "nlcN0TwdZAyNEgdp", "serverid": "4zGDDO2xg30yEeum", "user": { "id": "k2HWtU33mpUsfOdA", "name": "arturo" } } } ``` #### Create a new database [](#create-a-new-database) **Parameters** NameTypeDescription`appid``string`**Required**. The id of the App.`name``string`**Required**. The name of the database. Length must be between 3 and 64 characters. Characters can be of lowercase ascii letters, digits, or a dash ('abcdefghijklmnopqrstuvwxyz0123456789-').`username``string`**Required**. The name of the Database User. Length must be at most 16 characters.`password``string`**Required**. The password of the Database User. No leading or trailing whitespace is allowed and the password must be at least 8 and no more than 200 characters long.``` $app = $sp->database_create('APPID', 'NAME', 'USERNAME', 'PASSWORD'); ``` When the request goes through successfully you should get this returned: ``` { "actionid": "gPFiWP9hFNUxvT70", "data": { "id": "8PV1OIAlAW3jbGmM", "name": "gallerydb", "appid": "nlcN0TwdZAyNEgdp", "serverid": "4zGDDO2xg30yEeum", "user": { "id": "k2HWtU33mpUsfOdA", "name": "arturo" } } } ``` #### Update an existing database [](#update-an-existing-database) **Parameters** NameTypeDescription`appid``string`**Required**. The id of the App.`userid``string`**Required**. The id of the Database User.`password``string`**Required**. The *new* password of the Database User. No leading or trailing whitespace is allowed and the password must be at least 8 and no more than 200 characters long.Every parameter except for app id is optional (meaning that by providing `null` nothing will be changed). ``` $response = $sp->database_update('DBID', 'USERID', 'PASSWORD'); ``` ``` { "actionid": "VfH12ukDJFv0RZAO", "data": { "id": "8PV1OIAlAW3jbGmM", "name": "gallerydb", "appid": "nlcN0TwdZAyNEgdp", "serverid": "4zGDDO2xg30yEeum", "user": { "id": "k2HWtU33mpUsfOdA", "name": "arturo" } } } ``` #### Remove an existing database [](#remove-an-existing-database) ``` $response = $sp->database_delete('APPID'); ``` ``` { "actionid": "88Ypexhx28Y63eyA", "data": {} } ``` ### SSL [](#ssl) #### Add custom SSL to an app [](#add-custom-ssl-to-an-app) **Parameters** NameTypeDescription`appid``string`**Required**. The id of the App.`key``string`**Required**. The contents of the private key.`cert``string`**Required**. The contents of the certificate.`cacerts``string`The contents of the CA certificate(s). If none, null is acceptable.``` $ssl = $sp->ssl_add('APPID', 'KEY', 'CERT', 'CACERTS); ``` ``` { "actionid": "BzcMNZ9sdBY62vTd", "data": { "key": "-----BEGIN PRIVATE KEY----- ... -----END PRIVATE KEY-----", "cert": "-----BEGIN CERTIFICATE----- ... -----END CERTIFICATE-----", "cacerts": "-----BEGIN CERTIFICATE----- ... -----END CERTIFICATE-----" } } ``` #### Remove custom SSL from an app [](#remove-custom-ssl-from-an-app) ``` $ssl = $sp->ssl_delete('APPID'); ``` #### Enable AutoSSL for an app [](#enable-autossl-for-an-app) AutoSSL can only be enabled when an AutoSSL certificate is available for an app. Additionally, AutoSSL cannot be enabled when an app currently has a custom SSL certificate. To enable AutoSSL when an app is already using a custom SSL, first delete the app's custom SSL certificate. **Note** that disabling AutoSSL is not done through this API call but instead is done by deleting SSL from the app. ``` $ssl = $sp->ssl_auto('APPID'); ``` #### Force SSL redirect for an app [](#force-ssl-redirect-for-an-app) orceSSL can only be enabled when an app already has SSL enabled. You cannot enable ForceSSL at the same time as adding a custom SSL certificate or enabling AutoSSL. ``` $ssl = $sp->ssl_force('APPID', 'FORCE':bool); ``` \##Notes ServerPilot site: [https://serverpilot.io/](https://serverpilot.io) ServerPilot's API doc: This project's Packagist link: Getting started with Composer: If this isn't your style, check out James West's PHP lib here: ### Health Score 32 — LowBetter than 71% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity15 Limited adoption so far Community13 Small or concentrated contributor base Maturity68 Established project with proven stability Bus Factor2 2 contributors hold 50%+ of commits 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 ~386 days Recently: every ~376 days Total 7 Last Release 1975d ago Major Versions v1.0.4 → 2.0.12020-12-11 PHP version history (2 changes)v1.0.0PHP >=5.2 2.0.1PHP >=7.4 ### Community Maintainers ![](https://www.gravatar.com/avatar/034fb67e76a9eef20cdb667c11b591a009dbece86d0c31fd7e84cc88fa03ee52?d=identicon)[paulgoodchild](/maintainers/paulgoodchild) --- Top Contributors [![daverogers](https://avatars.githubusercontent.com/u/953524?v=4)](https://github.com/daverogers "daverogers (17 commits)")[![paulgoodchild](https://avatars.githubusercontent.com/u/10562196?v=4)](https://github.com/paulgoodchild "paulgoodchild (7 commits)")[![m0byd1ck](https://avatars.githubusercontent.com/u/156634297?v=4)](https://github.com/m0byd1ck "m0byd1ck (5 commits)")[![robbens](https://avatars.githubusercontent.com/u/12089594?v=4)](https://github.com/robbens "robbens (4 commits)")[![cobbman](https://avatars.githubusercontent.com/u/245141?v=4)](https://github.com/cobbman "cobbman (2 commits)")[![Remo](https://avatars.githubusercontent.com/u/129864?v=4)](https://github.com/Remo "Remo (2 commits)") --- Tags apicontrol panelserver-managementserverpilot ### Embed Badge ![Health badge](/badges/fernleafsystems-apiwrappers-serverpilot/health.svg) ``` [![Health](https://phpackages.com/badges/fernleafsystems-apiwrappers-serverpilot/health.svg)](https://phpackages.com/packages/fernleafsystems-apiwrappers-serverpilot) ``` ### Alternatives [m165437/laravel-blueprint-docs API Blueprint Renderer for Laravel 22779.0k](/packages/m165437-laravel-blueprint-docs) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)