Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ilkbyte/api-php
Ilkbyte api php client
https://github.com/ilkbyte/api-php
cloud ilkbyte php php-library server
Last synced: 2 days ago
JSON representation
Ilkbyte api php client
- Host: GitHub
- URL: https://github.com/ilkbyte/api-php
- Owner: ilkbyte
- License: mit
- Created: 2020-10-09T09:34:21.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2020-11-27T14:00:42.000Z (about 4 years ago)
- Last Synced: 2024-04-23T17:07:02.370Z (9 months ago)
- Topics: cloud, ilkbyte, php, php-library, server
- Language: PHP
- Homepage:
- Size: 1.44 MB
- Stars: 12
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
### **Ilkbyte Package**
This package mainly developed for laravel package but you can use as a standalone package.
#### **Installation**
`composer require ilkbyte/api-php`
Package should be autodiscover by default but if you are using older versions of laravel you should change config/app.php with below;
Add this in providers array;
```js
Netinternet\Ilkbyte\IlkbyteServiceProvider::class,
```
Add this in aliases array;
```js
'Ilkbyte' => Netinternet\Ilkbyte\Facades\Ilkbyte::class,
```
#### **Configuration**
Use command below and choose ilkbyte option when asked. It will create ilkbyte.php in config directory.
`php artisan vendor:publish`
You can also create this file manually and paste below content in file;
```php
env('ILKBYTE_ACCESSKEY'),
'secret' => env('İLKBYTE_SECRETKEY')
];
```
#### **Usage**
You can choose to use facade or helper function. We will use helper functions for examples in this documentation.
```php
use Ilkbyte;
// With Facade
public function myMethod()
{
return Ilkbyte::server()->all();
}
```
```php
public function myMethod()
{
return ilkbyte()->server()->all();
}
```
#### **Avalaible Methods**
##### **Account**
```php
// get account info
ilkbyte()->account()->info()
// get your account users.
ilkbyte()->account()->users()
```
##### **Server**
```php
// get all servers
ilkbyte()->server()->all()
// get only active servers
ilkbyte()->server()->active()
// create a new server
ilkbyte()->server()->create([
'username' => $username,
'password' => $password,
'name' => $name,
'os_id' => $osID,
'app_id' => $appID,
'package_id' => $packageID,
'sshkey' => $sshkey,
])
// Get server configs you can choose
ilkbyte()->server()->getConfig()
// Get server details
ilkbyte()->server('server-name')->show()
// Server power settings
ilkbyte()->server('server-name')->power($status)
// Get all ips from server
ilkbyte()->server('server-name')->ip()
// Get ip logs
ilkbyte()->server('server-name')->ipLogs()
// Add a new rdns record
ilkbyte()->server('server-name')->ipRdns($ip, $rdns)
```
##### **Backup**
```php
// Get backup list.
ilkbyte()->server('server-name')->backupList()
// Restore your backup.
ilkbyte()->server('server-name')->backupRestore('backup-name')
```
##### **Snapshot**
```php
// Get all snapshots.
ilkbyte()->server('server-name')->snapshotList()
// Create a new snapshot.
ilkbyte()->server('server-name')->snapshotCreate('snapshot-name')
// Revert snapshot.
ilkbyte()->server('server-name')->snapshotRevert('snapshot-name')
// Recreate your snapshot.
ilkbyte()->server('server-name')->snapshotUpdate('snapshot-name')
// Delete snapshot.
ilkbyte()->server('server-name')->snapshotDelete('snapshot-name')
// Add cron to your snapshot.
ilkbyte()->server('server-name')->snapshotAddCron($snapshotName, $day, $hour, $minute)
// Delete cron.
ilkbyte()->server('server-name')->snapshotDeleteCron('snapshot-name')
```
##### **Domain**
```php
// Get all domains
ilkbyte()->domain()->all()
// Create a new domain
ilkbyte()->domain()->create([
'domain' => $domainName,
'server' => $serverName,
'ipv6' => $ipv6,
])
// Get domain details
ilkbyte()->domain('domain-name')->show()
// Add a new record
ilkbyte()->domain('domain-name')->add([
'record_name' => $recordName,
'record_type' => $recordType,
'record_content' => $recordContent,
'record_priority' => $recordPriority,
])
// Update an existing record
ilkbyte()->domain('domain-name')->update([
'record_id' => $recordID,
'record_content' => $recordContent,
'record_priority' => $recordPriority,
])
// Delete domain
ilkbyte()->domain('domain-name')->delete([
'record_id' => $recordId,
])
// Push changes to server
ilkbyte()->domain('domain-name')->push()
```