Browse couchbase backups
Select
SaaS
Customer Managed
This API is used to browse couchbase backups.
- application/json
- application/xml
- multipart/form-data
Request Body
- opType integer required
queries object[] required
queryId stringPossible values: [
dataQuery
]paths object[] required
Provide browse path
path stringSubclient content
entity object required
Entity info
subclientId integerSubclient ID
applicationId integerDefault value:
64
clientName stringClient Name
backupsetId integerDefault Backupset ID
instanceId integerInstance ID of the couchbase
clientId integerClient ID of the Couchbase
Request Body
- opType integer
queries object[]
queryId stringpaths object[]
path stringentity object
subclientId integerapplicationId integerclientName stringbackupsetId integerinstanceId integerclientId integer
Request Body
- object
Responses
- 200
- 400
- 401
- 404
OK
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
browseResponses object[]
Browse List
respType integerworkerId stringdoClientSideSortingAndPaging booleansession object
sessionId stringBrowse session ID
browseResult object
queryId stringdataResultSet object[]
List of buckets
displayName stringdisplayPath stringpath stringPath of the bucket
size integermodificationTime integername stringName of the bucket
flags object
Internal fields
isPseudo booleandirectory booleanisFake booleansnap booleanadvancedData object
Advanced data of backed up buckets
backupJobId integerreferenceTime integeroffset integerarchiveGroupId integerobjectGuid stringbackupTime integerarchiveFileId integersubclient object
_type_ integerapplicationId integersourceCommServer object
_type_ integercommCellId integeradvConfig object
recallRequest booleanbrowseAdvancedConfigResp object
commcellNumber integerbrowseMetaData object
indexing object
folderSize integerdmStubData object
guid string
{
"browseResponses": [
{
"respType": 0,
"workerId": "string",
"doClientSideSortingAndPaging": true,
"session": {
"sessionId": "string"
},
"browseResult": {
"queryId": "string",
"dataResultSet": [
{
"displayName": "string",
"displayPath": "string",
"path": "string",
"size": 0,
"modificationTime": 0,
"name": "string",
"flags": {
"isPseudo": true,
"directory": true,
"isFake": true,
"snap": true
},
"advancedData": {
"backupJobId": 0,
"referenceTime": 0,
"offset": 0,
"archiveGroupId": 0,
"objectGuid": "string",
"backupTime": 0,
"archiveFileId": 0,
"subclient": {
"_type_": 0,
"applicationId": 0
},
"sourceCommServer": {
"_type_": 0,
"commCellId": 0
},
"advConfig": {
"recallRequest": true,
"browseAdvancedConfigResp": {
"commcellNumber": 0
}
},
"browseMetaData": {
"indexing": {
"folderSize": 0
},
"dmStubData": {
"guid": "string"
}
}
}
}
]
}
}
]
}
{
"browseResponses": [
{
"respType": 0,
"workerId": "27",
"doClientSideSortingAndPaging": false,
"session": {
"sessionId": "1693305783-27"
},
"browseResult": {
"queryId": "dataQuery",
"dataResultSet": [
{
"displayName": "a.b.c.d.e",
"displayPath": "/a.b.c.d.e",
"path": "/a.b.c.d.e",
"size": 2046246,
"modificationTime": 0,
"name": "a.b.c.d.e",
"flags": {
"isPseudo": false,
"directory": true,
"isFake": true,
"snap": false
},
"advancedData": {
"backupJobId": 278524,
"referenceTime": 1692681411,
"offset": 0,
"archiveGroupId": 10,
"objectGuid": "ee20dde3868f72791ae039a052b5c16d",
"backupTime": 1692681411,
"archiveFileId": 339566,
"subclient": {
"_type_": 7,
"applicationId": 426
},
"sourceCommServer": {
"_type_": 1,
"commCellId": 2
},
"advConfig": {
"recallRequest": false,
"browseAdvancedConfigResp": {
"commcellNumber": 89078054
}
},
"browseMetaData": {
"indexing": {
"folderSize": 2046246
},
"dmStubData": {
"guid": "ee20dde3868f72791ae039a052b5c16d"
}
}
}
},
{
"displayName": "beer-sample",
"displayPath": "/beer-sample",
"path": "/beer-sample",
"size": 209410248,
"modificationTime": 0,
"name": "beer-sample",
"flags": {
"isPseudo": false,
"directory": true,
"isFake": true,
"snap": false
},
"advancedData": {
"backupJobId": 278524,
"referenceTime": 1692681411,
"offset": 0,
"archiveGroupId": 10,
"objectGuid": "15daba6c1d807df8674bbc3366c80bd3",
"backupTime": 1692681411,
"archiveFileId": 339566,
"subclient": {
"_type_": 7,
"applicationId": 426
},
"sourceCommServer": {
"_type_": 1,
"commCellId": 2
},
"advConfig": {
"recallRequest": false,
"browseAdvancedConfigResp": {
"commcellNumber": 89078054
}
},
"browseMetaData": {
"indexing": {
"folderSize": 209410248
},
"dmStubData": {
"guid": "15daba6c1d807df8674bbc3366c80bd3"
}
}
}
},
{
"displayName": "gamesim-sample",
"displayPath": "/gamesim-sample",
"path": "/gamesim-sample",
"size": 47564297,
"modificationTime": 0,
"name": "gamesim-sample",
"flags": {
"isPseudo": false,
"directory": true,
"isFake": true,
"snap": false
},
"advancedData": {
"backupJobId": 278524,
"referenceTime": 1692681411,
"offset": 0,
"archiveGroupId": 10,
"objectGuid": "5311861fc236796c5fb61ed061993ee9",
"backupTime": 1692681411,
"archiveFileId": 339566,
"subclient": {
"_type_": 7,
"applicationId": 426
},
"sourceCommServer": {
"_type_": 1,
"commCellId": 2
},
"advConfig": {
"recallRequest": false,
"browseAdvancedConfigResp": {
"commcellNumber": 89078054
}
},
"browseMetaData": {
"indexing": {
"folderSize": 47564297
},
"dmStubData": {
"guid": "5311861fc236796c5fb61ed061993ee9"
}
}
}
},
{
"displayName": "travel-sample",
"displayPath": "/travel-sample",
"path": "/travel-sample",
"size": 248517835,
"modificationTime": 0,
"name": "travel-sample",
"flags": {
"isPseudo": false,
"directory": true,
"isFake": true,
"snap": false
},
"advancedData": {
"backupJobId": 278524,
"referenceTime": 1692681411,
"offset": 0,
"archiveGroupId": 10,
"objectGuid": "ec8792e6a343dac8942561be52da8307",
"backupTime": 1692681411,
"archiveFileId": 339566,
"subclient": {
"_type_": 7,
"applicationId": 426
},
"sourceCommServer": {
"_type_": 1,
"commCellId": 2
},
"advConfig": {
"recallRequest": false,
"browseAdvancedConfigResp": {
"commcellNumber": 89078054
}
},
"browseMetaData": {
"indexing": {
"folderSize": 248517835
},
"dmStubData": {
"guid": "ec8792e6a343dac8942561be52da8307"
}
}
}
},
{
"displayName": "a.b.c.d.e_1",
"displayPath": "/a.b.c.d.e_1",
"path": "/a.b.c.d.e_1",
"size": 1526205,
"modificationTime": 0,
"name": "a.b.c.d.e_1",
"flags": {
"isPseudo": false,
"directory": true,
"isFake": true,
"snap": false
},
"advancedData": {
"backupJobId": 278524,
"referenceTime": 1692681411,
"offset": 0,
"archiveGroupId": 10,
"objectGuid": "2d0333ce6abbc560784464121ab10780",
"backupTime": 1692681411,
"archiveFileId": 339561,
"subclient": {
"_type_": 7,
"applicationId": 426
},
"sourceCommServer": {
"_type_": 1,
"commCellId": 2
},
"advConfig": {
"recallRequest": false,
"browseAdvancedConfigResp": {
"commcellNumber": 89078054
}
},
"browseMetaData": {
"indexing": {
"folderSize": 1526205
},
"dmStubData": {
"guid": "2d0333ce6abbc560784464121ab10780"
}
}
}
},
{
"displayName": "gamesim-sample_1",
"displayPath": "/gamesim-sample_1",
"path": "/gamesim-sample_1",
"size": 47041275,
"modificationTime": 0,
"name": "gamesim-sample_1",
"flags": {
"isPseudo": false,
"directory": true,
"isFake": true,
"snap": false
},
"advancedData": {
"backupJobId": 278524,
"referenceTime": 1692681411,
"offset": 0,
"archiveGroupId": 10,
"objectGuid": "6220835c7e9588a38095011dd9e9e9ea",
"backupTime": 1692681411,
"archiveFileId": 339561,
"subclient": {
"_type_": 7,
"applicationId": 426
},
"sourceCommServer": {
"_type_": 1,
"commCellId": 2
},
"advConfig": {
"recallRequest": false,
"browseAdvancedConfigResp": {
"commcellNumber": 89078054
}
},
"browseMetaData": {
"indexing": {
"folderSize": 47041275
},
"dmStubData": {
"guid": "6220835c7e9588a38095011dd9e9e9ea"
}
}
}
},
{
"displayName": "a.b.b",
"displayPath": "/a.b.b",
"path": "/a.b.b",
"size": 1525967,
"modificationTime": 0,
"name": "a.b.b",
"flags": {
"isPseudo": false,
"directory": true,
"isFake": true,
"snap": false
},
"advancedData": {
"backupJobId": 278524,
"referenceTime": 1692681411,
"offset": 0,
"archiveGroupId": 10,
"objectGuid": "a7caa4eaff695ef142e8cf7262620c9d",
"backupTime": 1692681411,
"archiveFileId": 339566,
"subclient": {
"_type_": 7,
"applicationId": 426
},
"sourceCommServer": {
"_type_": 1,
"commCellId": 2
},
"advConfig": {
"recallRequest": false,
"browseAdvancedConfigResp": {
"commcellNumber": 89078054
}
},
"browseMetaData": {
"indexing": {
"folderSize": 1525967
},
"dmStubData": {
"guid": "a7caa4eaff695ef142e8cf7262620c9d"
}
}
}
}
]
}
},
{
"respType": 5,
"workerId": "27",
"doClientSideSortingAndPaging": false,
"session": {
"sessionId": "1693305783-27"
}
}
]
}
Bad Request
- application/json
- application/xml
- Schema
- Example (from schema)
Schema
- object
{}
- Schema
- Example 1
Schema
- string
Request body is empty or format is invalid
Unauthorized
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
- errorMessage string
- errorCode integer
{
"errorMessage": "string",
"errorCode": 0
}
{
"errorMessage": "string",
"errorCode": 0
}
Not Found
- application/json
- Schema
- Example (from schema)
- Example 1
Schema
- errorMessage string
- errorCode integer
{
"errorMessage": "string",
"errorCode": 0
}
{
"errorMessage": "string",
"errorCode": 0
}
Loading...