Get resources of a schedule maintenance window

This endpoint is used to retrieve the list of devices (or device groups or sites) of a scheduled maintenance window.

Leave Feedback

URL

POST https://{api-url}/api/v2/tenants/{tenantId}/scheduleMaintenances/{smId}/resources/{resourcesType}

Sample URLs

To retrieve the resources in a scheduled maintenance window:

https://{api-url}/api/v2/tenants/client_44/scheduleMaintenances/SM-c11b6b44-c85a-426c-9963-0e977070ce98/resources/resources?pageNo=1&pageSize=5

To retrieve the device groups in a scheduled maintenance window:

https://{api-url}/api/v2/tenants/client_44/scheduleMaintenances/SM-c11b6b44-c85a-426c-9963-0e977070ce98/resources/deviceGroups?pageNo=1&pageSize=2

To retrieve the sites in a scheduled maintenance window:

https://{api-url}/api/v2/tenants/client_44/scheduleMaintenances/SM-c11b6b44-c85a-426c-9963-0e977070ce98/resources/sites?pageNo=1&pageSize=2

Parameters

FieldDefault Value
pageNo={pageNo}1
pageSize={pageSize}100
isDescendingOrder={true/false}true

Sample responses

Devices in a scheduled maintenance window

{
	"results": [{
			"id": "4b7e4bc4-2115-4f15-bbd9-642396d486b6",
			"hostName": "cn-agent-docker01",
			"ipAddress": "212.328.345.123",
			"type": "DOCKER"
		},
		{
			"id": "e8893d5c-5448-4123-992f-2a7631a97310",
			"hostName": "k8-pool1-wk1",
			"ipAddress": "121.321.435.251",
			"type": "DEVICE"
		},
		{
			"id": "66296829-c08d-45fb-9c8c-b6702189611d",
			"hostName": "WIN7-PC",
			"ipAddress": "132.346.768.121",
			"type": "DEVICE"
		},
		{
			"id": "9be5120f-f2f7-45d0-88e4-83d67461f751",
			"hostName": "HYDLPT272167",
			"ipAddress": "121.345.321.134",
			"type": "DEVICE"
		},
		{
			"id": "8016775e-f1b4-47d5-bdd0-e039b115c45f",
			"hostName": "DBMS10734",
			"ipAddress": "177.162.136.193",
			"type": "DEVICE"
		}
	],
	"totalResults": 50,
	"pageNo": 1,
	"pageSize": 5,
	"totalPages": 5,
	"nextPage": true,
	"nextPageNo": 2,
	"previousPageNo": 0,
	"descendingOrder": false
}

Device groups in a scheduled maintenance window

{
	"results": [{
			"id": "DGP-98a9dac3-18ae-4456-88d3-e7ffa5ce4ace",
			"name": "Windows Servers",
			"description": "",
			"createdDate": "2018-02-10T10:15:32+0000",
			"updatedDate": "2018-08-02T14:20:10+0000"
		},
		{
			"id": "DGP-6fd28a3f-9f10-4c74-ac15-bd9de54ec056",
			"name": "Network Devices",
			"description": "",
			"createdDate": "2018-03-13T11:20:50+0000",
			"updatedDate": "2018-08-02T17:15:40+0000"
		}
	],
	"totalResults": 6,
	"pageNo": 1,
	"pageSize": 2,
	"totalPages": 3,
	"nextPage": true,
	"nextPageNo": 2,
	"previousPageNo": 0,
	"descendingOrder": false
}

Sites in a scheduled maintenance window

{
	"results": [{
			"id": 164,
			"name": "Virginia-East",
			"description": "Server locations in East Virgnia"
		},
		{
			"id": 165,
			"name": "California-Central",
			"description": "Network Centers in California"
		}
	],
	"totalResults": 6,
	"pageNo": 1,
	"pageSize": 2,
	"totalPages": 3,
	"nextPage": true,
	"nextPageNo": 2,
	"previousPageNo": 0,
	"descendingOrder": false
}