API v2: Session BackupΒΆ


Data StructuresΒΆ

SessionBackupModelΒΆ

Attribute

Type

Description

session_id

string

ID of the session to backup. Requires backup_id: {} or backup_name: {}.

session_ids

string-array

IDs of the sessions to backup. Requires backup_id: {} or backup_name: {}.

backup_id

string

ID of the backup target. Requires session_id: {} or session_ids: {}.

backup_name

string

Name of the backup target. Requires session_id: {} or session_ids: {}.

Retrieve Available Attributes of the SessionBackupModelΒΆ

Request

Method

GET

Path

/api/v2/objspec/session_backup

GET /api/v2/objspec/session_backup

Example Request

curl -s -k -X GET \
  -H 'Authorization: sgfeea6jsaz4mum9su8w6' \
  'https://10.0.214.98/api/v2/objspec/session_backup'

Mark Existing Session for Back UpΒΆ

Request

Method

POST

Path

/api/v2/session/<session_id>/backup/<backup_id>

Example Request

POST /api/v2/session/<session_id>/backup/<backup_id>

Request

Method

POST

Path

/api/v2/session_backup

Headers

Content-Type: Application/json

Body

SessionBackupModel

Example Request

PATCH /api/v2/session_backup

{
"backup_name": "Backup_Target_Name",
"session_ids": [
        "2345678901234567890",
        "2345678901234567891"
]
}

Response

{
"result": "success",
"session_ids": [
        "2345678901234567890",
        "2345678901234567891"
        ]
}