Skip to content

Issue/Help with "List aggregate ethernet interfaces" - endpoint is incorrect #1039

@mrredcon

Description

@mrredcon

Documentation link

https://pan.dev/scm/api/config/ngfw/network/list-aggregate-ethernet-interfaces/
https://pan.dev/scm/api/config/ngfw/network/create-aggregate-ethernet-interfaces/
https://pan.dev/scm/api/config/ngfw/network/get-aggregate-ethernet-interfaces-by-id/
https://pan.dev/scm/api/config/ngfw/network/update-aggregate-ethernet-interfaces-by-id/
https://pan.dev/scm/api/config/ngfw/network/delete-aggregate-ethernet-interfaces-by-id/

Describe the problem

The correct endpoint for aggregate interfaces is /config/network/v1/aggregate-interfaces NOT aggregate-ethernet-interfaces.

Attempting to "List aggregate ethernet interfaces" as the documentation describes results in an "access denied" message:

$ curl -H "Authorization: Bearer $ACCESS_TOKEN" "https://api.strata.paloaltonetworks.com/config/network/v1/aggregate-ethernet-interfaces?folder=FW_Testing"
        {
        "msg": "Access denied"
        }

Corrected endpoint returns JSON describing an aggregate interface I defined in the SCM GUI:

$ curl -H "Authorization: Bearer $ACCESS_TOKEN" "https://api.strata.paloaltonetworks.com/config/network/v1/aggregate-interfaces?folder=FW_Testing"
{"data":[{"comment":"My comment","default_value":"ae1","folder":"FW_Testing","id":"a-b-c-d-e","layer2":{"lacp":{"high_availability":{},"max_ports":8,"mode":"passive","system_priority":32768,"transmission_rate":"slow"},"lldp":{"enable":false}},"name":"$lagg"}],"limit":200,"offset":0,"total":1}

Suggested fix

Replace references to the endpoint "aggregate-ethernet-interfaces" with "aggregate-interfaces".

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions