Sessions

The /sessions resource collection represents statistics for every performed Veeam Backup for AWS session.

Get Collection of Sessions

For every performed operation (EC2 instance backup, restore, snapshot creation and so on) Veeam Backup for AWS starts a new session. The HTTP GET request to the /sessions endpoint retrieves a list of sessions stored in the Veeam Backup for AWS database.

SecurityBearer

Request

query Parameters

Offset	integer <int32> >= 0 Excludes from a response the first N items of a resource collection.
Limit	integer <int32> >= -1 Specifies the maximum number of items of a resource collection to return in a response.
PolicyId	string <uuid> Returns only sessions of a backup policy with the specified ID.
ParentSessionId	string <uuid> Returns child sessions of a session with the specified ID.
Status	Array of strings Returns only sessions with the specified session status. Items Enum: "Running" "NeverExecuted" "Succeeded" "Warning" "Failed" "Canceled"
Types	Array of strings Returns only sessions of the specified session type. Items Enum: "Policy" "Job" "Task" "UserPolicy" "RetentionActivity" "RestoreTask" "FLRTask" "ConfigurationBackupActivity" "ImportPolicy" "TombstoneRetention" "ArchiveRetrieval" "ArchiveRetrievalProlongation" "ManualTask" "FlrEfsTask"
FromUtc	string <date-time> Returns only sessions run after the specified date and time.
ToUtc	string <date-time> Returns only sessions run before the specified date and time.
Usn	integer <int64> Returns only sessions with the specified update sequence number.
Sort	Array of strings (SessionsSortColumns) Specifies the order of items in the response. For more information, see the Veeam Backup for AWS REST API Reference Overview, section Sort Parameter. Items Enum: "startTimeAsc" "startTimeDesc" "stopTimeAsc" "stopTimeDesc" "durationAsc" "durationDesc" "typeAsc" "typeDesc" "reasonAsc" "reasonDesc" "usnAsc" "usnDesc"
VmId	string Returns only sessions where an EC2 instance with the specified ID is processed.

header Parameters

x-api-version

required

string

Default: 1.7-rev0

Specifies the current version and revision of the Veeam Backup for AWS REST API.

Responses

200

400

Bad Request. The request body is malformed, incomplete or otherwise invalid.

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

404

Not Found. One or more resources specified in the request could not be found in the specified resource collection.

500

Internal Server Error. The request has been received but could not be completed because of an internal error on the server side.

503

Service Unavailable

504

Gateway Timeout

get/api/v1/sessions

Request samples

curl
Python
JavaScript
C#
Go

curl -i -X GET \
  'https://helpcenter.veeam.com/api/v1/sessions?Offset=0&Limit=-1&PolicyId=497f6eca-6276-4993-bfeb-53cbbbba6f08&ParentSessionId=497f6eca-6276-4993-bfeb-53cbbbba6f08&Status=Running&Types=Policy&FromUtc=2019-08-24T14%3A15%3A22Z&ToUtc=2019-08-24T14%3A15%3A22Z&Usn=0&Sort=startTimeAsc&VmId=string' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'

Response samples

