GET private-agents
Retrieves a list of private agents for the current customer.
Request example
curl --request GET "https://api-asm1.apica.io/v3/private-agents?auth_ticket=C471ADC4-19B4-4219-BBF4-671A97EC653E"
Response body model example and description
[ { "agent_id": "7da80190-d24c-41cb-b64f-be5fbbb09fbb", "agent_name": "sample string 2", "customer_guid": "f7839a21-e7de-4ada-873b-d153d6013e04", "geoloc": "sample string 4", "created_utc": "2025-07-11T07:59:07", "last_updated_utc": "2025-07-11T07:59:07", "enabled": true, "health": "sample string 8", "status": "sample string 9", "status_updated_at": 10, "certificate_valid_from_utc": "2025-07-11T07:59:07", "certificate_valid_till_utc": "2025-07-11T07:59:07", "node_status": "sample string 13", "status_description": "sample string 14", "scheduling_eligibility": "sample string 15" }, { "agent_id": "da37a0f4-1f54-4c07-b7f3-1ac70dbfb53d", "agent_name": "sample string 2", "customer_guid": "b31e674b-2e4b-4b80-8440-5162770ca77c", "geoloc": "sample string 4", "created_utc": "2025-07-11T07:59:07", "last_updated_utc": "2025-07-11T07:59:07", "enabled": true, "health": "sample string 8", "status": "sample string 9", "status_updated_at": 10, "certificate_valid_from_utc": "2025-07-11T07:59:07", "certificate_valid_till_utc": "2025-07-11T07:59:07", "node_status": "sample string 13", "status_description": "sample string 14", "scheduling_eligibility": "sample string 15" }, { "agent_id": "409afca7-62ee-4c5e-821c-95020a23cfc1", "agent_name": "sample string 2", "customer_guid": "a7a4cc74-39fe-4763-a835-ab2b68b5f6d4", "geoloc": "sample string 4", "created_utc": "2025-07-11T07:59:07", "last_updated_utc": "2025-07-11T07:59:07", "enabled": true, "health": "sample string 8", "status": "sample string 9", "status_updated_at": 10, "certificate_valid_from_utc": "2025-07-11T07:59:07", "certificate_valid_till_utc": "2025-07-11T07:59:07", "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. |