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": "fe7ebf2e-9583-45db-8b1f-e7de688704ff",
"agent_name": "sample string 2",
"customer_guid": "3bf3505e-abdc-4e7c-a8d4-0c50899f2363",
"geoloc": "sample string 4",
"created_utc": "2025-10-24T12:03:51",
"last_updated_utc": "2025-10-24T12:03:51",
"enabled": true,
"health": "sample string 8",
"status": "sample string 9",
"status_updated_at": 10,
"certificate_valid_from_utc": "2025-10-24T12:03:51",
"certificate_valid_till_utc": "2025-10-24T12:03:51",
"node_status": "sample string 13",
"status_description": "sample string 14",
"scheduling_eligibility": "sample string 15"
},
{
"agent_id": "a13e8414-04bd-4aad-a776-eb0e6d003c74",
"agent_name": "sample string 2",
"customer_guid": "d6393a07-4b73-4443-a243-51c06013c36e",
"geoloc": "sample string 4",
"created_utc": "2025-10-24T12:03:51",
"last_updated_utc": "2025-10-24T12:03:51",
"enabled": true,
"health": "sample string 8",
"status": "sample string 9",
"status_updated_at": 10,
"certificate_valid_from_utc": "2025-10-24T12:03:51",
"certificate_valid_till_utc": "2025-10-24T12:03:51",
"node_status": "sample string 13",
"status_description": "sample string 14",
"scheduling_eligibility": "sample string 15"
},
{
"agent_id": "9f227ace-b38b-421e-899e-40b153fa3a61",
"agent_name": "sample string 2",
"customer_guid": "60b6fc00-d00b-4d58-9252-c799d59b2194",
"geoloc": "sample string 4",
"created_utc": "2025-10-24T12:03:51",
"last_updated_utc": "2025-10-24T12:03:51",
"enabled": true,
"health": "sample string 8",
"status": "sample string 9",
"status_updated_at": 10,
"certificate_valid_from_utc": "2025-10-24T12:03:51",
"certificate_valid_till_utc": "2025-10-24T12:03: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. |