https://github.com/vanguardbackup/vanguard-php-sdk
PHP SDK for the Vanguard Backup project, programatically control your backups with ease with the power of PHP.
https://github.com/vanguardbackup/vanguard-php-sdk
open-source php php-package
Last synced: 7 months ago
JSON representation
PHP SDK for the Vanguard Backup project, programatically control your backups with ease with the power of PHP.
- Host: GitHub
- URL: https://github.com/vanguardbackup/vanguard-php-sdk
- Owner: vanguardbackup
- License: mit
- Created: 2024-08-09T23:17:38.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-01T04:26:29.000Z (12 months ago)
- Last Synced: 2025-04-05T06:22:59.905Z (10 months ago)
- Topics: open-source, php, php-package
- Language: PHP
- Homepage: https://vanguardbackup.com
- Size: 127 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Vanguard PHP SDK
## Overview
The Vanguard PHP SDK provides a fluent interface for interacting with Vanguard's API, enabling efficient management of your backup operations.
## API Documentation
For comprehensive API documentation, including request/response schemas and example payloads, please refer to our official API documentation:
[Vanguard API Documentation](https://docs.vanguardbackup.com/api/introduction)
This resource is invaluable when constructing requests or handling responses, especially for complex operations not fully abstracted by the SDK.
## Getting Started
### Installation
Add the Vanguard PHP SDK to your project using Composer:
```bash
composer require vanguardbackup/vanguard-php-sdk
```
### Initializing the SDK
Create a new instance of the VanguardBackup client:
```php
$vanguard = new VanguardBackup\Vanguard\VanguardClient('YOUR_API_KEY');
```
For custom Vanguard installations, specify the API base URL:
```php
$vanguard = new VanguardBackup\Vanguard\VanguardClient('YOUR_API_KEY', 'https://your-vanguard-instance.com');
```
## Core Functionalities
### User Authentication
Retrieve the authenticated user's information:
```php
$user = $vanguard->user();
```
### Backup Task Management
Manage your backup tasks:
```php
// List all backup tasks
$tasks = $vanguard->backupTasks();
// Get a specific backup task
$task = $vanguard->backupTask($taskId);
// Create a new backup task
$newTask = $vanguard->createBackupTask([
'label' => 'Daily Database Backup',
'source_type' => 'database',
// ... other task parameters
]);
// Update an existing backup task
$updatedTask = $vanguard->updateBackupTask($taskId, [
'frequency' => 'daily',
// ... other parameters to update
]);
// Delete a backup task
$vanguard->deleteBackupTask($taskId);
// Get the status of a backup task
$status = $vanguard->getBackupTaskStatus($taskId);
// Retrieve the latest log for a backup task
$log = $vanguard->getLatestBackupTaskLog($taskId);
// Manually trigger a backup task
$vanguard->runBackupTask($taskId);
```
Individual `BackupTask` instances also provide methods for common operations:
```php
$task->update(['label' => 'Weekly Full Backup']);
$task->delete();
$task->getStatus();
$task->getLatestLog();
$task->run();
```
### Backup Task Log Management
Manage logs for your backup tasks:
```php
// List all backup task logs
$logs = $vanguard->backupTaskLogs();
// Get a specific backup task log
$log = $vanguard->backupTaskLog($logId);
// Delete a backup task log
$vanguard->deleteBackupTaskLog($logId);
```
Individual `BackupTaskLog` instances also provide methods for common operations:
```php
$log->delete();
$log->isSuccessful();
$log->isFailed();
```
### Remote Server Management
Manage the servers from which you're backing up data:
```php
// List all remote servers
$servers = $vanguard->remoteServers();
// Get a specific remote server
$server = $vanguard->remoteServer($serverId);
// Add a new remote server
$newServer = $vanguard->createRemoteServer([
'label' => 'Production DB Server',
'ip_address' => '192.168.1.100',
// ... other server details
]);
// Update a remote server
$updatedServer = $vanguard->updateRemoteServer($serverId, [
'label' => 'Updated Production DB Server',
]);
// Remove a remote server
$vanguard->deleteRemoteServer($serverId);
```
### Backup Destination Management
Control where your backups are stored:
```php
// List all backup destinations
$destinations = $vanguard->backupDestinations();
// Get a specific backup destination
$destination = $vanguard->backupDestination($destinationId);
// Create a new backup destination
$newDestination = $vanguard->createBackupDestination([
'type' => 's3',
'bucket' => 'my-backups',
// ... other destination details
]);
// Update a backup destination
$updatedDestination = $vanguard->updateBackupDestination($destinationId, [
'bucket' => 'new-backup-bucket',
]);
// Remove a backup destination
$vanguard->deleteBackupDestination($destinationId);
```
### Tag Management
Organize your backup resources with tags:
```php
// List all tags
$tags = $vanguard->tags();
// Get a specific tag
$tag = $vanguard->tag($tagId);
// Create a new tag
$newTag = $vanguard->createTag(['label' => 'Production']);
// Update a tag
$updatedTag = $vanguard->updateTag($tagId, ['label' => 'Staging']);
// Delete a tag
$vanguard->deleteTag($tagId);
```
### Notification Stream Management
Configure how you receive alerts about your backups:
```php
// List all notification streams
$streams = $vanguard->notificationStreams();
// Get a specific notification stream
$stream = $vanguard->notificationStream($streamId);
// Create a new notification stream
$newStream = $vanguard->createNotificationStream([
'type' => 'slack',
'webhook_url' => 'https://hooks.slack.com/services/...',
]);
// Update a notification stream
$updatedStream = $vanguard->updateNotificationStream($streamId, [
'events' => ['backup_failed', 'backup_successful'],
]);
// Delete a notification stream
$vanguard->deleteNotificationStream($streamId);
```
### SSH Key Management
Retrieve the Vanguard instance SSH public key:
```php
// Get the instance SSH public key
$sshKey = $vanguard->getInstanceSshKey();
// Access the public key as a string
echo $sshKey->publicKey;
// Or cast the object to a string to get the public key
echo (string) $sshKey;
```
## Security
For reporting security vulnerabilities, please refer to our [security policy](https://github.com/vanguardbackup/vanguard/security/policy).
## License
The Vanguard PHP SDK is open-source software, released under the [MIT licence](LICENSE.md).
## Acknowledgments
We'd like to express our gratitude to the Laravel Forge PHP SDK, which served as an inspiration for the structure and design of this SDK.