Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

Accessing the Interactive API Documentation Page

 

Use the interactive API documentation page to access technical details for the RESTful APIs and experiment with making API requests to your server.

The API documentation user interface provides descriptions and the ability to use the following REST API interfaces:

Table 1: REST API Interfaces

REST API

Description

/api/analytics

Create, update, and remove custom actions for rules.

/api/ariel

View event and flow properties, create event and flow searches, and manage searches.

/api/asset_model

Returns a list of all assets in the model. You can also list all available asset property types and saved searches, and update an asset.

/api/auth

Log out and invalidate the current session.

/api/config

View and manage tenants, domains, and JSA extensions.

/api/gui_app_framework

Install and manage applications that are created by using the GUI Application Framework Software Development Kit.

/api/help

Returns a list of API capabilities.

/api/qvm

Retrieves assets, vulnerabilities, networks, open services, networks, and filters. You can also create or update remediation tickets.

/api/reference_data

View and manage reference data collections.

/api/scanner

View, create, or start a remote scan that is related to a scan profile.

/api/siem

View, update, and close offenses. You can also add notes and manage offense closing reasons.

/api/system

Manage server hosts, network interfaces, and firewall rules.

  1. To access the interactive API documentation interface, enter the following URL in your web browser: https://ConsoleIPaddress/api_doc/.
  2. Click the arrow icon beside the API version you want to use.

    8.0 is the latest version for JSA 7.3.0.

  3. Go to the endpoint that you want to access.
  4. Read the endpoint documentation and complete the request parameters.
  5. Click Try it out to send the API request to your console and receive a properly formatted HTTPS response.Note

    When you click Try it out, the action is performed on the JSA system. Not all actions can be reversed, for example, you cannot reopen an offense after you close it.

  6. Review and gather the information that you need to integrate with JSA.