GET private-location/{geoloc}/private-agents

Lists all private agents for a specified private location.

URL Parameters

Name	Description
geoloc	The geolocation string.

Remarks

Use GET private locations route to get the list of private locations having values applicable for geoloc.

Request example

curl --request GET "https://api-asm1.apica.io/v3/private-location/{geoloc}/private-agents?auth_ticket=C471ADC4-19B4-4219-BBF4-671A97EC653E"

Response body model example and description

[
  {
    "agent_id": "cd8fb370-52a5-4754-a78d-3154f033b190",
    "agent_name": "sample string 2",
    "customer_guid": "98a45863-d771-47f3-b54d-11f323459bfc",
    "geoloc": "sample string 4",
    "created_utc": "2025-01-22T08:18:31",
    "last_updated_utc": "2025-01-22T08:18:31",
    "enabled": true,
    "health": "sample string 8",
    "status": "sample string 9",
    "status_updated_at": 10,
    "certificate_valid_from_utc": "2025-01-22T08:18:31",
    "certificate_valid_till_utc": "2025-01-22T08:18:31",
    "node_status": "sample string 13",
    "status_description": "sample string 14",
    "scheduling_eligibility": "sample string 15"
  },
  {
    "agent_id": "35d40d5e-4e26-4977-a61d-e532641c30fa",
    "agent_name": "sample string 2",
    "customer_guid": "4b791663-7872-4d51-8256-1001efab313a",
    "geoloc": "sample string 4",
    "created_utc": "2025-01-22T08:18:31",
    "last_updated_utc": "2025-01-22T08:18:31",
    "enabled": true,
    "health": "sample string 8",
    "status": "sample string 9",
    "status_updated_at": 10,
    "certificate_valid_from_utc": "2025-01-22T08:18:31",
    "certificate_valid_till_utc": "2025-01-22T08:18:31",
    "node_status": "sample string 13",
    "status_description": "sample string 14",
    "scheduling_eligibility": "sample string 15"
  },
  {
    "agent_id": "03cb6e80-65d1-473f-b497-4bce8915e2ea",
    "agent_name": "sample string 2",
    "customer_guid": "f095837e-13ca-4793-bf9a-bfe48ce23d30",
    "geoloc": "sample string 4",
    "created_utc": "2025-01-22T08:18:31",
    "last_updated_utc": "2025-01-22T08:18:31",
    "enabled": true,
    "health": "sample string 8",
    "status": "sample string 9",
    "status_updated_at": 10,
    "certificate_valid_from_utc": "2025-01-22T08:18:31",
    "certificate_valid_till_utc": "2025-01-22T08:18:31",
    "node_status": "sample string 13",
    "status_description": "sample string 14",
    "scheduling_eligibility": "sample string 15"
  }
]

Name	Type	Description
AgentId	Guid	The unique identifier of the agent.
AgentName	String	The name of the agent.
CustomerGuid	Guid	The unique identifier of the customer.
Geoloc	String	The geolocation string.
CreatedUtc	DateTime	The UTC timestamp when the agent was created.
LastUpdatedUtc	DateTime	The UTC timestamp when the agent was last updated.
Enabled	Boolean	Indicates whether the agent is enabled.
Health	String	The health status of the agent.
Status	String	The current status of the agent.
StatusUpdatedAt	Integer	The timestamp when the status was last updated.
CertificateValidFromUtc	DateTime	The UTC timestamp from when the agent's certificate is valid.
CertificateValidTillUtc	DateTime	The UTC timestamp until the agent's certificate is valid.
NodeStatus	String	The status of the node.
StatusDescription	String	A description of the agent's status.
SchedulingEligibility	String	Indicates the scheduling eligibility of the agent.