{"totalCount": 2,
"results": [{"type": "Job",
"status": "Succeeded",
"result": "Success",
"id": "ab9562f2-2bea-40f3-ac83-4f8432b85940",
"executionStartTime": "2020-11-23T10:00:18.163004",
"executionStopTime": "2020-11-23T10:01:26.317649",
"executionDuration": 154,
"reason": "Snapshots",
"usn": 16196,
"_links": [{"method": "GET",
"rel": "self",
"href": "https://123.123.123.123:11005/api/v1/sessions/ab9562f2-2bea-40f3-ac83-4f8432b85940"
},
{"method": "GET",
"rel": "SessionLogs",
"href": "https://123.123.123.123:11005/api/v1/sessions/ab9562f2-2bea-40f3-ac83-4f8432b85940/log"
}
],
"_embedded": { }
},
{"type": "RetentionActivity",
"status": "Succeeded",
"result": "Success",
"id": "73737aba-c33b-4fcf-8341-9dfb3e58ccea",
"executionStartTime": "2020-06-23T02:00:13.572632",
"executionStopTime": "2020-06-23T02:00:37.086188",
"executionDuration": 513,
"reason": "",
"usn": 15694,
"_links": [{"method": "GET",
"rel": "self",
"href": "https://123.123.123.123:11005/api/v1/sessions/73737aba-c33b-4fcf-8341-9dfb3e58ccea"
},
{"method": "GET",
"rel": "SessionLogs",
"href": "https://123.123.123.123:11005/api/v1/sessions/73737aba-c33b-4fcf-8341-9dfb3e58ccea/log"
}
],
"_embedded": {"retentionJobDeletedRestorePoints": {"method": "GET",
"rel": "RetentionJobDeletedRestorePoints",
"href": "https://123.123.123.123:11005/api/v1/sessions/73737aba-c33b-4fcf-8341-9dfb3e58ccea/deletedItems"
}
}
}
],
"_links": [{"method": "GET",
"rel": "self",
"href": "https://123.123.123.123:11005/api/v1/sessions"
}
]
}

Get Items Removed During Session

The HTTP GET request to the /session/{retentionSessionId}/deletedItems endpoint retrieves a list of restore points removed during a session with the specified ID.

SecurityBearer

Request

path Parameters

retentionSessionId

required

string <uuid>

System ID assigned to the retention activity session in the Veeam Backup for AWS REST API.

query Parameters

SearchPattern	string Returns only those items of a resource collection whose names match the specified search pattern in the parameter value.
Sort	Array of strings (RetentionJobDeletedRestorePointSortColumns) Specifies the order of items in the response. For more information, see the Veeam Backup for AWS REST API Reference Overview, section Sort Parameter. Items Enum: "nameAsc" "nameDesc" "statusAsc" "statusDesc" "regionAsc" "regionDesc"
Offset	integer <int32> >= 0 Excludes from a response the first N items of a resource collection.
Limit	integer <int32> >= -1 Specifies the maximum number of items of a resource collection to return in a response.

header Parameters

x-api-version

required

string

Default: 1.7-rev0

Specifies the current version and revision of the Veeam Backup for AWS REST API.

Responses

200

400

Bad Request. The request body is malformed, incomplete or otherwise invalid.

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

404

Not Found. One or more resources specified in the request could not be found in the specified resource collection.

500

Internal Server Error. The request has been received but could not be completed because of an internal error on the server side.

503

Service Unavailable

504

Gateway Timeout

get/api/v1/sessions/{retentionSessionId}/deletedItems

Request samples

curl
Python
JavaScript
C#
Go

curl -i -X GET \
  'https://helpcenter.veeam.com/api/v1/sessions/{retentionSessionId}/deletedItems?SearchPattern=string&Sort=nameAsc&Offset=0&Limit=-1' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'

Response samples

{"totalCount": 0,
"results": [{"name": "string",
"status": "Succeeded",
"region": "string",
"_embedded": {"region": {"rel": "string",
"href": "string",
"method": "GET"
}
}
}
],
"_links": [{"rel": "string",
"href": "string",
"method": "GET"
}
]
}

Get Items Protected During Session

The HTTP GET request to the /session/{backupSessionId}/protectedItems endpoint retrieves a list of instances protected during a session with the specified ID.

SecurityBearer

Request

path Parameters

backupSessionId

required

string <uuid>

System ID assigned to the backup activity session in the Veeam Backup for AWS REST API.

query Parameters

SearchPattern	string Returns only those items of a resource collection whose names match the specified search pattern in the parameter value.
Sort	Array of strings (ProtectedItemsSortColumns) Specifies the order of items in the response. For more information, see the Veeam Backup for AWS REST API Reference Overview, section Sort Parameter. Items Enum: "virtualMachineNameAsc" "virtualMachineNameDesc" "regionAsc" "regionDesc"
Offset	integer <int32> >= 0 Excludes from a response the first N items of a resource collection.
Limit	integer <int32> >= -1 Specifies the maximum number of items of a resource collection to return in a response.

