Get Unconfigured Instances

Select

SaaS

Customer Managed

This operation performs an instance discovery on a client and returns any unconfigured instances

Path Parameters

• clientId integer required

  ID of the client where discovery happens

Responses

• 200
• 401

---

OK

application/json

• Schema
• Example (from schema)
• Example
• No instance left to configure

---

Schema

• processinginstructioninfo object

  attributes object[]

  name string

  value string
• sqlDiscoveredServer object[]

  buildVersion integer

  serverType string

  servername string

  fullversion string

  majorVersion integer

  minorVersion integer

{
  "processinginstructioninfo": {
    "attributes": [
      {
        "name": "string",
        "value": "string"
      }
    ]
  },
  "sqlDiscoveredServer": [
    {
      "buildVersion": 0,
      "serverType": "string",
      "servername": "string",
      "fullversion": "string",
      "majorVersion": 0,
      "minorVersion": 0
    }
  ]
}

{
  "processinginstructioninfo": {
    "attributes": [
      {
        "name": "exitval",
        "value": "0"
      }
    ]
  },
  "sqlDiscoveredServer": [
    {
      "buildVersion": 1601,
      "serverType": "Analysis Services",
      "servername": "MANDO-SQL1\\INSTANCE1(Analysis Services)",
      "fullversion": "13.0.1601.5",
      "majorVersion": 13,
      "minorVersion": 0
    }
  ]
}

{
  "processinginstructioninfo": {
    "attributes": [
      {
        "name": "exitval",
        "value": "0"
      }
    ]
  }
}

Unauthorized

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• errorMessage string

  Default value: Access denied

• errorCode integer

  Default value: 5

{
  "errorMessage": "Access denied",
  "errorCode": 5
}

{
  "errorMessage": "Access denied",
  "errorCode": 5
}

GET /client/:clientid/sql/unconfiguredservers    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

tokenbearerToken

token

clientId — path required

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/Client/:clientId/Sql/unconfiguredServers' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/Client/:clientId/Sql/unconfiguredServers' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/Client/:clientId/Sql/unconfiguredServers' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/Client/:clientId/Sql/unconfiguredServers' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/Client/:clientId/Sql/unconfiguredServers' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/Client/:clientId/Sql/unconfiguredServers' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/Client/:clientId/Sql/unconfiguredServers' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'