System Notifications

The /notifications resource collection represents notifications triggered in Veeam Backup for Google Cloud.

Get System Notifications

The HTTP GET request to the /notifications endpoint retrieves a list of notifications triggered in Veeam Backup for Google Cloud.

SecurityBearer

Request

query Parameters

filter	string Returns only specific items of a resource collection in the response. To learn how to use the `filter` parameter, see the Veeam Backup for Google Cloud REST API Reference, section Filter Parameter.
orderby	string Specifies the order of items in the response. For more information, see the Veeam Backup for Google Cloud REST API Reference Overview, section Orderby Parameter.
offset	integer <int32> Specifies the first N items of a resource collection that will be excluded from the response.
limit	integer <int32> Specifies the maximum number of items of a resource collection that will be returned in the response.

header Parameters

x-api-version

required

string

Default: 1.4-rev0

Specifies the current revision of the Veeam Backup for Google Cloud 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).

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/v1/notifications

Request samples

curl
Python
JavaScript
C#
Go

Response samples

application/json

{"data": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"text": "string",
"data": "string",
"notificationType": "ServiceRoleUpdate",
"status": "Active",
"errorStatus": "None"
}
],
"pagination": {"total": 0,
"count": 0,
"offset": 0
}
}

Get System Notification Data

The HTTP GET request to the /notifications/{notificationId} endpoint retrieves data on a notification with the specified ID.

SecurityBearer

Request

path Parameters

notificationId

required

string <uuid>

System ID assigned to a notification message in Veeam Backup for Google Cloud.

header Parameters

x-api-version

required

string

Default: 1.4-rev0

Specifies the current revision of the Veeam Backup for Google Cloud 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).

403

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

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 at the server side.

get/api/v1/notifications/{notificationId}

Request samples

curl
Python
JavaScript
C#
Go

Response samples

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"text": "string",
"data": "string",
"notificationType": "ServiceRoleUpdate",
"status": "Active",
"errorStatus": "None"
}

Remove System Notification

The HTTP DELETE request to the /notifications/{notificationId} endpoint removes a notification from the Veeam Backup for Google Cloud.

SecurityBearer

Request

path Parameters

notificationId

required

string <uuid>

System ID assigned to a notification message in Veeam Backup for Google Cloud.

header Parameters

x-api-version

required

string

Default: 1.4-rev0

Specifies the current revision of the Veeam Backup for Google Cloud REST API.

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.

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 at the server side.

delete/api/v1/notifications/{notificationId}

Request samples

curl
Python
JavaScript
C#
Go

Response samples

application/json

{ }

Resolve System Notifications

The HTTP POST request to the /notifications/{notificationId}/deactivate endpoint resolves a notification with the specified ID.

SecurityBearer

Request

path Parameters

notificationId

required

string <uuid>

System ID assigned to a notification message in Veeam Backup for Google Cloud.

header Parameters

x-api-version

required

string

Default: 1.4-rev0

Specifies the current revision of the Veeam Backup for Google Cloud 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).

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/v1/notifications/{notificationId}/deactivate

Request samples

curl
Python
JavaScript
C#
Go

Response samples

application/json

{"success": true,
"issues": [{"description": "string",
"severity": "Error"
}
]
}