GET Agents

Get the agents that are registered with App Orchestration.

Request Information

Parameters

Name	Description	Additional information
name	See Filtering, Arranging, and Paging.	Type: String
filterBy	See Filtering, Arranging, and Paging. The supported filters are: All: All agents. NotDeleted: All agents that are not currently being deleted. (default)	Type: Filter
filterProp	See Filtering, Arranging, and Paging.	Type: String
arrangeBy	See Filtering, Arranging, and Paging. The supported arrangers are: Name: Arrange by name. (default)	Type: String
skip	See Filtering, Arranging, and Paging.	Type: Number
take	See Filtering, Arranging, and Paging.	Type: Number

Response Information

A list of agents.

Response type

CollectionResultModel<AgentModel>

Response body formats

application/json, text/json

Sample:

{
  "Href": "[api:Agents]",
  "Count": 1,
  "TotalMatchingFilter": 1,
  "Items": [
    {
      "Href": "[api:Agents(941e92f1-5dd6-4720-bca2-6875c8b04acd)]",
      "Id": "941e92f1-5dd6-4720-bca2-6875c8b04acd",
      "Name": "SERVER1",
      "Role": "ControllerAgent",
      "Scope": "745c2030-77c6-4d65-97ac-52c79db96ff5",
      "IsPrimary": true,
      "LastHeartBeatTime": "2013-12-05T16:11:53.834917-05:00",
      "IsAlive": true,
      "IsHealthy": true
    }
  ]
}