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": "b0929c15-3f31-4441-a654-62cb3cec470d", "agent_name": "sample string 2", "customer_guid": "c8fde4e0-0fe7-47ba-ba23-21ecbc7b302a", "geoloc": "sample string 4", "created_utc": "2025-06-13T23:15:22", "last_updated_utc": "2025-06-13T23:15:22", "enabled": true, "health": "sample string 8", "status": "sample string 9", "status_updated_at": 10, "certificate_valid_from_utc": "2025-06-13T23:15:22", "certificate_valid_till_utc": "2025-06-13T23:15:22", "node_status": "sample string 13", "status_description": "sample string 14", "scheduling_eligibility": "sample string 15" }, { "agent_id": "49ef792c-43f2-4e91-b70a-6a5c8405b20e", "agent_name": "sample string 2", "customer_guid": "012ecaa4-1209-4079-ad73-29f9cc679c13", "geoloc": "sample string 4", "created_utc": "2025-06-13T23:15:22", "last_updated_utc": "2025-06-13T23:15:22", "enabled": true, "health": "sample string 8", "status": "sample string 9", "status_updated_at": 10, "certificate_valid_from_utc": "2025-06-13T23:15:22", "certificate_valid_till_utc": "2025-06-13T23:15:22", "node_status": "sample string 13", "status_description": "sample string 14", "scheduling_eligibility": "sample string 15" }, { "agent_id": "fc0b901a-487d-48ba-b3f5-7f0f771b58d9", "agent_name": "sample string 2", "customer_guid": "70806796-8fba-425a-b035-96cf7de4df07", "geoloc": "sample string 4", "created_utc": "2025-06-13T23:15:22", "last_updated_utc": "2025-06-13T23:15:22", "enabled": true, "health": "sample string 8", "status": "sample string 9", "status_updated_at": 10, "certificate_valid_from_utc": "2025-06-13T23:15:22", "certificate_valid_till_utc": "2025-06-13T23:15:22", "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. |