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": "a9108d37-fed0-4fd3-8acf-a53572b36502", "agent_name": "sample string 2", "customer_guid": "acc708cc-2c98-443f-b730-6b0f06d9aca5", "geoloc": "sample string 4", "created_utc": "2024-11-09T02:04:40", "last_updated_utc": "2024-11-09T02:04:40", "enabled": true, "health": "sample string 8", "status": "sample string 9", "status_updated_at": 10, "certificate_valid_from_utc": "2024-11-09T02:04:40", "certificate_valid_till_utc": "2024-11-09T02:04:40", "node_status": "sample string 13", "status_description": "sample string 14", "scheduling_eligibility": "sample string 15" }, { "agent_id": "77e84e89-bf4b-4880-b1f5-0cc7d7c6edb3", "agent_name": "sample string 2", "customer_guid": "7ffdd743-a466-4da5-b1ea-fe1eea00076f", "geoloc": "sample string 4", "created_utc": "2024-11-09T02:04:40", "last_updated_utc": "2024-11-09T02:04:40", "enabled": true, "health": "sample string 8", "status": "sample string 9", "status_updated_at": 10, "certificate_valid_from_utc": "2024-11-09T02:04:40", "certificate_valid_till_utc": "2024-11-09T02:04:40", "node_status": "sample string 13", "status_description": "sample string 14", "scheduling_eligibility": "sample string 15" }, { "agent_id": "3bcfbf6d-2137-4a65-8fc1-80e58d0a1ca5", "agent_name": "sample string 2", "customer_guid": "aada4de5-9a00-44ac-a927-12d544580eb2", "geoloc": "sample string 4", "created_utc": "2024-11-09T02:04:40", "last_updated_utc": "2024-11-09T02:04:40", "enabled": true, "health": "sample string 8", "status": "sample string 9", "status_updated_at": 10, "certificate_valid_from_utc": "2024-11-09T02:04:40", "certificate_valid_till_utc": "2024-11-09T02:04:40", "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. |