Deleting a Component

Use this API to delete a component from the eG manager.

URL: http://<eG manager IP:port>/api/eg/orchestration/deletecomponent

Method: POST

Content-Type: application/json

Inputs to be Specified
Parameters Key values Example


managerurl: Base URL of the eG Manager i.e., http://<IP address of the eG console:Port>

user: eG username or domain/eG username

pwd: Base64 encoded password

Example with Default key values:


"componenttype":"Microsoft SQL",




Example with both Default and Optional Key Values:


"componenttype":"Oracle Database",








"componenttype":"Component type",

"componentname":"The nick name of the component",








If an Oracle Database server is added with multiple SIDs, then the eG Enterprise system will monitor each SID as a different Oracle Database server. Therefore, while removing an Oracle Database server that supports multiple SIDs, you cannot issue a single command to remove all the SIDs at one shot. Instead, this command should be invoked separately for each SID.

Success Response
Type Code Content




"Succeed": "Component has been removed successfully."



Failure Response
Type Code Content




"Error": "The selected component does not exist."


Figure 1 : Deleting a Component using Postman REST Client

Deleting a Component using cURL

To delete a component through the REST API using cURL, the command should be specified in the following format:

curl --location --request POST "http://<eG Manager IP:Port>/api/eg/orchestration/deletecomponent" -H "managerurl:http://<eG Manager IP:Port>" -H "user:<eG username or domain/eG username>" -H "pwd:Base64 encoded password" -H "Content-Type: application/json" --data-raw "{'componenttype': 'ComponentType', 'componentname': 'nick name of the component', 'port': 'port at which the component listens', 'sid': 'SID'}"

Note that the command specified above contains both the Default and Optional key values.

Figure 2 shows an example of deleting a component using cURL.

Figure 2 : Deleting a component using cURL