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": "fc10d5a6-304b-4411-9a52-2202ec2351bf", "agent_name": "sample string 2", "customer_guid": "c675d955-fe67-489b-90b2-325849095d94", "geoloc": "sample string 4", "created_utc": "2024-11-08T21:22:57", "last_updated_utc": "2024-11-08T21:22:57", "enabled": true, "health": "sample string 8", "status": "sample string 9", "status_updated_at": 10, "certificate_valid_from_utc": "2024-11-08T21:22:57", "certificate_valid_till_utc": "2024-11-08T21:22:57", "node_status": "sample string 13", "status_description": "sample string 14", "scheduling_eligibility": "sample string 15" }, { "agent_id": "a9988809-a1b9-49bb-9354-6f26f33b5817", "agent_name": "sample string 2", "customer_guid": "4dacaf11-8b1d-4561-a7b6-f0db6265892b", "geoloc": "sample string 4", "created_utc": "2024-11-08T21:22:57", "last_updated_utc": "2024-11-08T21:22:57", "enabled": true, "health": "sample string 8", "status": "sample string 9", "status_updated_at": 10, "certificate_valid_from_utc": "2024-11-08T21:22:57", "certificate_valid_till_utc": "2024-11-08T21:22:57", "node_status": "sample string 13", "status_description": "sample string 14", "scheduling_eligibility": "sample string 15" }, { "agent_id": "70ed601d-6271-4e01-aed9-1dcfcd7e30d6", "agent_name": "sample string 2", "customer_guid": "c95193c5-95ad-437a-84f3-f8615a214200", "geoloc": "sample string 4", "created_utc": "2024-11-08T21:22:57", "last_updated_utc": "2024-11-08T21:22:57", "enabled": true, "health": "sample string 8", "status": "sample string 9", "status_updated_at": 10, "certificate_valid_from_utc": "2024-11-08T21:22:57", "certificate_valid_till_utc": "2024-11-08T21:22:57", "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. |