Skip to main content

List all SQL instances​

Select

SaaS
Customer Managed

This operation returns all configured MSSQL instances

Responses

OK

Schema
  • SqlInstance object[]
  • notReadyReason string

    Not ready reason for instance, if applicable

  • insName string

    Instance name

  • sla integer

    SLA for the instance

  • planName string

    Plan associated with instance

  • unprot integer

    Number of unprotected databases in the instance

  • version string

    SQL instance version

  • attempt integer
  • insId integer

    Instance ID

  • noDBs integer

    Total number of databases configured in instance

  • cName string

    Client name

  • serverType string

    Server type of the instance

  • planId integer

    ID of the plan associated with instance

  • protect integer

    Number of databases protected in the instance

  • noSysDBs integer

    Total number of system DBs protected in the instance

  • cId integer

    Client ID

  • status integer

    Instance status 1 - Ready 0 - Not Ready

  • response object
  • total integer

    Total number of instances configured

  • errorMessage string
  • errorCode integer
  • end integer
GET /sql/instances

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/sql/instances' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'