This is the multi-page printable view of this section. Click here to print.
List Backup Agents
1 - 1.2
scpcli backup backup agent list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--server_backup_agent_ip <value>]
[--server_name <value>]
Description
List Backup Agents.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | Backup Agent Name | agent_abcd12 |
| server_backup_agent_ip optional | string | Server's Backup Agent IP | 11.22.33.44 |
| server_name optional | string | Backup Agent target server name | server-001 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Backup Agent ID | BACKUP_AGENT-abcd |
| account_id | Account ID | fnsd89fus0f9ds09f90dshf9dshfds09 |
| backup_policy_count | Backup policy count | 3 |
| connection_state | Backup Agent connection state | SUCCESS |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Backup Agent Name | agent_abcd12 |
| server_backup_agent_ip | Server’s Backup Agent IP | 11.22.33.44 |
| server_category | Backup server category | VIRTUAL_SERVER |
| server_name | Backup server name | server-001 |
| state | Backup Agent state | AVAILABLE |
2 - 1.1
scpcli backup backup agent list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--server_backup_agent_ip <value>]
[--server_name <value>]
Description
List Backup Agents.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260531 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | Backup Agent Name | agent_abcd12 |
| server_backup_agent_ip optional | string | Server's Backup Agent IP | 11.22.33.44 |
| server_name optional | string | Backup Agent target server name | server-001 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Backup Agent ID | BACKUP_AGENT-abcd |
| account_id | Account ID | fnsd89fus0f9ds09f90dshf9dshfds09 |
| backup_policy_count | Backup policy count | 3 |
| connection_state | Backup Agent connection state | SUCCESS |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Backup Agent Name | agent_abcd12 |
| server_backup_agent_ip | Server’s Backup Agent IP | 11.22.33.44 |
| server_name | Backup server name | server-001 |
| state | Backup Agent state | AVAILABLE |
3 - 1.0
scpcli backup backup agent list
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--server_backup_agent_ip <value>]
[--server_name <value>]
Description
List Backup Agents.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20260331 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | Backup Agent Name | agent_abcd12 |
| server_backup_agent_ip optional | string | Server's Backup Agent IP | 11.22.33.44 |
| server_name optional | string | Backup Agent target server name | server-001 |
Responses
| Name | Description | Example |
|---|---|---|
| id | Backup Agent ID | BACKUP_AGENT-abcd |
| account_id | Account ID | fnsd89fus0f9ds09f90dshf9dshfds09 |
| backup_policy_count | Backup policy count | 3 |
| connection_state | Backup Agent connection state | SUCCESS |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | Backup Agent Name | agent_abcd12 |
| server_backup_agent_ip | Server’s Backup Agent IP | 11.22.33.44 |
| server_name | Backup server name | server-001 |
| state | Backup Agent state | AVAILABLE |