Getting Agent Details

The Agents/{Agent Name} API allows you to get the details of an Agent from the Coordinator.

Request Syntax

GET https://{Coordinator IP Address/Hostname}:{Web Access Port}/Agents/{Agent Name}

Where Web Access Port is the port number defined in the Coordinator Settings(default31100).

For example:

GET https://win10-1:31100/Agents/HOST-29

Response Syntax

Returns the details (Build Group, IP address, name, and state) for the specified Agent.

For example:

[
    {
        "Group": "Dev",
        "IP": "192.100.00.003",
        "Name": "HOST-29",
        "State": "Ready"
    }
]

 Errors

The request fails if the Agent does not exist and it returns: "Status": "Not found".

For example:

[
    {
        "Agent": "MyAgent",
        "Status": "Not found"
    }
]