header Parameters

x-api-version

required

string

Default: 1.7-rev0

Specifies the current version and revision of the Veeam Backup for AWS REST API.

Responses

200

400

Bad Request. The request body is malformed, incomplete or otherwise invalid.

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

404

Not Found. One or more resources specified in the request could not be found in the specified resource collection.

500

Internal Server Error. The request has been received but could not be completed because of an internal error on the server side.

503

Service Unavailable

504

Gateway Timeout

get/api/v1/sessions/{backupSessionId}/protectedItems

Request samples

curl
Python
JavaScript
C#
Go

curl -i -X GET \
  'https://helpcenter.veeam.com/api/v1/sessions/{backupSessionId}/protectedItems?SearchPattern=string&Sort=virtualMachineNameAsc&Offset=0&Limit=-1' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'

Response samples

{"totalCount": 1,
"results": [{"id": "bfabcbb4-c68b-4136-a0ee-8fa2d49eba2d",
"name": "2012aborGPT_restoredGPT",
"status": "Succeeded",
"region": "us-east-1c",
"_embedded": {"virtualMachine": {"method": "GET",
"rel": "self",
"href": "https://123.123.123.123:11005/api/v1/virtualMachines/bfabcbb4-c68b-4136-a0ee-8fa2d49eba2d"
},
"region": {"method": "GET",
"rel": "self",
"href": "https://123.123.123.123:11005/api/v1/cloudInfrastructure/regions/dd371067-5714-4933-8c4c-2ad4d6e71b11"
}
}
}
],
"_links": [{"method": "GET",
"rel": "self",
"href": "https://123.123.123.123:11005/api/v1/sessions/d0d6ed00-0caf-4a66-8187-511d2b9626c0/protectedItems"
}
]
}

Get Items Restored During Session

The HTTP GET request to the /session/{restoreSessionId}/restoredItems endpoint retrieves a list of instances restored during a session with the specified ID.

SecurityBearer

Request

path Parameters

restoreSessionId

required

string <uuid>

System ID assigned to the restore activity session in the Veeam Backup for AWS REST API.

query Parameters

SearchPattern	string Returns only those items of a resource collection whose names match the specified search pattern in the parameter value.
Sort	Array of strings (RestoredItemsSortColumns) Specifies the order of items in the response. For more information, see the Veeam Backup for AWS REST API Reference Overview, section Sort Parameter. Items Enum: "nameAsc" "nameDesc" "regionAsc" "regionDesc"
Offset	integer <int32> >= 0 Excludes from a response the first N items of a resource collection.
Limit	integer <int32> >= -1 Specifies the maximum number of items of a resource collection to return in a response.

header Parameters

x-api-version

required

string

Default: 1.7-rev0

Specifies the current version and revision of the Veeam Backup for AWS REST API.

Responses

200

400

Bad Request. The request body is malformed, incomplete or otherwise invalid.

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

404

Not Found. One or more resources specified in the request could not be found in the specified resource collection.

500

Internal Server Error. The request has been received but could not be completed because of an internal error on the server side.

503

Service Unavailable

504

Gateway Timeout

get/api/v1/sessions/{restoreSessionId}/restoredItems

Request samples

curl
Python
JavaScript
C#
Go

curl -i -X GET \
  'https://helpcenter.veeam.com/api/v1/sessions/{restoreSessionId}/restoredItems?SearchPattern=string&Sort=nameAsc&Offset=0&Limit=-1' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'

Response samples

{"totalCount": 1,
"results": [{"name": "oz-Tgt-01",
"status": "Succeeded",
"regionName": "US West (N. California) (us-west-1)",
"_embedded": {"virtualMachine": {"method": "GET",
"rel": "self",
"href": "https://123.123.123.123:11005/api/v1/virtualMachines/be471476-66f4-4d2f-86c7-cffe34adf4cc"
},
"region": {"method": "GET",
"rel": "self",
"href": "https://123.123.123.123:11005/api/v1/cloudInfrastructure/regions/cd1fd042-c7bd-4ebe-b644-536e49fb65a2"
}
}
}
],
"_links": [{"method": "GET",
"rel": "self",
"href": "https://123.123.123.123:11005/api/v1/sessions/6218b379-b011-4736-bc19-bb59519b094e/restoredItems"
}
]
}

