How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Veeam Sessions API

The Sessions API from Veeam — 11 operation(s) for sessions.

Veeam Sessions API is one of 55 APIs that Veeam publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Sessions. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 11 operations across 11 paths, and defines 38 schemas. It is described by OpenAPI 3.0.0, at version 1.0-rev0.

Requests are made against the base URL https://localhost:9419.

11 operations 11 paths 38 schemas 8 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0-rev0
Base URL
https://localhost:9419
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Veeam Sessions API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (Bearer). By default, every request must be authenticated.

  • Bearer — Bearer \

Paths & Operations 11

Across 11 paths, the API surfaces 11 operations — 8 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Sessions 11
GET
/api/v1/sessions
GetSessions 11 params → 200400401500
GET
/api/v1/sessions/{retentionSessionId}/deletedItems
GetRetentionSessionDeletedRestorePoints 6 params → 200400401404500
GET
/api/v1/sessions/{backupSessionId}/protectedItems
GetBackupSessionProtectedItems 6 params → 200400401404500
GET
/api/v1/sessions/{restoreSessionId}/restoredItems
GetRestoreSessionRestoredItems 6 params → 200400401404500
GET
/api/v1/sessions/{sessionId}
GetSessionById 2 params → 200401404500
GET
/api/v1/sessions/{sessionId}/log
GetSessionLog 2 params → 200401404500
POST
/api/v1/sessions/{sessionId}/stop
StopJob 2 params → 202401404500
POST
/api/v1/sessions/export
ExportSessions 1 param → 200401500
GET
/api/v1/sessions/{id}
Get Session
GetSession 2 params → 200401403404500
GET
/api/v1/sessions/{id}/logs
Get Session Logs
GetSessionLogs 2 params → 200401403404500
POST
/api/v1/sessions/{id}/stop
Stop Session
StopSession 2 params → 200401403404500

Schemas 38

The contract defines 38 schemas that model the data the API accepts and returns. The most detailed are SessionModel (13 properties), Session (11 properties), SessionsFilters (8 properties), Error (7 properties). Each schema is shown below with its type and property counts.

Link
object
3 properties 3 required
RetentionJobDeletedRestorePointsPage
object
3 properties 2 required
SessionLog
object
2 properties 1 required
RestoredItemsFilters
object
4 properties
SessionStatuses
string
ETaskLogRecordStatus
string
SessionEmbeddedResources
object
3 properties
RetentionJobDeletedRestorePointSortColumns
string
SessionLogResult
object
Log of the session.
2 properties
RestoreItemEmbedded
object
2 properties
ProtectedItem
object
5 properties 2 required
Error
object
7 properties 4 required
RetentionJobDeletedRestorePoint
object
4 properties
RetentionJobDeletedRestorePointsFilters
object
4 properties
ProtectedItemEmbedded
object
2 properties
EmptySuccessResponse
object
Empty success response (200, 201, 204).
SessionModel
object
13 properties 7 required
SessionsPage
object
3 properties 2 required
RestoredItemsPage
object
3 properties 2 required
LogItem
object
5 properties 2 required
SessionsFilters
object
8 properties
Session
object
11 properties 4 required
ESessionResult
string
Result status.
SessionResultModel
object
Session result.
3 properties 1 required
SessionResults
string
RetentionJobDeletedRestorePointEmbedded
object
1 property
ProtectedItemsPage
object
3 properties 2 required
SessionLogRecordModel
object
Record of the session log.
6 properties
SessionsSortColumns
string
ESessionState
string
State of the session.
ProtectedItemsSortColumns
string
RestoredItem
object
4 properties
ESessionType
string
Type of the session.
SessionTypes
string
RestoredItemsSortColumns
string
Error_2
object
3 properties 2 required
ProtectedItemsFilters
object
4 properties
SessionItemsStatuses
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

veeam-sessions-api-openapi.yml Raw ↑

Other APIs Veeam publishes across the network.

Veeam Backup & Replication REST API
Veeam Backup Enterprise Manager REST API
Veeam Backup for Microsoft 365 REST API
Veeam ONE REST API
Veeam Backup for AWS REST API
Veeam Backup for Microsoft Azure REST API
Veeam Backup for Google Cloud REST API
Veeam Recovery Orchestrator REST API
Veeam Agents API
Veeam AmazonConnections API
Veeam Automation API
Veeam Backup Objects API
Where this information came from

This is an independent, third-party profile of Veeam Sessions API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.