Skip to main content

Browse couchbase backups​

Select

SaaS
Customer Managed

This API is used to browse couchbase backups.

Request Body
  • opType integer required
  • queries object[] required
  • queryId string

    Possible values: [dataQuery]

  • paths object[] required

    Provide browse path

  • path string

    Subclient content

  • entity object required

    Entity info

  • subclientId integer

    Subclient ID

  • applicationId integer

    Default value: 64

  • clientName string

    Client Name

  • backupsetId integer

    Default Backupset ID

  • instanceId integer

    Instance ID of the couchbase

  • clientId integer

    Client ID of the Couchbase

Responses

OK

Schema
  • browseResponses object[]

    Browse List

  • respType integer
  • workerId string
  • doClientSideSortingAndPaging boolean
  • session object
  • sessionId string

    Browse session ID

  • browseResult object
  • queryId string
  • dataResultSet object[]

    List of buckets

  • displayName string
  • displayPath string
  • path string

    Path of the bucket

  • size integer
  • modificationTime integer
  • name string

    Name of the bucket

  • flags object

    Internal fields

  • isPseudo boolean
  • directory boolean
  • isFake boolean
  • snap boolean
  • advancedData object

    Advanced data of backed up buckets

  • 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
  • recallRequest boolean
  • browseAdvancedConfigResp object
  • commcellNumber integer
  • browseMetaData object
  • indexing object
  • folderSize integer
  • dmStubData object
  • guid string
POST /dobrowse

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://localhost/webconsole/api
Security Scheme
token
Content-Type
Body
{

  "opType": 0,

  "queries": [

    {

      "queryId": "dataQuery"

    }

  ],

  "paths": [

    {

      "path": "string"

    }

  ],

  "entity": {

    "subclientId": 0,

    "applicationId": 64,

    "clientName": "string",

    "backupsetId": 0,

    "instanceId": 0,

    "clientId": 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": "dataQuery"
    }
  ],
  "paths": [
    {
      "path": "string"
    }
  ],
  "entity": {
    "subclientId": 0,
    "applicationId": 64,
    "clientName": "string",
    "backupsetId": 0,
    "instanceId": 0,
    "clientId": 0
  }
}'