Browse Databricks backups

This API is used to browse Databricks backups.

application/json
application/xml
multipart/form-data

Request Body

opType integer
queries object[]
type integer
queryId string
paths object[]
path string required
options object
restoreIndex boolean
skipIndexRestore boolean
hideUserHidden boolean
clusterType string
advOptions object
browseViewName string required
Name of the browse view.
timeRange object
toTime integer required
Backup time for restore
entity object
subclientId integer required
ID of databricks subclient
applicationId integer required
Databricks app ID
backupsetId integer required
Databricks backupset ID
clientId integer required
Databricks client ID
instanceId integer required
Databricks instance ID

Responses

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
mediaSize integer
jobFlags integer
referenceTime integer
jobType integer
offset integer
archiveGroupId integer
objectGuid string
backupTime integer
archiveFileId integer
subclient object
_type_ integer
_SubclType_ integer
applicationId integer
sourceCommServer object
_type_ integer
commCellId integer
advConfig object
recallByPathRequest boolean
doCrossComponentBrowseNarrowing boolean
recallRequest boolean
browseAdvancedConfigResp object
commcellNumber integer
browseMetaData object
databricksMetadata object
objectSize integer
type integer
indexing object
folderSize integer
dmStubData object
guid string
aggrResultSet object[]
result integer
groupbyValue string
clientName string
count integer

{
  "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,
              "mediaSize": 0,
              "jobFlags": 0,
              "referenceTime": 0,
              "jobType": 0,
              "offset": 0,
              "archiveGroupId": 0,
              "objectGuid": "string",
              "backupTime": 0,
              "archiveFileId": 0,
              "subclient": {
                "_type_": 0,
                "_SubclType_": 0,
                "applicationId": 0
              },
              "sourceCommServer": {
                "_type_": 0,
                "commCellId": 0
              },
              "advConfig": {
                "recallByPathRequest": true,
                "doCrossComponentBrowseNarrowing": true,
                "recallRequest": true,
                "browseAdvancedConfigResp": {
                  "commcellNumber": 0
                }
              },
              "browseMetaData": {
                "databricksMetadata": {
                  "objectSize": 0,
                  "type": 0
                },
                "indexing": {
                  "folderSize": 0
                },
                "dmStubData": {
                  "guid": "string"
                }
              }
            }
          }
        ],
        "aggrResultSet": [
          {
            "result": 0,
            "groupbyValue": "string",
            "clientName": "string",
            "count": 0
          }
        ]
      }
    }
  ]
}

{
  "browseResponses": [
    {
      "respType": 0,
      "workerId": "193",
      "doClientSideSortingAndPaging": false,
      "session": {
        "sessionId": "1787295358-193"
      },
      "browseResult": {
        "hasMoreData": false,
        "useLazyPaginationMode": false,
        "queryId": "0",
        "dataResultSet": [
          {
            "displayName": "workspace_s",
            "displayPath": "/workspace_s",
            "path": "/workspace_s",
            "size": 0,
            "modificationTime": 1787171341,
            "name": "workspace_s",
            "flags": {
              "isPseudo": false,
              "directory": true,
              "isFake": false,
              "snap": false
            },
            "advancedData": {
              "backupJobId": 224960,
              "mediaSize": 0,
              "jobFlags": 0,
              "referenceTime": 1787171387,
              "jobType": 2,
              "offset": 1,
              "archiveGroupId": 79,
              "objectGuid": "631e28ba0abeb429bef5b6dccd191a03",
              "backupTime": 1787171387,
              "archiveFileId": 2715164,
              "subclient": {
                "_type_": 7,
                "_SubclType_": 0,
                "applicationId": 1330
              },
              "sourceCommServer": {
                "_type_": 1,
                "commCellId": 2
              },
              "advConfig": {
                "recallByPathRequest": false,
                "doCrossComponentBrowseNarrowing": true,
                "recallRequest": false,
                "browseAdvancedConfigResp": {
                  "commcellNumber": 212649303
                }
              },
              "browseMetaData": {
                "databricksMetadata": {
                  "objectSize": 608623934432,
                  "type": 4
                },
                "indexing": {
                  "folderSize": 0
                },
                "dmStubData": {
                  "guid": "1c6bab8e07e8271f8e35948744c6b169"
                }
              }
            }
          }
        ]
      }
    },
    {
      "respType": 0,
      "workerId": "193",
      "doClientSideSortingAndPaging": false,
      "session": {
        "sessionId": "1787295358-193"
      },
      "browseResult": {
        "hasMoreData": false,
        "useLazyPaginationMode": false,
        "queryId": "1",
        "aggrResultSet": [
          {
            "result": 1,
            "groupbyValue": "",
            "clientName": "",
            "count": 1
          }
        ]
      }
    },
    {
      "respType": 5,
      "workerId": "193",
      "doClientSideSortingAndPaging": false,
      "session": {
        "sessionId": "1787295358-193"
      }
    }
  ]
}

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
}

Browse Databricks backups​

Browse Databricks backups