Get Session Data

The HTTP GET request to the /session/{sessionId} endpoint retrieves information on a session with the specified ID.

SecurityBearer

Request

path Parameters

sessionId

required

string <uuid>

System ID assigned to a session in the Veeam Backup for AWS REST API.

header Parameters

x-api-version

required

string

Default: 1.7-rev0

Specifies the current version and revision of the Veeam Backup for AWS REST API.

Responses

200

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

404

Not Found. One or more resources specified in the request could not be found in the specified resource collection.

500

Internal Server Error. The request has been received but could not be completed because of an internal error on the server side.

503

Service Unavailable

504

Gateway Timeout

get/api/v1/sessions/{sessionId}

Request samples

curl
Python
JavaScript
C#
Go

curl -i -X GET \
  'https://helpcenter.veeam.com/api/v1/sessions/{sessionId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'

Response samples

{"type": "FLRTask",
"extendedSessionType": "FileRestore",
"status": "Succeeded",
"result": "Success",
"id": "90faa259-fbf6-493a-b492-e59e1cfbe3a6",
"executionStartTime": "2020-11-20T19:11:59.448156",
"executionStopTime": "2020-06-20T19:22:46.797204",
"executionDuration": 349,
"reason": "files restore",
"usn": 6200,
"_links": [{"method": "GET",
"rel": "self",
"href": "https://123.123.123.123:11005/api/v1/sessions/90faa259-fbf6-493a-b492-e59e1cfbe3a6"
},
{"method": "GET",
"rel": "SessionLogs",
"href": "https://123.123.123.123:11005/api/v1/sessions/90faa259-fbf6-493a-b492-e59e1cfbe3a6/log"
}
],
"_embedded": { }
}

Get FLR Session Data

The HTTP GET request to the /session/{sessionId}/flr endpoint retrieves information on a FLR session with the specified ID.

SecurityBearer

Request

path Parameters

sessionId

required

string <uuid>

System ID assigned to a session in the Veeam Backup for AWS REST API.

header Parameters

x-api-version

required

string

Default: 1.7-rev0

Specifies the current version and revision of the Veeam Backup for AWS REST API.

Responses

200

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

404

Not Found. One or more resources specified in the request could not be found in the specified resource collection.

500

Internal Server Error. The request has been received but could not be completed because of an internal error on the server side.

503

Service Unavailable

504

Gateway Timeout

get/api/v1/sessions/{sessionId}/flr

Request samples

curl
Python
JavaScript
C#
Go

curl -i -X GET \
  'https://helpcenter.veeam.com/api/v1/sessions/{sessionId}/flr' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'

Response samples

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"isFlrSessionReady": true,
"flrUrl": "string",
"flrThumbprint": "string"
}

Get EFS Flr Session Data

The HTTP GET request to the /session/{sessionId}/flrEfs endpoint retrieves information on an FLR session with the specified ID.

SecurityBearer

Request

path Parameters

sessionId

required

string <uuid>

Specifies the system ID assigned to an FLR session in the Veeam Backup for AWS REST API.

header Parameters

x-api-version

required

string

Default: 1.7-rev0

Specifies the current version and revision of the Veeam Backup for AWS REST API.

Responses

200

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

404

Not Found. One or more resources specified in the request could not be found in the specified resource collection.

500

Internal Server Error. The request has been received but could not be completed because of an internal error on the server side.

503

Service Unavailable

504

Gateway Timeout

get/api/v1/sessions/{sessionId}/flrEfs

Request samples

curl
Python
JavaScript
C#
Go

curl -i -X GET \
  'https://helpcenter.veeam.com/api/v1/sessions/{sessionId}/flrEfs' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'

Response samples

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"flrUrl": "string",
"flrThumbprint": "string"
}

