Agent Registration API

The Agent Registration API uses the Representational State Transfer (REST) web service to add or update Gateway Server agent lists. The API is exposed by the Data Hub component. Therefore, the web service is located on the TrueSight Capacity Optimization Data Hub server. The API requires a token to authenticate users for accessing the API.


API methods

The API supports the following method.

Method namePOST
URI pattern/register-node
DescriptionAdd or update the agent list with the specified agent system name.

Parameters

Parameter nameImportanceDescription
agent.nameRequiredName of the Agent system that you want to add to the agent list.
agent.list.nameOptionalName of the agent list to be added or updated. If the list name is not specified, the agent list with the name "default" is created.
gateway.serverOptionalName of the Gateway Server that will manage the Agent system. If the Gateway Server name is not specified, any random Gateway Server is selected.

Sample request and response files

Request containing the Agent list name, Gateway Server name, and Agent name

{
 “agent.list.name":"listname",
 "agent.name":"agentsystem.company.com”,
 "gateway.server":"gws.company.com"
}

Sample response

{
 "href": "https://restserver.company.com:8280/dh-services/agent-data/v1/register-node",
 "gateway.server": "gws.company.com",
 "agent.list.name": "listname"
}

Request containing the Gateway Server and Agent name

{
"agent.name":"agentsystem.company.com",
 "gateway.server":"gws.company.com"
}

Sample response

{
  "href": "https://restserver.company.com:8280/dh-services/agent-data/v1/register-node",
  "gateway.server": "gws.company.com",
  "agent.list.name": " Default"
}

Request containing the Agent name

{
"agent.name":"agentsystem.company.com"
}

Sample response

{
  "href": "https://restserver.company.com:8280/dh-services/agent-data/v1/register-node",
  "gateway.server": "randomgws.company.com",
  "agent.list.name": " Default"
}
Was this page helpful? Yes No Submitting... Thank you

Comments