About WAAPI

WAAPI is an XML-based API that enables remote or local administration of the Web GUI server.

WAAPI enables administration of the server without having to use the graphical user interface of the Web GUI itself. It is particularly useful for carrying out bulk updates of information which would take a long time to achieve using the interactive facilities. For example, adding or modifying a number filters may be more efficient to do using WAAPI rather than the interactive facilities of the Web GUI.

The interface is installed with the Web GUI server enabling administration from the server itself. You can also install the WAAPI client on a remote server and manage the Web GUI from there.

Types of request

An administration command using WAAPI is known as a request. WAAPI allows you to manage many of the facilities available through the interactive interface. For example, you can add, modify, and delete filters.

There are also some features that are available only using WAAPI for specialized administration tasks. For example, you can reload all the system's filters and views.

WAAPI groups all the available requests into the following types:

  • User

    Modify the characteristics of any number of users, get a list of users, and remove Web GUI configuration data from users that no longer have active Web GUI roles.

  • Views

    Create, modify, delete, and list views.

  • Maps

    Create, modify, delete and list maps. In addition, you can add visuals to a map, modify and delete them.

  • Resources

    Resources are graphics files that contain items you want to appear on a map. Resources include background images for maps and graphics you want ot use as map objects. You can add remove and list resources.

  • Files

    Add and remove directories and files on the Web GUI server.

  • Menus

    Create, modify, delete, and list menus to appear on Active Event Lists (AEL).

  • Tools

    Add, modify, and delete event management tools.

  • Prompts

    The Web GUI provides several types of prompt that event management tools can use to obtain information from the user. You can add, modify, delete, and list prompts.

  • CGI scripts

    Register, modify, and deregister CGI scripts.

  • Filters

    Add, modify, delete, and list filters. In addition, you can default view for a filter.

  • Filter collections

    Add, modify, delete, and list filter collections. In addition, you can add filters too and remove them from a filter collection.

  • Metrics (gauges)

    Create, modify, delete, and list metrics that the Web GUI displays in the form of gauges.

  • Relationships

    Create, modify, delete, and list event relationships.

  • Other

    Miscellaneous requests that do not fit in any other category:

    • Resynchronize the Web GUI cache with the ObjectServer.
    • Remove a node from a load balancing cluster.
    • Generate a system status report.
    • Reload all filters and views.