Get Instance
Select
SaaS
Customer Managed
Get Instance
Query Parameters
- clientName string
- clientId number
Responses
- 200
OK
- application/json
- Schema
- Example (from schema)
- G E T Instance by client Id
- G E T Instance by name /instance?client Name={{client Name}}
- G E T Instance /instance/by Name(client Name='{{client Name}}',app Name='{{app Name}}'),instance Name='{{instance Name}}')
Schema
instanceProperties object[]
{
"instanceProperties": [
{
"isDeleted": true,
"instance": {
"clientId": 0,
"clientName": "string",
"instanceName": "string",
"appName": "string",
"instanceId": 0,
"applicationId": 0,
"instanceGUID": "string"
},
"instanceActivityControl": {
"activityControlOptions": [
{
"activityType": 0,
"enableAfterADelay": true,
"enableActivityType": true
}
]
},
"mssqlInstance": {
"awsSqlInfo": {
"sqlInstanceCredentials": {}
},
"agProperties": {
"SQLAvailabilityReplicasList": {},
"availabilityGroup": {},
"proxyClient": {}
},
"azureInfo": {
"azureCredentials": {},
"azureSqlInstanceCredentials": {}
}
}
}
]
}
{
"instanceProperties": [
{
"isDeleted": false,
"instance": {
"clientId": 11,
"clientName": "shezavm9_new",
"instanceName": "DefaultInstanceName",
"appName": "File System",
"instanceId": 1,
"applicationId": 33,
"instanceGUID": "D86B6E22-AF63-4DB3-973D-844A10020BBA"
},
"instanceActivityControl": {
"activityControlOptions": [
{
"activityType": 128,
"enableAfterADelay": false,
"enableActivityType": true
},
{
"activityType": 1,
"enableAfterADelay": false,
"enableActivityType": true
},
{
"activityType": 2,
"enableAfterADelay": false,
"enableActivityType": true
},
{
"activityType": 16,
"enableAfterADelay": false,
"enableActivityType": true
},
{
"activityType": 4,
"enableAfterADelay": false,
"enableActivityType": true
},
{
"activityType": 256,
"enableAfterADelay": false,
"enableActivityType": true
},
{
"activityType": 8192,
"enableAfterADelay": false,
"enableActivityType": true
},
{
"activityType": -32,
"enableAfterADelay": false,
"enableActivityType": true
},
{
"activityType": 1024,
"enableAfterADelay": false,
"enableActivityType": true
},
{
"activityType": 512,
"enableAfterADelay": false,
"enableActivityType": true
}
]
}
},
{
"isDeleted": false,
"instance": {
"clientId": 11,
"clientName": "shezavm9_new",
"instanceName": "SHEZAVM9/COMMVAULT",
"appName": "SQL Server",
"instanceId": 6,
"applicationId": 81,
"instanceGUID": "B3E994F3-A3CC-415C-94CC-ABD7F75A4AAD"
},
"instanceActivityControl": {
"activityControlOptions": [
{
"activityType": 1,
"enableAfterADelay": false,
"enableActivityType": true
},
{
"activityType": 2,
"enableAfterADelay": false,
"enableActivityType": true
}
]
},
"mssqlInstance": {
"awsSqlInfo": {
"sqlInstanceCredentials": {}
},
"agProperties": {
"SQLAvailabilityReplicasList": {},
"availabilityGroup": {},
"proxyClient": {}
},
"azureInfo": {
"azureCredentials": {},
"azureSqlInstanceCredentials": {}
}
}
},
{
"isDeleted": false,
"instance": {
"clientId": 11,
"clientName": "shezavm9_new",
"instanceName": "Test",
"appName": "SQL Server",
"instanceId": 9,
"applicationId": 81,
"instanceGUID": "2C55D1D8-FD86-466D-A43E-40790BF60F46"
},
"instanceActivityControl": {
"activityControlOptions": [
{
"activityType": 1,
"enableAfterADelay": false,
"enableActivityType": true
},
{
"activityType": 2,
"enableAfterADelay": false,
"enableActivityType": true
}
]
},
"mssqlInstance": {
"awsSqlInfo": {
"sqlInstanceCredentials": {}
},
"agProperties": {
"SQLAvailabilityReplicasList": {},
"availabilityGroup": {},
"proxyClient": {}
},
"azureInfo": {
"azureCredentials": {},
"azureSqlInstanceCredentials": {}
}
}
}
]
}
{
"instanceProperties": [
{
"isDeleted": false,
"instance": {
"clientId": 11,
"clientName": "shezavm9_new",
"instanceName": "DefaultInstanceName",
"appName": "File System",
"instanceId": 1,
"applicationId": 33,
"instanceGUID": "D86B6E22-AF63-4DB3-973D-844A10020BBA"
},
"instanceActivityControl": {
"activityControlOptions": [
{
"activityType": 128,
"enableAfterADelay": false,
"enableActivityType": true
},
{
"activityType": 1,
"enableAfterADelay": false,
"enableActivityType": true
},
{
"activityType": 2,
"enableAfterADelay": false,
"enableActivityType": true
},
{
"activityType": 16,
"enableAfterADelay": false,
"enableActivityType": true
},
{
"activityType": 4,
"enableAfterADelay": false,
"enableActivityType": true
},
{
"activityType": 256,
"enableAfterADelay": false,
"enableActivityType": true
},
{
"activityType": 8192,
"enableAfterADelay": false,
"enableActivityType": true
},
{
"activityType": -32,
"enableAfterADelay": false,
"enableActivityType": true
},
{
"activityType": 1024,
"enableAfterADelay": false,
"enableActivityType": true
},
{
"activityType": 512,
"enableAfterADelay": false,
"enableActivityType": true
}
]
}
},
{
"isDeleted": false,
"instance": {
"clientId": 11,
"clientName": "shezavm9_new",
"instanceName": "SHEZAVM9/COMMVAULT",
"appName": "SQL Server",
"instanceId": 6,
"applicationId": 81,
"instanceGUID": "B3E994F3-A3CC-415C-94CC-ABD7F75A4AAD"
},
"instanceActivityControl": {
"activityControlOptions": [
{
"activityType": 1,
"enableAfterADelay": false,
"enableActivityType": true
},
{
"activityType": 2,
"enableAfterADelay": false,
"enableActivityType": true
}
]
},
"mssqlInstance": {
"awsSqlInfo": {
"sqlInstanceCredentials": {}
},
"agProperties": {
"SQLAvailabilityReplicasList": {},
"availabilityGroup": {},
"proxyClient": {}
},
"azureInfo": {
"azureCredentials": {},
"azureSqlInstanceCredentials": {}
}
}
},
{
"isDeleted": false,
"instance": {
"clientId": 11,
"clientName": "shezavm9_new",
"instanceName": "Test",
"appName": "SQL Server",
"instanceId": 9,
"applicationId": 81,
"instanceGUID": "2C55D1D8-FD86-466D-A43E-40790BF60F46"
},
"instanceActivityControl": {
"activityControlOptions": [
{
"activityType": 1,
"enableAfterADelay": false,
"enableActivityType": true
},
{
"activityType": 2,
"enableAfterADelay": false,
"enableActivityType": true
}
]
},
"mssqlInstance": {
"awsSqlInfo": {
"sqlInstanceCredentials": {}
},
"agProperties": {
"SQLAvailabilityReplicasList": {},
"availabilityGroup": {},
"proxyClient": {}
},
"azureInfo": {
"azureCredentials": {},
"azureSqlInstanceCredentials": {}
}
}
}
]
}
{
"instanceProperties": [
{
"isDeleted": false,
"instance": {
"clientId": 5,
"clientName": "firewalltestma_2",
"instanceName": "Test",
"appName": "SQL Server",
"instanceId": 3,
"applicationId": 81,
"instanceGUID": "33C8B996-2213-4000-A105-31BB061E1921"
},
"instanceActivityControl": {
"activityControlOptions": [
{
"activityType": 1,
"enableAfterADelay": false,
"enableActivityType": true
},
{
"activityType": 2,
"enableAfterADelay": false,
"enableActivityType": true
}
]
},
"mssqlInstance": {
"awsSqlInfo": {
"sqlInstanceCredentials": {}
},
"agProperties": {
"SQLAvailabilityReplicasList": {},
"availabilityGroup": {},
"proxyClient": {}
},
"azureInfo": {
"azureCredentials": {},
"azureSqlInstanceCredentials": {}
}
}
}
]
}
GET /instance
Authorization
type: apiKeyname: Authtokenin: header
Request
Request
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/Instance' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/Instance' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/Instance' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/Instance' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/Instance' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/Instance' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/Instance' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'