Accessing the REST API using theAOS-CXREST API Reference

CAUTION:

虽然AOS-CXREST API Reference interacts directly with the REST API, theAOS-CXREST API Reference is not intended as a management or configuration interface. Use caution when using theSubmitbutton for POST or PUT methods because this action can result in changes to your current environment.

Prerequisites

  • HTTPS server access must be enabled on the VRF from which you are accessing the switch.

  • 有几个exceptions, using the PUT, POST, or DELETE methods require the following conditions to be true:

    • The REST API access mode must be set toread-write.

    • The user name you use to log in must be a member of theadministratorsgroup.

Procedure
  • To view the reference documentation for the REST v10.04 API, access the following URL using a browser:https:/// api /v10.04/

    is the IP address or hostname of your switch.

    For example:https://192.0.2.5/api/v10.04/

  • To open the reference for the REST v1 API, open a browser at:https:/// api / v1 /或在https:/// api /

    is the IP address or hostname of your switch.

    For example:https://192.0.2.5/api/v1/