Advanced Backup¶
Entity¶
Advanced backup¶
Field |
Explanation |
|---|---|
id |
advanced backup identifier |
password |
advanced backup manager password |
vlan |
virtual LAN identifier |
status |
Status of the advanced backup (offline, online) |
locked |
Is advanced backup busy with an operation? |
hostname |
advanced backup hostname |
template_id |
advanced backup template id |
required_startup |
Is required to restart advanced_backup? |
Advanced backup list:
Operations¶
List advanced backup¶
- Method
GET
- Url
/advanced_backups
- Success Code
200
- Returned Data
- Has Token
No
List all advanced backups in your account
Filters:
id: advanced backup identifier.
status: advanced backup status (online, offline)
locked: Is advanced backup busy with an operation?
hostname: advanced backup name
Get advanced backup¶
- Method
GET
- Url
/advanced_backup/<id>
- Success Code
200
- Returned Data
- Has Token
No
Get advanced_backup resource.
Modify advanced backup¶
- Method
PUT
- Url
/advanced_backup/<id>
- Success Code
200
- Returned Data
- Has Token
No
Modify advanced backup resource.
Optional parameters:
template_id: Template id to reinstall
required_startup: Start up the advanced backup when it finishes
status: Modify the status for (online, offline)
List disk attached¶
- Method
GET
- Url
/advanced_backup/<id>/disks
- Success Code
200
- Returned Data
:
- Has Token
No
List disks plug to the advanced_backup
List network interfaces¶
- Method
GET
- Url
/advanced_backup/<id>/network_interfaces
- Success Code
200
- Returned Data
:
- Has Token
No
List network interfaces plug to the advanced_backup
Reboot advanced backup¶
- Method
POST
- Url
/advanced_backup/<id>/reboot
- Success Code
200
- Returned Data
None
- Has Token
No
reboot advanced_backup
Apply firewall rules¶
- Method
POST
- Url
/advanced_backup/<id>/apply_firewall_rules
- Success Code
200
- Returned Data
None
- Has Token
No
Apply firewall rules
Get firewall rules¶
- Method
GET
- Url
/advanced_backup/<id>/firewall_rules
- Success Code
200
- Returned Data
None
- Has Token
No
Show the firewall rules of advanced backup
Get bandwidth stats¶
- Method
GET
- Url
/advanced_backup/<id>/bw_stats
- Success Code
200
- Returned Data
None
- Has Token
No
Bandwidth stats of advanced backup
Get cpu stats¶
- Method
GET
- Url
/advanced_backup/<id>/cpu_stats
- Success Code
200
- Returned Data
None
- Has Token
No
CPU load stats of advanced backup
Put segregation¶
- Method
PUT
- Url
/advanced_backup/<origin_id>/segregation/<target_id>
- Success Code
200
- Returned Data
None
- Has Token
No
Segregate from a virtual machine id
Delete segregation¶
- Method
DELETE
- Url
/advanced_backup/<origin_id>/segregation/<target_id>
- Success Code
200
- Returned Data
None
- Has Token
No
Delete segregation from a virtual machine id
Get IP addresses¶
- Method
GET
- Url
/advanced_backup/<id>/ip_addresses
- Success Code
200
- Returned Data
None
- Has Token
No
Get the list of IP addresses of advanced backup
Filters:
network_id: IP addresses by a selected network
interface_id: IP addresses by a selected interface
network_interface_id: IP addresses by a selected network interface
public: Filter public or private IPs
Apply disks¶
- Method
POST
- Url
/advanced_backup/<id>/apply_disks
- Success Code
202
- Returned Data
None
- Has Token
Yes
Apply disks to advanced backup
Optional parameters:
require_format_disk: Format the selected disk
Configure an advanced_backup¶
- Method
POST
- Url
/account/<account_id>/advanced_backup/<virtual_machine_id>/configure
- Success Code
Success return Code: 202
- Returned Data
- Has Token
Yes
Configures advanced backup.
Mandatory parameters:
vlan: virtual LAN identifier
Optional parameters:
password: advanced backup manager password
ip_address: IP address to configurate network
netmask: Netmask to configurate network
gateway: Gateway to configurate network
Reset password¶
- Method
POST
- Url
/account/<account_id>/advanced_backup/<virtual_machine_id>/reset_password
- Success Code
200
- Returned Data
- Has Token
No
Reset the advanced backup manager password.
Mandatory parameters:
password: advanced backup manager password