REST APIs for 22.5

This API returns an agent record.

Curl Command to Get an Agent

To obtain the agent ID, make a call to a managed workload (a workload associated with a VEN) GET /workloads/workload_id. To get all managed workloads, make a call to GET /workloads?managed=true.

curl -i -X GET https://pce.my-company.com:8443/api/v2/orgs/7/agents/12345 -H "Accept: application/json" -u $KEY:$TOKEN

Path Parameters

Example Response Body

{
  "href": "/orgs/7/agents/12345",
  "org_id": 1,
  "name": null,
  "description": null,
  "uid": "xxxxx-xxxxx--8ef6-c0fb3fea3cf5",
  "last_heartbeat_on": "2018-09-08T01:12:00.999Z",
  "uptime_seconds": 9944537,
  "hostname": "my-hostname",
  "agent_version": "16.9.0",
  "public_ip": "xx.xxx.xxx.xxx",
  "status": "active",
  "online": true,
  "fw_rules_generation_actual": 1,
  "service_provider": "my-datacenter-provider.com",
  "data_center": "123.my-datacenter.com",
  "data_center_zone": "3",
  "instance_id": "pi@xxxxxxxx93816",
  "fw_config_current?": true,
  "managed_since": "2018-06-13T03:23:00.000Z",
  "os_id": "ubuntu-x86_64-xenial",
  "os_detail": "4.4.0-97-generic #120-Ubuntu SMP Tue Sep 19 17:28:18 UTC 2017 (Ubuntu 16.04.1 LTS)",
  "visibility_level": "flow_summary",
  "created_at": "2018-06-13T03:23:00.000Z",
  "updated_at": "2018-09-08T01:02:00.000Z",
  "created_by": {
    "href": "/orgs/7/agents/12345"
  },
  "updated_by": null,
  "service_report": {
    "uptime_seconds": 9887714,
    "created_at": "2018-09-07T21:05:44.825Z",
    "open_service_ports": [
      {
        "protocol": 17,
        "address": "0.0.0.0",
        "port": 67,
        "process_name": "dhcpd",
        "user": "root",
        "package": null,
        "win_service_name": null
      },
      {
        "protocol": 6,
        "address": "0.0.0.0",
        "port": 53,
        "process_name": "bind",
        "user": "root",
        "package": null,
        "win_service_name": null
      },
      {
        "protocol": 17,
        "address": "0.0.0.0",
        "port": 123,
        "process_name": "ntpd",
        "user": "root",
        "package": null,
        "win_service_name": null
      }
    ]
  },
  "labels": [
    {
      "href": "/orgs/7/labels/2010"
    },
    {
      "href": "/orgs/7/labels/300"
    },
    {
      "href": "/orgs/7/labels/2000"
    },
    {
      "href": "/orgs/7/labels/260"
    }
  ],
  "mode": "illuminated",
  "target_pce_fqdn": null,
  "active_pce_fqdn": null
}

This API fetches all agents. This API was DEPRECATED and replaced (use /orgs/:xorg_id/vens/:ven_uuid instead).

The agents API is deprecated, and the VEN href should be used to identify and manipulate this resource.

This API updates the agent target_pce_fqdn parameter to point to the FQDN of a Supercluster or a PCE that is a member of a Supercluster.

URI to Update an Agent “target_pce_fqdn” Parameter

PUT [api_version][agent_href]/update

Curl Command to Update an Agent

curl -i -X PUT https://pce.my-company.com:8443/api/v2/orgs/7/agents/12345 -H "Content-Type: application/json" -u $KEY:$TOKEN -d '{"target_pce_fqdn": "my.supercluster.pce.my-company.com"}'

Request Body

Example Request Body

{
      "target_pce_fqdn": "my.supercluster.pce.my-company.com"
}