Configure Backup Client Azure MSSQL

Select

SaaS

Customer Managed

This API creates Cloud Database Instance for SQL Server.

All the databases in the SQL Server instance will be backed up after creation

application/json

Request Body

oneOf
• CreateMSSQL-SaaS
• CreateMSSQL-CustomerManaged
---
region object required
id integer
name string
instanceName string required
MSSQL server instance name
connectionString string
MSSQL storage connection string.
This is optional and required only for managed azure sql instance
credential object required
id integer required
MSSQL credential ID
name string required
MSSQL Credential Name
cloudAccount object required
id integer
name string
plan object required
id integer
name string
backupGateways object[]
List of backup Gateways or Access Nodes. Not needed for direct backup to cloud
id integer
name string
instanceName string required
MSSQL server instance name
Use Select Database instance to get this
connectionString string required
MSSQL DB storage Connection string
credential object required
id integer required
MSSQL Credential ID
name string required
MSSQL Credential name
cloudAccount object required
id integer
name string
plan object required
id integer
name string

Responses

• 200

---

OK

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• instance object

  id integer

  name string

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

{
  "instance": {
    "name": "sqlami-eastus.0b6ca3d85c3b.database.windows.net",
    "id": 1748
  }
}

POST /v4/azuredb/mssql/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

---

{
  "region": {
    "id": 0,
    "name": "string"
  },
  "instanceName": "string",
  "connectionString": "string",
  "credential": {
    "id": 0,
    "name": "string"
  },
  "cloudAccount": {
    "id": 0,
    "name": "string"
  },
  "plan": {
    "id": 0,
    "name": "string"
  },
  "backupGateways": [
    {
      "id": 0,
      "name": "string"
    }
  ]
}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/azuredb/mssql/Instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "region": {
    "id": 0,
    "name": "string"
  },
  "instanceName": "string",
  "connectionString": "string",
  "credential": {
    "id": 0,
    "name": "string"
  },
  "cloudAccount": {
    "id": 0,
    "name": "string"
  },
  "plan": {
    "id": 0,
    "name": "string"
  },
  "backupGateways": [
    {
      "id": 0,
      "name": "string"
    }
  ]
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/azuredb/mssql/Instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "region": {
    "id": 0,
    "name": "string"
  },
  "instanceName": "string",
  "connectionString": "string",
  "credential": {
    "id": 0,
    "name": "string"
  },
  "cloudAccount": {
    "id": 0,
    "name": "string"
  },
  "plan": {
    "id": 0,
    "name": "string"
  },
  "backupGateways": [
    {
      "id": 0,
      "name": "string"
    }
  ]
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/azuredb/mssql/Instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "region": {
    "id": 0,
    "name": "string"
  },
  "instanceName": "string",
  "connectionString": "string",
  "credential": {
    "id": 0,
    "name": "string"
  },
  "cloudAccount": {
    "id": 0,
    "name": "string"
  },
  "plan": {
    "id": 0,
    "name": "string"
  },
  "backupGateways": [
    {
      "id": 0,
      "name": "string"
    }
  ]
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/azuredb/mssql/Instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "region": {
    "id": 0,
    "name": "string"
  },
  "instanceName": "string",
  "connectionString": "string",
  "credential": {
    "id": 0,
    "name": "string"
  },
  "cloudAccount": {
    "id": 0,
    "name": "string"
  },
  "plan": {
    "id": 0,
    "name": "string"
  },
  "backupGateways": [
    {
      "id": 0,
      "name": "string"
    }
  ]
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/azuredb/mssql/Instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "region": {
    "id": 0,
    "name": "string"
  },
  "instanceName": "string",
  "connectionString": "string",
  "credential": {
    "id": 0,
    "name": "string"
  },
  "cloudAccount": {
    "id": 0,
    "name": "string"
  },
  "plan": {
    "id": 0,
    "name": "string"
  },
  "backupGateways": [
    {
      "id": 0,
      "name": "string"
    }
  ]
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/azuredb/mssql/Instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "region": {
    "id": 0,
    "name": "string"
  },
  "instanceName": "string",
  "connectionString": "string",
  "credential": {
    "id": 0,
    "name": "string"
  },
  "cloudAccount": {
    "id": 0,
    "name": "string"
  },
  "plan": {
    "id": 0,
    "name": "string"
  },
  "backupGateways": [
    {
      "id": 0,
      "name": "string"
    }
  ]
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/azuredb/mssql/Instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "region": {
    "id": 0,
    "name": "string"
  },
  "instanceName": "string",
  "connectionString": "string",
  "credential": {
    "id": 0,
    "name": "string"
  },
  "cloudAccount": {
    "id": 0,
    "name": "string"
  },
  "plan": {
    "id": 0,
    "name": "string"
  },
  "backupGateways": [
    {
      "id": 0,
      "name": "string"
    }
  ]
}'