Get Session Log Details

The HTTP GET request to the /session/{sessionId}/log endpoint retrieves log details of a session with the specified ID.

SecurityBearer

Request

path Parameters

sessionId

required

string <uuid>

System ID assigned to a session in the Veeam Backup for AWS REST API.

header Parameters

x-api-version

required

string

Default: 1.7-rev0

Specifies the current version and revision of the Veeam Backup for AWS REST API.

Responses

200

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

404

Not Found. One or more resources specified in the request could not be found in the specified resource collection.

500

Internal Server Error. The request has been received but could not be completed because of an internal error on the server side.

503

Service Unavailable

504

Gateway Timeout

get/api/v1/sessions/{sessionId}/log

Request samples

curl
Python
JavaScript
C#
Go

curl -i -X GET \
  'https://helpcenter.veeam.com/api/v1/sessions/{sessionId}/log' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'

Response samples

{"sessionId": "90faa259-fbf6-493a-b492-e59e1cfbe3a6",
"log": [{"status": "Success",
"logTime": "2020-11-20T19:12:00.514619",
"message": "FLR task 'ubuntu16' started at 11/20/2020 21:11:59.",
"executionStartTime": "2020-11-20T19:12:00.514619",
"executionDuration": 0
},
{"status": "Success",
"logTime": "2020-11-20T19:22:13.849335",
"message": "Processing ubuntu16.",
"executionStartTime": "2020-11-20T19:12:04.161597",
"executionDuration": 687
},
{"status": "Success",
"logTime": "2020-11-20T19:15:57.919684",
"message": "Preparing the worker VM.",
"executionStartTime": "2020-11-20T19:14:13.888376",
"executionDuration": 31
},
{"status": "Success",
"logTime": "2020-11-20T19:19:52.3988",
"message": "File Level Recovery Browser is ready to work",
"executionStartTime": "2020-11-20T19:19:52.3988",
"executionDuration": 0
},
{"status": "Success",
"logTime": "2020-11-20T19:22:46.807221",
"message": "Session finished at 05/20/2020 21:22:46.",
"executionStartTime": "2020-11-20T19:22:46.807221",
"executionDuration": 0
}
]
}

Stop Session Processing

The HTTP POST request to the /sessions/{sessionId}/stop endpoint stops processing of a session with the specified ID.

SecurityBearer

Request

path Parameters

sessionId

required

string <uuid>

System ID assigned to a session in the Veeam Backup for AWS REST API.

header Parameters

x-api-version

required

string

Default: 1.7-rev0

Specifies the current version and revision of the Veeam Backup for AWS REST API.

Responses

200

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

404

Not Found. One or more resources specified in the request could not be found in the specified resource collection.

500

Internal Server Error. The request has been received but could not be completed because of an internal error on the server side.

503

Service Unavailable

504

Gateway Timeout

post/api/v1/sessions/{sessionId}/stop

Request samples

curl
Python
JavaScript
C#
Go

curl -i -X POST \
  'https://helpcenter.veeam.com/api/v1/sessions/{sessionId}/stop' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'

Response samples

{"type": "http://example.com",
"title": "string",
"status": 400,
"errorCode": "AccessDenied",
"details": "string",
"instance": "http://example.com",
"data": {"property1": { },
"property2": { }
}
}

Export Collection of Sessions

The HTTP POST request to the /sessions/export endpoint exports session statistics to a .CSV or an .XML file. To specify the required type of the file, use the Accept request header.

SecurityBearer

Request

header Parameters

x-api-version

required

string

Default: 1.7-rev0

Specifies the current version and revision of the Veeam Backup for AWS REST API.

Responses

200

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

500

Internal Server Error. The request has been received but could not be completed because of an internal error on the server side.

503

Service Unavailable

504

Gateway Timeout

post/api/v1/sessions/export

Request samples

curl
Python
JavaScript
C#
Go

curl -i -X POST \
  https://helpcenter.veeam.com/api/v1/sessions/export \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'x-api-version: 1.7-rev0'