REST API Activation and Deactivation

/api/v1/server/activate (PUT)

The activate PUT method starts the activation process of a deactivated Interaction Media server or cancels an unfinished deactivation process. If you activated the Interaction Media Server or you are in the process of activating, no change occurs.

Request body

None

Response

200 OK status code with the following content in the body of the response:

{
"deactivationStatus" : "activated"
}

Field Name	Type	Responses
deactivationStatus	string	activated

/api/v1/server/deactivate (PUT)

The deactivate PUT method starts the deactivation process of an Interaction Media server. If you deactivated the Interaction Media Server or you are in the process of deactivating, no change occurs.

Request body

None

Response

200 OK status code with the following content in the body of the response:

{
"deactivationStatus" : "deactivating"
}

Field Name	Type	Responses
deactivationStatus	string	deactivating deactivated

/api/v1/server/deactivationstatus (GET)

The deactivationstatus GET method retrieves the current activation status for an Interaction Media Server.

Request body

None

Response

200 OK status code with the following content in the body of the response:

{
"deactivationStatus" : "deactivating",
"commandServers" :
[
{
"id" : 1,
"notifierHost" : "host1",
"icServerName" : "HOST1",
"activeResources" : 2,
"status" : "active",
"details" : "Server is processing requests",
"clientId" : "dfba5ca4-ff1b-4db9-90ea-f3ee360d9573",
"recordingRescueId" : "935892e1-c2cd-4732-b236-b3e51f22dbd3",
"acceptingSessions" : true,
"cpuCapacity" : "2532"
},
{
"id" : 2,
"notifierHost" : "host2",
"icServerName" : "HOST2",
"activeResources" : 5,
"status" : "active",
"details" : "Server is processing requests",
"clientId" : "28431a29-d7fb-4ebc-a9a6-04391063a581",
"recordingRescueId" : "a11daf33-f5c4-4031-a2ba-b70afcba15c1",
"acceptingSessions" : true,
"cpuCapacity" : "Not Applicable"
}
]
}

Field Name	Type	Responses
deactivationStatus	string	deactivating deactivated activated
commandServers	An array of CommandServerInfo objects, as displayed in the above example	This field is present in the response only when the status of the Interaction Media Server is deactivating. The response body also contains the number of remaining active resources that must conclude before deactivation can complete.