Browse YugabyteDB backups

Select

SaaS

Customer Managed

This API is used to browse YugabyteDB backups

application/json

Request Body

• opType integer
• queries object[]

  queryId string
• paths object[]

  path string
• advOptions object

  browseViewName string
• timeRange object
• entity object

  clientId integer

  applicationId integer

  backupsetId integer

  instanceId integer

  subclientId integer

Responses

• 200
• 400
• 401
• 404

---

OK

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• browseResponses object[]

  respType integer

  workerId string

  doClientSideSortingAndPaging boolean

  session object

  sessionId string

  browseResult object

  hasMoreData boolean

  useLazyPaginationMode boolean

  queryId string

  dataResultSet object[]

  displayName string

  displayPath string

  path string

  size integer

  modificationTime integer

  name string

  flags object

  isPseudo boolean

  directory boolean

  isFake boolean

  snap boolean

  advancedData object

  backupJobId integer

  referenceTime integer

  offset integer

  archiveGroupId integer

  objectGuid string

  backupTime integer

  archiveFileId integer

  subclient object

  _type_ integer

  applicationId integer

  sourceCommServer object

  _type_ integer

  commCellId integer

  advConfig object

  recallByPathRequest boolean

  doCrossComponentBrowseNarrowing boolean

  recallRequest boolean

  browseAdvancedConfigResp object

  commcellNumber integer

  browseMetaData object

  indexing object

  folderSize integer

  yugabyteDBMetadata object

  type integer

  backupType string

  dmStubData object

  guid string

{
  "browseResponses": [
    {
      "respType": 0,
      "workerId": "string",
      "doClientSideSortingAndPaging": true,
      "session": {
        "sessionId": "string"
      },
      "browseResult": {
        "hasMoreData": true,
        "useLazyPaginationMode": true,
        "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": {
                "recallByPathRequest": true,
                "doCrossComponentBrowseNarrowing": true,
                "recallRequest": true,
                "browseAdvancedConfigResp": {
                  "commcellNumber": 0
                }
              },
              "browseMetaData": {
                "indexing": {
                  "folderSize": 0
                },
                "yugabyteDBMetadata": {
                  "type": 0,
                  "backupType": "string"
                },
                "dmStubData": {
                  "guid": "string"
                }
              }
            }
          }
        ]
      }
    }
  ]
}

{
  "browseResponses": [
    {
      "respType": 0,
      "workerId": "34",
      "doClientSideSortingAndPaging": false,
      "session": {
        "sessionId": "1733987213-34"
      },
      "browseResult": {
        "hasMoreData": false,
        "useLazyPaginationMode": false,
        "queryId": "dataQuery",
        "dataResultSet": [
          {
            "displayName": "29t1.cql",
            "displayPath": "/29t1.cql",
            "path": "/29t1.cql",
            "size": 0,
            "modificationTime": 1733986833,
            "name": "29t1.cql",
            "flags": {
              "isPseudo": false,
              "directory": true,
              "isFake": false,
              "snap": false
            },
            "advancedData": {
              "backupJobId": 1042,
              "referenceTime": 1733986844,
              "offset": 1,
              "archiveGroupId": 10,
              "objectGuid": "f132bba25bc8b86fefaf6485dee2f057",
              "backupTime": 1733986844,
              "archiveFileId": 42618,
              "subclient": {
                "_type_": 7,
                "applicationId": 54
              },
              "sourceCommServer": {
                "_type_": 1,
                "commCellId": 2
              },
              "advConfig": {
                "recallByPathRequest": false,
                "doCrossComponentBrowseNarrowing": true,
                "recallRequest": false,
                "browseAdvancedConfigResp": {
                  "commcellNumber": 212649303
                }
              },
              "browseMetaData": {
                "indexing": {
                  "folderSize": 0
                },
                "yugabyteDBMetadata": {
                  "type": 1,
                  "backupType": "YQL_TABLE_TYPE"
                },
                "dmStubData": {
                  "guid": "e867d7213e523a2fbbbbeabe4de48855"
                }
              }
            }
          },
          {
            "displayName": "29t5.cql",
            "displayPath": "/29t5.cql",
            "path": "/29t5.cql",
            "size": 0,
            "modificationTime": 1733986833,
            "name": "29t5.cql",
            "flags": {
              "isPseudo": false,
              "directory": true,
              "isFake": false,
              "snap": false
            },
            "advancedData": {
              "backupJobId": 1042,
              "referenceTime": 1733986844,
              "offset": 4,
              "archiveGroupId": 10,
              "objectGuid": "591d92ff2e0b9bda23588322e2302d52",
              "backupTime": 1733986844,
              "archiveFileId": 42618,
              "subclient": {
                "_type_": 7,
                "applicationId": 54
              },
              "sourceCommServer": {
                "_type_": 1,
                "commCellId": 2
              },
              "advConfig": {
                "recallByPathRequest": false,
                "doCrossComponentBrowseNarrowing": true,
                "recallRequest": false,
                "browseAdvancedConfigResp": {
                  "commcellNumber": 212649303
                }
              },
              "browseMetaData": {
                "indexing": {
                  "folderSize": 0
                },
                "yugabyteDBMetadata": {
                  "type": 1,
                  "backupType": "YQL_TABLE_TYPE"
                },
                "dmStubData": {
                  "guid": "a7e559b97db335c77b5b17300a1be260"
                }
              }
            }
          }
        ]
      }
    },
    {
      "respType": 5,
      "workerId": "34",
      "doClientSideSortingAndPaging": false,
      "session": {
        "sessionId": "1733987213-34"
      }
    }
  ]
}

