Procedure to install the Management API on an appliance:

Steps

  1. Use the following command:
    curl -k -u admin:<password> -X PUT https://<c_interface>/ wse/admin/api/install

    When the installation is complete, the command returns its results in JSON format. In the Data field, look for the following strings:

    WsUrlQuery (pid xxxx) is running
    CatEngineMonitor.sh (pid xxxx) is running
    Policy API Server is running
  2. If any API components have failed to start, use the following commands to first stop all API components, then start the components:
    curl -k -u admin:<password> -X PUT https://<c_interface>/ wse/admin/api/stop

    curl -k -u admin:<password> -X PUT https://<c_interface>/ wse/admin/api/start

  3. To verify the status of Management API components at any time, use the following command:
    curl -k -u admin:<password> -X GET https://<c_interface>/ wse/admin/api/status

Next steps

To continue with the setup process, see Enabling communication between Management API clients and servers.

If you later need to remove Management API components from the appliance, use the following command:

curl -k -u admin:<password> -X PUT https://<c_interface>/ wse/admin/api/uninstall

Before changing an appliance that hosts the Management API to filtering only mode, see Changing the policy source mode of an appliance that hosts the Management API.