Select Backup Content

Select

SaaS

Preview the Cloud DB contents for Cosmos Instance

You the output of this API to configure the cosmos instance

application/json

Request Body

• region object required

  id integer

  name string
• cloudAccount object required

  id integer

  name string
• browsePath string

  browse path

Responses

• 200

---

OK

application/json

• Schema
• Example (from schema)
• Example 1
• Example 2
• Example 3

---

Schema

• cloudDBEntity object

  type integer

  children object[]

  path string

  displayName string

  name string

  type integer

  value string
• errorResp object

  errorCode integer

{
  "cloudDBEntity": {
    "type": 0,
    "children": [
      {
        "path": "string",
        "displayName": "string",
        "name": "string",
        "type": 0,
        "value": "string"
      }
    ]
  },
  "errorResp": {
    "errorCode": 0
  }
}

{
  "cloudDBEntity": {
    "type": 17,
    "children": [
      {
        "path": "doshinsky-cosmos-1",
        "displayName": "CosTestDB",
        "name": "CosTestDB",
        "type": 44,
        "value": "eastus"
      },
      {
        "path": "doshinsky-cosmos-1",
        "displayName": "FamilyDatabase",
        "name": "FamilyDatabase",
        "type": 44,
        "value": "eastus"
      },
      {
        "path": "doshinsky-cosmos-1",
        "displayName": "FastDB",
        "name": "FastDB",
        "type": 44,
        "value": "eastus"
      },
      {
        "path": "doshinsky-cosmos-1",
        "displayName": "Volcanoes",
        "name": "Volcanoes",
        "type": 44,
        "value": "eastus"
      },
      {
        "path": "doshinsky-cosmos-1",
        "displayName": "SampleDB",
        "name": "SampleDB",
        "type": 44,
        "value": "eastus"
      }
    ]
  },
  "errorResp": {
    "errorCode": 0
  }
}

{
  "cloudDBEntity": {
    "type": 17,
    "children": [
      {
        "path": "eastus",
        "displayName": "doshinsky-cosmos-1",
        "name": "doshinsky-cosmos-1",
        "type": 52
      }
    ]
  },
  "errorResp": {
    "errorCode": 0
  }
}

{
  "cloudDBEntity": {
    "type": 17,
    "children": [
      {
        "path": "doshinsky-cosmos-1/CosTestDB",
        "displayName": "Volcanodata",
        "name": "Volcanodata",
        "type": 45,
        "value": "eastus"
      }
    ]
  },
  "errorResp": {
    "errorCode": 0
  }
}

POST /v4/azuredb/cosmos/clouddbcontentpreview    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

tokenbearerToken

token

Body

• Default
• Example 1
• Example 2
• Example 3

---

{
  "region": {
    "id": 0,
    "name": "string"
  },
  "cloudAccount": {
    "id": 0,
    "name": "string"
  },
  "browsePath": "string"
}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/azuredb/cosmos/clouddbcontentpreview' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "region": {
    "id": 0,
    "name": "string"
  },
  "cloudAccount": {
    "id": 0,
    "name": "string"
  },
  "browsePath": "string"
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/azuredb/cosmos/clouddbcontentpreview' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "region": {
    "id": 0,
    "name": "string"
  },
  "cloudAccount": {
    "id": 0,
    "name": "string"
  },
  "browsePath": "string"
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/azuredb/cosmos/clouddbcontentpreview' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "region": {
    "id": 0,
    "name": "string"
  },
  "cloudAccount": {
    "id": 0,
    "name": "string"
  },
  "browsePath": "string"
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/azuredb/cosmos/clouddbcontentpreview' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "region": {
    "id": 0,
    "name": "string"
  },
  "cloudAccount": {
    "id": 0,
    "name": "string"
  },
  "browsePath": "string"
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/azuredb/cosmos/clouddbcontentpreview' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "region": {
    "id": 0,
    "name": "string"
  },
  "cloudAccount": {
    "id": 0,
    "name": "string"
  },
  "browsePath": "string"
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/azuredb/cosmos/clouddbcontentpreview' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "region": {
    "id": 0,
    "name": "string"
  },
  "cloudAccount": {
    "id": 0,
    "name": "string"
  },
  "browsePath": "string"
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/azuredb/cosmos/clouddbcontentpreview' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "region": {
    "id": 0,
    "name": "string"
  },
  "cloudAccount": {
    "id": 0,
    "name": "string"
  },
  "browsePath": "string"
}'