Bad Request

application/json

• Schema
• Example (from schema)

---

Schema

• object

{}

application/xml

• 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
}

POST /dobrowse    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://localhost/webconsole/api

token

Body

• Default
• Example 1

---

{
  "opType": 0,
  "queries": [
    {
      "queryId": "string"
    }
  ],
  "paths": [
    {
      "path": "string"
    }
  ],
  "advOptions": {
    "browseViewName": "string"
  },
  "timeRange": {},
  "entity": {
    "clientId": 0,
    "applicationId": 0,
    "backupsetId": 0,
    "instanceId": 0,
    "subclientId": 0
  }
}

curl -L -X POST 'https://localhost/webconsole/api/DoBrowse' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "opType": 0,
  "queries": [
    {
      "queryId": "string"
    }
  ],
  "paths": [
    {
      "path": "string"
    }
  ],
  "advOptions": {
    "browseViewName": "string"
  },
  "timeRange": {},
  "entity": {
    "clientId": 0,
    "applicationId": 0,
    "backupsetId": 0,
    "instanceId": 0,
    "subclientId": 0
  }
}'

curl -L -X POST 'https://localhost/webconsole/api/DoBrowse' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "opType": 0,
  "queries": [
    {
      "queryId": "string"
    }
  ],
  "paths": [
    {
      "path": "string"
    }
  ],
  "advOptions": {
    "browseViewName": "string"
  },
  "timeRange": {},
  "entity": {
    "clientId": 0,
    "applicationId": 0,
    "backupsetId": 0,
    "instanceId": 0,
    "subclientId": 0
  }
}'

curl -L -X POST 'https://localhost/webconsole/api/DoBrowse' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "opType": 0,
  "queries": [
    {
      "queryId": "string"
    }
  ],
  "paths": [
    {
      "path": "string"
    }
  ],
  "advOptions": {
    "browseViewName": "string"
  },
  "timeRange": {},
  "entity": {
    "clientId": 0,
    "applicationId": 0,
    "backupsetId": 0,
    "instanceId": 0,
    "subclientId": 0
  }
}'

curl -L -X POST 'https://localhost/webconsole/api/DoBrowse' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "opType": 0,
  "queries": [
    {
      "queryId": "string"
    }
  ],
  "paths": [
    {
      "path": "string"
    }
  ],
  "advOptions": {
    "browseViewName": "string"
  },
  "timeRange": {},
  "entity": {
    "clientId": 0,
    "applicationId": 0,
    "backupsetId": 0,
    "instanceId": 0,
    "subclientId": 0
  }
}'

curl -L -X POST 'https://localhost/webconsole/api/DoBrowse' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "opType": 0,
  "queries": [
    {
      "queryId": "string"
    }
  ],
  "paths": [
    {
      "path": "string"
    }
  ],
  "advOptions": {
    "browseViewName": "string"
  },
  "timeRange": {},
  "entity": {
    "clientId": 0,
    "applicationId": 0,
    "backupsetId": 0,
    "instanceId": 0,
    "subclientId": 0
  }
}'

curl -L -X POST 'https://localhost/webconsole/api/DoBrowse' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "opType": 0,
  "queries": [
    {
      "queryId": "string"
    }
  ],
  "paths": [
    {
      "path": "string"
    }
  ],
  "advOptions": {
    "browseViewName": "string"
  },
  "timeRange": {},
  "entity": {
    "clientId": 0,
    "applicationId": 0,
    "backupsetId": 0,
    "instanceId": 0,
    "subclientId": 0
  }
}'

curl -L -X POST 'https://localhost/webconsole/api/DoBrowse' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "opType": 0,
  "queries": [
    {
      "queryId": "string"
    }
  ],
  "paths": [
    {
      "path": "string"
    }
  ],
  "advOptions": {
    "browseViewName": "string"
  },
  "timeRange": {},
  "entity": {
    "clientId": 0,
    "applicationId": 0,
    "backupsetId": 0,
    "instanceId": 0,
    "subclientId": 0
  }
}'