GET private-agents
Retrieves a list of private agents for the current customer.
Request example
curl --request GET "https://api-asm2.apica.io/v3/private-agents?auth_ticket=C471ADC4-19B4-4219-BBF4-671A97EC653E"
Response body model example and description
[
{
"agent_id": "37b03e48-6cc7-456b-8077-523ba03c412b",
"agent_name": "sample string 2",
"customer_guid": "64db2139-a3cc-4d93-aab9-acb1862a525a",
"geoloc": "sample string 4",
"created_utc": "2025-10-26T09:47:17",
"last_updated_utc": "2025-10-26T09:47:17",
"enabled": true,
"health": "sample string 8",
"status": "sample string 9",
"status_updated_at": 10,
"certificate_valid_from_utc": "2025-10-26T09:47:17",
"certificate_valid_till_utc": "2025-10-26T09:47:17",
"node_status": "sample string 13",
"status_description": "sample string 14",
"scheduling_eligibility": "sample string 15"
},
{
"agent_id": "89af1d1e-2eab-4fe6-a3d6-414f990d2429",
"agent_name": "sample string 2",
"customer_guid": "e946c0f8-2b29-4b73-9e9d-db383c5d3e4d",
"geoloc": "sample string 4",
"created_utc": "2025-10-26T09:47:17",
"last_updated_utc": "2025-10-26T09:47:17",
"enabled": true,
"health": "sample string 8",
"status": "sample string 9",
"status_updated_at": 10,
"certificate_valid_from_utc": "2025-10-26T09:47:17",
"certificate_valid_till_utc": "2025-10-26T09:47:17",
"node_status": "sample string 13",
"status_description": "sample string 14",
"scheduling_eligibility": "sample string 15"
},
{
"agent_id": "e5b69861-8435-4221-9dcf-8658ec5f92b6",
"agent_name": "sample string 2",
"customer_guid": "dc5b6cb7-001e-40c7-931c-005fa37037e5",
"geoloc": "sample string 4",
"created_utc": "2025-10-26T09:47:17",
"last_updated_utc": "2025-10-26T09:47:17",
"enabled": true,
"health": "sample string 8",
"status": "sample string 9",
"status_updated_at": 10,
"certificate_valid_from_utc": "2025-10-26T09:47:17",
"certificate_valid_till_utc": "2025-10-26T09:47:17",
"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. |