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": "53842cf6-d890-4197-af41-f281a4d2cbd8", "agent_name": "sample string 2", "customer_guid": "7c387a69-4e97-48ed-856c-79cb58164a8f", "geoloc": "sample string 4", "created_utc": "2025-10-08T00:42:52", "last_updated_utc": "2025-10-08T00:42:52", "enabled": true, "health": "sample string 8", "status": "sample string 9", "status_updated_at": 10, "certificate_valid_from_utc": "2025-10-08T00:42:52", "certificate_valid_till_utc": "2025-10-08T00:42:52", "node_status": "sample string 13", "status_description": "sample string 14", "scheduling_eligibility": "sample string 15" }, { "agent_id": "761fec1d-8af1-471e-907a-276abda8a350", "agent_name": "sample string 2", "customer_guid": "3e6a9bbf-d873-4e1b-b741-eb4ba8e0dac7", "geoloc": "sample string 4", "created_utc": "2025-10-08T00:42:52", "last_updated_utc": "2025-10-08T00:42:52", "enabled": true, "health": "sample string 8", "status": "sample string 9", "status_updated_at": 10, "certificate_valid_from_utc": "2025-10-08T00:42:52", "certificate_valid_till_utc": "2025-10-08T00:42:52", "node_status": "sample string 13", "status_description": "sample string 14", "scheduling_eligibility": "sample string 15" }, { "agent_id": "439bb53b-7142-4588-b27f-9db1b92361da", "agent_name": "sample string 2", "customer_guid": "77fbfa3c-5b32-4cb1-99bd-d72a88c3bc22", "geoloc": "sample string 4", "created_utc": "2025-10-08T00:42:52", "last_updated_utc": "2025-10-08T00:42:52", "enabled": true, "health": "sample string 8", "status": "sample string 9", "status_updated_at": 10, "certificate_valid_from_utc": "2025-10-08T00:42:52", "certificate_valid_till_utc": "2025-10-08T00:42:52", "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. |