Get Page 8
Endpoint to get backups for database
Authorized Roles : PROVIDER or ORG_ADMIN or ORG_USER
Request
URI
GET
https://{api_host}/provider/backups
COPY
Query Parameters
integer
page
Optional
Constraints:
minimum: 0
default: 0
Zero-based page index (0..N)
integer
size
Optional
Constraints:
minimum: 1
default: 20
The size of the page to be returned
string of
array
sort
Optional
Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
string
db
Optional
ID of the database
string
instanceName
Optional
Filter based on instance name
string
backupName
Optional
Filter based on backup name
string of
array
availability
Optional
Filter based on availability
string of
array
types
Optional
Filter based on type
string of
array
statuses
Optional
Filter based on statuses
integer of
array
userIds
Optional
Filter based on users ids
Responses
200
OK
Returns
PagedModelBackupDTO
of type(s)
application/vnd.vmware.dms-v1+json
{
"links": [
{
"rel": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string"
}
],
"content": [
{
"backupId": "string",
"backupChainId": "string",
"backupName": "string",
"backupInstanceType": "string",
"backupChainStatus": "string",
"metaData": "string",
"metaDataType": "string",
"s3Path": "string",
"isLocalAvailable": false,
"localStatus": "string",
"isCloudAvailable": false,
"cloudStatus": "string",
"snapshotCreationTime": "string",
"user": {
"id": 0,
"firstName": "string",
"lastName": "string",
"contactNumber": "string",
"email": "string",
"password": "string",
"tenantId": "string",
"companyName": "string",
"type": "string",
"roles": [
"string"
],
"forcePasswordChange": false,
"links": [
{
"rel": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string"
}
]
},
"tenantId": "string",
"environmentId": "string",
"protectionId": "string",
"dataStoreMor": "string",
"logicalBuildId": "string",
"dbId": "string",
"dbInstanceName": "string",
"dbRole": "string",
"automated": false,
"links": [
{
"rel": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string"
}
]
}
],
"page": {
"size": 0,
"totalElements": 0,
"totalPages": 0,
"number": 0
}
}
array of
object
links
Optional
links
array of
object
content
Optional
content
object
page
Optional
page
400
Bad Request
Operation doesn't return any data structure
Code Samples
COPY
curl -H 'Authorization: <value>' https://{api_host}/provider/backups