Management of API agents

You can manage the HCL OneTest API agents that you want to use as locations to run tests from HCL OneTest Server. When you install the agents by using your offline user token, the agents are registered with the team space in HCL OneTest Server. You can view the registered agents before you add them to your projects. You can then select the agents as locations to run virtual services.

Note: The API agent is referred interchangeably as either the HCL OneTest API agent or API agent in the documentation.
Before you run any of the supported virtual services on a remote HCL OneTest API agent from a project on HCL OneTest Server, you must have completed the following tasks:
  • Installed the HCL OneTest API agent of the same version as the version of HCL OneTest Server. Refer to the HCL OneTest Virtualization documentation at Installing HCL OneTest API agent.

  • Configured the HCL OneTest API agent so that the HCL OneTest API agent can register with HCL OneTest Server.
    Note: When you configure the HCL OneTest API agent by using the offline user token, HCL OneTest Server considers you as the owner of the API agent.
  • Viewed the API agents that are registered with HCL OneTest Server. See Viewing API agents that are registered with HCL OneTest Server.

  • Added the remote API agents that are registered with HCL OneTest Server to your project on HCL OneTest Server. See Adding an API agent to a project.

If you do not want to retain the API agents in a project or if you want to add the API agents to a different project, you can remove the API agents from a project. When you remove an API agent from a project, you cannot select that API agent to run virtual services in the project. See Removing an API agent from a project.

If you want to remove a registered API agent from a team space in HCL OneTest Server when the API agent is not available for use, you can unregister a remote API agent from a team space. See Unregistering a remote API agent from HCL OneTest Server.