Backup Files Controller Resource

The API allows you to view backup locations.

GET /backup-locations

Returns list of backup locations filtered by specified query parameters.

Request Parameters
name type description constraints
backup-rule query  
location-status query "FAILED" or "IN_PROGRESS" or "PRESENT" or "REMOVED"
project-uuid query  
protected-entity query  
Response Body
media type data type description
application/json array of BackupLocationListRecord (JSON) list of backup locations filtered by specified query parameters

Example

Request
GET /backup-locations
Content-Type: */*
Accept: application/json

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

                
[ { } ]

GET /backup-locations/for-restore

Returns list of backup locations for restore filtered by specified query parameters.

Request Parameters
name type description constraints
backup-rule query  
location-status query "FAILED" or "IN_PROGRESS" or "PRESENT" or "REMOVED"
project-uuid query  
protected-entity query  
Response Body
media type data type description
application/json array of BackupLocationForRestoreListRecord (JSON) list of backup locations filtered by specified query parameters

Example

Request
GET /backup-locations/for-restore
Content-Type: */*
Accept: application/json

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

                
[ { } ]

GET /backup-locations/{guid}

Return backup location with specified GUID

Request Parameters
name type description
guid path Guid of backup location
Response Body
media type data type description
application/json BackupLocationDetails (JSON) backup location details

Example

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

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

                
{ }

PUT /backup-locations/{guid}

Returns updated backuplocation.

Request Parameters
name type description
guid path
Request Body
media type data type description
application/json BackupLocationRequest (JSON) guid and new status for backuplocation
Response Body
media type data type description
application/json BackupLocationDetails (JSON) updated backup location details

Example

Request
PUT /backup-locations/{guid}
Content-Type: application/json
Accept: application/json

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

                
{ }