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": "e12c1da3-5ca5-49be-a9a5-df1a31caffc5", "agent_name": "sample string 2", "customer_guid": "c050ad95-639b-45f7-97bd-704eff5128ef", "geoloc": "sample string 4", "created_utc": "2025-06-26T13:57:51", "last_updated_utc": "2025-06-26T13:57:51", "enabled": true, "health": "sample string 8", "status": "sample string 9", "status_updated_at": 10, "certificate_valid_from_utc": "2025-06-26T13:57:51", "certificate_valid_till_utc": "2025-06-26T13:57:51", "node_status": "sample string 13", "status_description": "sample string 14", "scheduling_eligibility": "sample string 15" }, { "agent_id": "31d2bc08-b26a-4818-8d43-2c37becd818d", "agent_name": "sample string 2", "customer_guid": "d170d31b-5880-4728-b697-9d0c0cdbc438", "geoloc": "sample string 4", "created_utc": "2025-06-26T13:57:51", "last_updated_utc": "2025-06-26T13:57:51", "enabled": true, "health": "sample string 8", "status": "sample string 9", "status_updated_at": 10, "certificate_valid_from_utc": "2025-06-26T13:57:51", "certificate_valid_till_utc": "2025-06-26T13:57:51", "node_status": "sample string 13", "status_description": "sample string 14", "scheduling_eligibility": "sample string 15" }, { "agent_id": "a98394db-fb00-4c67-85fb-094b32185484", "agent_name": "sample string 2", "customer_guid": "06ac7083-b23c-4ebc-a608-9fbffa5e0ef6", "geoloc": "sample string 4", "created_utc": "2025-06-26T13:57:51", "last_updated_utc": "2025-06-26T13:57:51", "enabled": true, "health": "sample string 8", "status": "sample string 9", "status_updated_at": 10, "certificate_valid_from_utc": "2025-06-26T13:57:51", "certificate_valid_till_utc": "2025-06-26T13:57:51", "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. |