The GET method is a read method that gets the resource specified by the URI. Data is returned in JSON format in the response body.

📘

Don't forget the Auth Key!

When performing these methods, you must already have the Auth Key as outlined in the Getting Started with the AFC API section.

Example: Getting the Fabric UUID

When a Fabric is setup with the Aruba Fabric Composer, there is an internal UUID assigned to it. This is important as further changes to the Fabric usually require the UUID.
To retrieve the Fabric information (including the UUID), perform a GET method against the /api/fabrics resource.

GET "https://172.168.0.1/api/v1/api/fabrics" -H "Authorization: bde76581db5d67e6aefc22e29a863b52a3f3977c7c589cd55074e0904a71xcviuf222ea4d7d5bdd931909ac2osdf"

{
  "result": [
    {
      "uuid": "5a8f9907-29b3-400f-96de-43b40d0f52bd",
      "name": "Fabric1",
      "description": "",
      "is_stable": true,
      "fabric_class": "Leaf-Spine",
      "timezone": null,
      "health": {
        "status": "healthy",
        "health_issues": []
      },
      "segmented": false
    }
  ],
  "time": "41.341mS",
  "count": 1
}

Notice that there are several pieces of information loaded here, such as the Fabric name, timezone, and more.

Example: Getting VLAN Group

GET "https://172.168.0.1/api/v1/api/vlan_groups" -H "Authorization: bde76581db5d67e6aefc22e29a863b52a3f3977c7c589cd55074e0904a71xcviuf222ea4d7d5bdd931909ac2osdf"

{
  "count": 1,
  "result": [
    {
      "description": "",
      "lags": [
        {
          "description": "",
          "l2vpn_information": [
            {
              "l2vpn_uuid": "1c35f445-0e2c-4d0a-b8fd-dae75924567e",
              "l2vpn_name": "l2vpn01"
            }
          ],
          "enable_lossless": true,
          "fabric_uuid": "1c35f445-0e2c-4d0a-b8fd-dae75924567e",
          "mac_learning_attachments": [
            {
              "mac_address": "00:50:56:aa:bb:dd",
              "vlan": 1000,
              "vni": 5000
            }
          ],
          "mlag": true,
          "name": "LinkAggregationGroup#01",
          "native_vlan": 99,
          "qos_ingress_policies": [
            "1c35f445-0e2c-4d0a-b8fd-dae75924567e"
          ],
          "status": "up",
          "port_properties": [
            {
              "switch_uuid": "string",
              "lacp": {
                "mode": "active",
                "priority": 100,
                "interval": "fast"
              },
              "port_uuids": [
                "03734100040c0000399e081dc0ca985b"
              ],
              "port_lacp_state": [
                {
                  "port_uuid": "03734100040c0000399e081dc0ca985b"
                }
              ],
              "speed": {
                "current": 40000,
                "additionalProp1": {}
              }
            }
          ],
          "tags": [
            {
              "namespace": "oneview",
              "key": "owned_by",
              "value": "73ff6aea8acc4067be4453495d10ed05"
            }
          ],
          "type": "internal",
          "ungrouped_vlans": "5, 10-20, 30, 40, 50-60",
          "uuid": "1c35f445-0e2c-4d0a-b8fd-dae75924567e",
          "vlan_group_uuids": [
            "6c8ee2a1a0284f308b3c0f4156f6d042"
          ],
          "vlans": "5, 10-20, 30, 40, 50-60",
          "lacp_fallback": true,
          "lag_number": 10
        }
      ],
      "lag_uuids": [
        "0373410004580000399e081dc0ca985b"
      ],
      "name": "My VLAN Group",
      "tags": [
        {
          "namespace": "oneview",
          "key": "owned_by",
          "value": "73ff6aea8acc4067be4453495d10ed05"
        }
      ],
      "uuid": "1c35f445-0e2c-4d0a-b8fd-dae75924567e",
      "vlans": "5, 10-20, 30, 40, 50-60"
    }
  ],
  "time": "1ms",
  "page": {
    "current_page": "/api/v1/vlan_groups?page=1&page_size=10",
    "next_page": "/api/v1/vlan_groups?page=2&page_size=10",
    "last_page": "/api/v1/vlan_groups?page=10&page_size=10"
  }
}