Configure Backup Client for CosmosDB Instance

Select

SaaS

This API creates a Cosmos Cloud DB Instance on metallic azure.

Cloud DB Content is optional . If not provided all containers in the DB are backed up.

application/json

Request Body

• cloudAccount object required

  cloud account name or id

  id integer

  name string
• region object required

  region id or name

  id integer
• plan object required

  plan name or id

  id integer
• backupGateways object[]

  backup gateway name or id

  id integer

  name string
• cloudDBContent object

  cloud DB content to be backed up. Payload contains the Array of the contents of the Cosmos DB that should be explicitly backed up. We get this from cloudDBContentPreview API for COSMOS DB.

  children object[]

  Copy from select backup content

  path string

  DB

  displayName string

  name string

  type string

  value string

Responses

• 200
• 500

---

OK

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• instance object

  id integer

  name string

{
  "instance": {
    "id": 0,
    "name": "string"
  }
}

{
  "instance": {
    "id": 1752,
    "name": "SQL API [eastus]"
  }
}

Internal Server Error

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• errorMessage string
• errorCode integer
• entity object

  subclientId integer

  clientId integer

  instanceName string

  instanceId integer

  _type_ integer

{
  "errorMessage": "string",
  "errorCode": 0,
  "entity": {
    "subclientId": 0,
    "clientId": 0,
    "instanceName": "string",
    "instanceId": 0,
    "_type_": 0
  }
}

{
  "errorMessage": "An instance by this name already exists.",
  "errorCode": 3,
  "entity": {
    "subclientId": 0,
    "clientId": 2038,
    "instanceName": "sqlami-eastus.0b6ca3d85c3b.database.windows.net",
    "instanceId": -1,
    "_type_": 0
  }
}

POST /v4/azuredb/cosmos/instance    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

tokenbearerToken

token

Body

• Default
• Example 1

---

{
  "cloudAccount": {
    "id": 0,
    "name": "string"
  },
  "region": {
    "id": 0
  },
  "plan": {
    "id": 0
  },
  "backupGateways": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "cloudDBContent": {
    "children": [
      {
        "path": "string",
        "displayName": "string",
        "name": "string",
        "type": "string",
        "value": "string"
      }
    ]
  }
}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/azuredb/cosmos/instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "cloudAccount": {
    "id": 0,
    "name": "string"
  },
  "region": {
    "id": 0
  },
  "plan": {
    "id": 0
  },
  "backupGateways": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "cloudDBContent": {
    "children": [
      {
        "path": "string",
        "displayName": "string",
        "name": "string",
        "type": "string",
        "value": "string"
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/azuredb/cosmos/instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "cloudAccount": {
    "id": 0,
    "name": "string"
  },
  "region": {
    "id": 0
  },
  "plan": {
    "id": 0
  },
  "backupGateways": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "cloudDBContent": {
    "children": [
      {
        "path": "string",
        "displayName": "string",
        "name": "string",
        "type": "string",
        "value": "string"
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/azuredb/cosmos/instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "cloudAccount": {
    "id": 0,
    "name": "string"
  },
  "region": {
    "id": 0
  },
  "plan": {
    "id": 0
  },
  "backupGateways": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "cloudDBContent": {
    "children": [
      {
        "path": "string",
        "displayName": "string",
        "name": "string",
        "type": "string",
        "value": "string"
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/azuredb/cosmos/instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "cloudAccount": {
    "id": 0,
    "name": "string"
  },
  "region": {
    "id": 0
  },
  "plan": {
    "id": 0
  },
  "backupGateways": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "cloudDBContent": {
    "children": [
      {
        "path": "string",
        "displayName": "string",
        "name": "string",
        "type": "string",
        "value": "string"
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/azuredb/cosmos/instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "cloudAccount": {
    "id": 0,
    "name": "string"
  },
  "region": {
    "id": 0
  },
  "plan": {
    "id": 0
  },
  "backupGateways": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "cloudDBContent": {
    "children": [
      {
        "path": "string",
        "displayName": "string",
        "name": "string",
        "type": "string",
        "value": "string"
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/azuredb/cosmos/instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "cloudAccount": {
    "id": 0,
    "name": "string"
  },
  "region": {
    "id": 0
  },
  "plan": {
    "id": 0
  },
  "backupGateways": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "cloudDBContent": {
    "children": [
      {
        "path": "string",
        "displayName": "string",
        "name": "string",
        "type": "string",
        "value": "string"
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/azuredb/cosmos/instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "cloudAccount": {
    "id": 0,
    "name": "string"
  },
  "region": {
    "id": 0
  },
  "plan": {
    "id": 0
  },
  "backupGateways": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "cloudDBContent": {
    "children": [
      {
        "path": "string",
        "displayName": "string",
        "name": "string",
        "type": "string",
        "value": "string"
      }
    ]
  }
}'