1.1

1.1

get /v1/backup-agents/targets

Description

List targets of Backup Agent.

State ACTIVE (CURRENT)

VersionSupported Until
1.1-

Parameters

TypeNameDescriptionSchemaDefault
querysize
optional
size
Example : 20
any of [integer, null]20
querypage
optional
page
Example : 0
any of [integer, null]0
querysort
optional
Sort
Example : server_name:asc
any of [string, null]server_name:asc
queryserver_category
required
Backup server category
Example : BAREMETAL_SERVER
stringNone
queryserver_name
optional
Backup server name
Example : server-001
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKBackupAgentTargetListResponse
401UnauthorizedNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/backup-agents/targets?server_category={server_category}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = backup 1.1"

Example HTTP response

Response 200

{
    "contents": [
        {
            "server_backup_agent_ip": "11.22.33.44",
            "server_name": "server-001",
            "server_state": "RUNNING",
            "server_uuid": "89f5ef44-1021-4a5c-8e06-fbb289eac366"
        }
    ],
    "count": 1
}