EdgeView allows users to use its APIs, allowing for easy third party application integration. The following APIs are available for use:

  • Collection: For accessing collections.
  • Device: For accessing device information.  
  • Policy: For accessing a specific policy. 

This section describes how to use EdgeView APIs.

Use EdgeView APIs

To use an EdgeView API, perform the following steps:

  1. From the EdgeView menu bar, select the current user menu and click Edit Profile. The User Profile page appears.

    User Profile

  2. Go to the Access Token tab and create an access token. For more information on managing access tokens, see Manage EdgeView Access Tokens.

    Access Token Tab

  3. Use the generated token in REST API calls as a bearer token for authorization. To test this, go to System > EdgeView API. 

    EdgeView API


    You are taken to the updated EdgeView API documentation.

    EdgeView APIs

  4. You can try out any of the APIs listed here, by selecting the desired API and entering the required information along with the access token. For more information on how to try out the available APIs, refer to Use EdgeView Access Tokens.

    To access a printable version of the EdgeView API documentation, execute the following command in EdgeView installation scc-build directory:

    docker cp evapi:/usr/local/tomcat/webapps/evapi/WEB-INF/classes/index.html.

    This command results in an index HTML file with the printable version of EdgeView API documentation in it.