Deactivate module

Deactivates the specified modules on the grid.

This topic includes the following sections:

For a video demonstration of how to use this call, see Module-management-API.

Request

HTTP method: POST

Request URL: https://<hostname>:<port>/baocdp/rest/module/deactivate

Header: See HTTP-request-and-response-headers for header information, such as required authentication token.

Request body properties

Property	Type	Required	Description	Values	Default value
name	String	String	Module name You can provide multiple names (shown in the example).	User-provided value	NA
version	String	String	Module version	User-provided value	NA
revision	String	String	Module revision	User-provided value	NA

Example request JSON

{
"modules":[{
   "name":"AutoPilot-OA-Common_Utilities",
   "version":"20.16.02.00",
   "revision":"1"
},
{
   "name":"AutoPilot-AD-Utilities",
   "version":"20.16.02.00",
   "revision":"1"
}]
}

Response

If successful, this method deactivates the specified module on the grid.

Response body properties

Property	Description
status	Status of the request
message	Message associated with the request status

Example response JSON

{
"status":"Success",
"message":"Requested module/s successfully de-activated."
}

Status codes and messages

For more details about HTTP response codes, see HTTP response codes.

HTTP code	Message	Description
200	OK	Request succeeded
400		Bad request An error occurred while deactivating the module.
401		Unauthorized
405		Method not allowed