ilkbyte/api-php

Laravel ilkbyte package

dev-main 2020-11-27 14:00 UTC

Requires

• php: >=5.4.0
• illuminate/console: >=5.4
• illuminate/filesystem: >=5.4
• illuminate/support: >=5.4
• symfony/class-loader: ^2.3|^3.0

Requires (Dev)

• guzzlehttp/guzzle: ~6.0
• illuminate/config: >=5.4
• illuminate/view: >=5.4
• squizlabs/php_codesniffer: ^3.4

MIT

• Umut Aktepe

• server
• dns
• laravel
• domain

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;

Netinternet\Ilkbyte\IlkbyteServiceProvider::class,

Add this in aliases array;

'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
    return [
        'access' => 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.

use Ilkbyte;
// With Facade
public function myMethod()
{
	return Ilkbyte::server()->all();
}

public function myMethod()
{
	return ilkbyte()->server()->all();
}

Avalaible Methods

Account

// get account info
ilkbyte()->account()->info()
// get your account users.
ilkbyte()->account()->users()

Server

// 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

// Get backup list.
ilkbyte()->server('server-name')->backupList()
// Restore your backup.
ilkbyte()->server('server-name')->backupRestore('backup-name')

Snapshot

// 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

// 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()