Sessions

The /sessions resource collection represents statistics for every session performed by Veeam Plug-in for Nutanix AHV.

Get Collection of Sessions

For each performed operation (VM backup, restore, snapshot creation and so on) Veeam Plug-in for Nutanix AHV starts a new session. The HTTP GET request to the /sessions endpoint retrieves a list of sessions stored in the Veeam Backup & Replication configuration database.

SecurityBearer

Request

query Parameters

from	string or null <date-time> Returns only sessions run after the specified date and time.
to	string or null <date-time> Returns only sessions run before the specified date and time.
offset	integer <int32> >= 0 Default: 0 Excludes from a response the first N items of a resource collection.
limit	integer <int32> >= -1 Default: 100 Specifies the maximum number of items of a resource collection to return in a response.
write-only	Array of objects or null (FilterParameter) Specifies the criteria for items to be returned in a response. For more information, see the Veeam Plug-in for Nutanix AHV REST API Reference Overview, section Filter Parameters.
write-only	Array of objects or null (SortParameter) Specifies the order of items in the response. For more information, see the Veeam Plug-in for Nutanix AHV REST API Reference Overview, section Sort Parameters.

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).

403

Forbidden. The user sending a request does not have adequate privileges to access one or more objects specified in the request.

500

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

get/api/v8/sessions

Request samples

curl
Python
JavaScript
C#
Go

Response samples

application/json

{"offset": 0,
"limit": 0,
"totalCount": 0,
"results": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"sessionType": "Unknown",
"state": "Unknown",
"result": "Unknown",
"jobName": "string",
"objectsCount": 0,
"startTimeUtc": "2019-08-24T14:15:22Z",
"finishTimeUtc": "2019-08-24T14:15:22Z",
"reason": "string"
}
]
}

Get Session Data

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

SecurityBearer

Request

path Parameters

required

string <uuid>

Specifies the system ID of a session in Veeam Plug-in for Nutanix AHV.

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).

403

Forbidden. The user sending a request does not have adequate privileges to access one or more objects specified in the request.

500

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

get/api/v8/sessions/{id}

Request samples

curl
Python
JavaScript
C#
Go

Response samples

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"sessionType": "Unknown",
"parentSessionId": "b1d7834e-fe2f-4cad-b0e5-ff5c5615f344",
"state": "Unknown",
"result": "Unknown",
"startTimeUtc": "2019-08-24T14:15:22Z",
"finishTimeUtc": "2019-08-24T14:15:22Z",
"duration": "string",
"context": {"jobId": "string",
"jobName": "string",
"backupMode": "Unknown",
"objectName": "string",
"objectId": "string",
"reason": "string"
},
"progressState": {"events": [{"severity": "Unknown",
"startTimeUtc": "2019-08-24T14:15:22Z",
"endTimeUtc": "2019-08-24T14:15:22Z",
"message": "string"
}
],
"transferred": {"value": 0,
"percent": 0
},
"read": {"value": 0,
"percent": 0
},
"processed": {"value": 0,
"percent": 0
},
"progressPercents": 0,
"processingRate": 0,
"avgProcessingRate": 0,
"objectsCount": 0,
"objectsProcessed": 0
}
}

Stop Session Processing

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

SecurityBearer

Request

path Parameters

required

string <uuid>

Specifies the system ID assigned of a session in Veeam Plug-in for Nutanix AHV.

Responses

204

No Content

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).

403

Forbidden. The user sending a request does not have adequate privileges to access one or more objects specified in the request.

500

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

post/api/v8/sessions/{id}/stop

Request samples

curl
Python
JavaScript
C#
Go

Response samples

application/problem+json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"extensions": {"property1": { },
"property2": { }
}
}