Protected Entity Snapshot Controller Resource

The API allows you to list, view, edit and create protected entity snapshots.

GET /snapshots

Returns list of protected entity snapshots filtered by specified query parameters.

Request Parameters
name type description constraints multivalued
after query long no
backup-rule query   no
direction query   no
filter query   no
from query long no
nameLike query   no
orderBy query   no
page query   no
policy query   no
project-uuid query   no
protected-entity query   yes
size query   no
stand-alone query boolean no
status query "CREATING" or "FAILED" or "PRESENT" or "QUEUED" or "REMOVED" no
to query long no
uuid query   no
Response Body
media type data type description
application/json array of ProtectedEntitySnapshotDetails (JSON) list of protected entity snapshots filtered by specified query parameters

Example

Request
GET /snapshots
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ { } ]

PUT /snapshots/warnings-acknowledged

Set acknowledged warnings for specified protected entity snapshot batch.

Request Body
media type data type description
application/json WarningAcknowledgementRequest (JSON) specify local unique identifiers batch for protected entity snapshots (use by vProtect)
Response Body
media type data type description
application/json array of ProtectedEntitySnapshotDetails (JSON) protected entity snapshot details

Example

Request
PUT /snapshots/warnings-acknowledged
Content-Type: application/json
Accept: application/json

                
{ }
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
[ { } ]

GET /snapshots/{guid}

Get a single protected entity snapshot.

Request Parameters
name type description
guid path specify local unique identifier for protected entity snapshot (use by vProtect)
Response Body
media type data type description
application/json ProtectedEntitySnapshotDetails (JSON) a single protected entity snapshot details

Example

Request
GET /snapshots/{guid}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{ }

PUT /snapshots/{guid}/attempts

Request Parameters
name type description
guid path
Request Body
media type data type
application/json string (JSON)
Response Body
media type data type description
application/json ProtectedEntitySnapshotDetails (JSON)

Example

Request
PUT /snapshots/{guid}/attempts
Content-Type: application/json
Accept: application/json

                
...
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{ }

PUT /snapshots/{guid}/warnings

Set warnings for specified protected entity snapshot.

Request Parameters
name type description
guid path specify local unique identifier for protected entity snapshot (use by vProtect)
Request Body
media type data type description
application/json array of StringDTO (JSON) specify warnings to add for specified protected entity snapshot
Response Body
media type data type description
application/json ProtectedEntitySnapshotDetails (JSON) protected entity snapshot details

Example

Request
PUT /snapshots/{guid}/warnings
Content-Type: application/json
Accept: application/json

                
[ { } ]
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{ }

PUT /snapshots/{guid}/warnings-acknowledged

Set acknowledged warnings for specified protected entity snapshot.

Request Parameters
name type description
guid path specify local unique identifier for protected entity snapshot (use by vProtect)
Request Body
media type data type description
application/json BooleanDTO (JSON) specify whether warnings are acknowledged
Response Body
media type data type description
application/json ProtectedEntitySnapshotDetails (JSON) protected entity snapshot details

Example

Request
PUT /snapshots/{guid}/warnings-acknowledged
Content-Type: application/json
Accept: application/json

                
{ }
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{ }