Browse backed up DocumentDB snapshots

Select

SaaS

Customer Managed

This operation browses and returns backed up Document DB snapshots

application/json

Request Body

• entity object

  displayName string

  Name of cloud account

  clientId integer

  instanceName string required

  Name of instance

  appName string

  applicationId integer

  clientName string required

  Name of cloud account

  instanceId integer
• startTime integer required

  Start time from when to browse snapshots

• endTime integer required

  End time till which to browse snapshots

• includeAgedData integer
• copyPrecedence integer
• regionCode string required

  Name of AWS region

Responses

• 200

---

OK

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• snapList object[]

  copyId integer

  commcellId integer

  createTime integer

  dbName string

  dbType string

  archFileId integer

  snapShotName string

  status integer

  rdsAttributes object

  vpcSecurityGroup string

  instanceType string

  parameterGroup string

  availabilityZone string

  service string

  dbSubnetGroup string

{
  "snapList": [
    {
      "copyId": 0,
      "commcellId": 0,
      "createTime": 0,
      "dbName": "string",
      "dbType": "string",
      "archFileId": 0,
      "snapShotName": "string",
      "status": 0,
      "rdsAttributes": {
        "vpcSecurityGroup": "string",
        "instanceType": "string",
        "parameterGroup": "string",
        "availabilityZone": "string",
        "service": "string",
        "dbSubnetGroup": "string"
      }
    }
  ]
}

{
  "snapList": [
    {
      "copyId": 0,
      "commcellId": 0,
      "createTime": 0,
      "dbName": "string",
      "dbType": "string",
      "archFileId": 0,
      "snapShotName": "string",
      "status": 0,
      "rdsAttributes": {
        "vpcSecurityGroup": "string",
        "instanceType": "string",
        "parameterGroup": "string",
        "availabilityZone": "string",
        "service": "string",
        "dbSubnetGroup": "string"
      }
    }
  ]
}

POST /browserdsbackups    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://ServerURL/commandcenter/api

Security Scheme

tokenbearerToken

token

Body

• Default
• Example 1

---

{
  "entity": {
    "displayName": "string",
    "clientId": 0,
    "instanceName": "string",
    "appName": "string",
    "applicationId": 0,
    "clientName": "string",
    "instanceId": 0
  },
  "startTime": 0,
  "endTime": 0,
  "includeAgedData": 0,
  "copyPrecedence": 0,
  "regionCode": "string"
}

curl -L -X POST 'https://ServerURL/commandcenter/api/BrowseRDSBackups' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "entity": {
    "displayName": "string",
    "clientId": 0,
    "instanceName": "string",
    "appName": "string",
    "applicationId": 0,
    "clientName": "string",
    "instanceId": 0
  },
  "startTime": 0,
  "endTime": 0,
  "includeAgedData": 0,
  "copyPrecedence": 0,
  "regionCode": "string"
}'

curl -L -X POST 'https://ServerURL/commandcenter/api/BrowseRDSBackups' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "entity": {
    "displayName": "string",
    "clientId": 0,
    "instanceName": "string",
    "appName": "string",
    "applicationId": 0,
    "clientName": "string",
    "instanceId": 0
  },
  "startTime": 0,
  "endTime": 0,
  "includeAgedData": 0,
  "copyPrecedence": 0,
  "regionCode": "string"
}'

curl -L -X POST 'https://ServerURL/commandcenter/api/BrowseRDSBackups' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "entity": {
    "displayName": "string",
    "clientId": 0,
    "instanceName": "string",
    "appName": "string",
    "applicationId": 0,
    "clientName": "string",
    "instanceId": 0
  },
  "startTime": 0,
  "endTime": 0,
  "includeAgedData": 0,
  "copyPrecedence": 0,
  "regionCode": "string"
}'

curl -L -X POST 'https://ServerURL/commandcenter/api/BrowseRDSBackups' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "entity": {
    "displayName": "string",
    "clientId": 0,
    "instanceName": "string",
    "appName": "string",
    "applicationId": 0,
    "clientName": "string",
    "instanceId": 0
  },
  "startTime": 0,
  "endTime": 0,
  "includeAgedData": 0,
  "copyPrecedence": 0,
  "regionCode": "string"
}'

curl -L -X POST 'https://ServerURL/commandcenter/api/BrowseRDSBackups' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "entity": {
    "displayName": "string",
    "clientId": 0,
    "instanceName": "string",
    "appName": "string",
    "applicationId": 0,
    "clientName": "string",
    "instanceId": 0
  },
  "startTime": 0,
  "endTime": 0,
  "includeAgedData": 0,
  "copyPrecedence": 0,
  "regionCode": "string"
}'

curl -L -X POST 'https://ServerURL/commandcenter/api/BrowseRDSBackups' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "entity": {
    "displayName": "string",
    "clientId": 0,
    "instanceName": "string",
    "appName": "string",
    "applicationId": 0,
    "clientName": "string",
    "instanceId": 0
  },
  "startTime": 0,
  "endTime": 0,
  "includeAgedData": 0,
  "copyPrecedence": 0,
  "regionCode": "string"
}'

curl -L -X POST 'https://ServerURL/commandcenter/api/BrowseRDSBackups' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "entity": {
    "displayName": "string",
    "clientId": 0,
    "instanceName": "string",
    "appName": "string",
    "applicationId": 0,
    "clientName": "string",
    "instanceId": 0
  },
  "startTime": 0,
  "endTime": 0,
  "includeAgedData": 0,
  "copyPrecedence": 0,
  "regionCode": "string"
}'