Skip to content
API Enriched

AI Assistant Query.

POST
/api/gen-ai/namespaces/{namespace}/query
curl --request POST \
  --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/gen-ai/namespaces/example/query \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "current_query": "example", "namespace": "example" }'

Enable service by returning service account details.

Examples of this operation.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
namespace
required
string

Namespace Namespace of the HTTP Load Balancer for current request.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
AI Assistant Query Request

AI Assistant Query Request.

object
current_query
current_query

Current query will be in text format.

string
<= 1024 characters
namespace
Namespace

Namespace of the HTTP Load Balancer for current request.

string
>= 6 characters <= 1024 characters
Examplegenerated
{
  "current_query": "example",
  "namespace": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

A successful response.

Media typeapplication/json
AI Assistant Query Response

AI Assistant Query Response.

object
current_query
current_query

Current query will be in text format.

string
<= 1024 characters
explain_log
object
actions
actions

Follow-up actions.

string
<= 1024 characters
analysis
analysis

Log analysis.

string
<= 1024 characters
bot_defense_event_details
object
action
string
default: ACTION_NONE
Allowed values: ACTION_NONE ALLOW BLOCK REDIRECT
automation_type
automation_type

Bot automation type.

string
<= 1024 characters
bot_type
bot_type

Bot type

string
<= 1024 characters
method
method

Method of the request.

string
<= 1024 characters
request_path
request_path

Request path.

string
<= 1024 characters
request_details
object
domain
domain

Domain

string format: hostname
>= 26 characters <= 1024 characters
rsp_code
rsp_code

Rsp_code

integer format: int64
rsp_code_details
rsp_code_details

Rsp_code_details.

string
<= 1024 characters
upstream_protocol_error_reason
upstream_protocol_error_reason

Upstream_protocol_error_reason.

string
<= 1024 characters
summary
summary

Log summary.

string
<= 1024 characters
svc_policy_event_details
object
action
string
default: ACTION_NONE
Allowed values: ACTION_NONE ALLOW BLOCK REDIRECT
ip_risk
string
default: IP_REPUTATION_NONE
Allowed values: IP_REPUTATION_NONE IP_REPUTATION_LOW IP_REPUTATION_HIGH
ip_threat_categories
ip threat categories

IP threat categories.

Array<string>
Allowed values: SPAM_SOURCES WINDOWS_EXPLOITS WEB_ATTACKS BOTNETS SCANNERS REPUTATION PHISHING PROXY MOBILE_THREATS TOR_PROXY DENIAL_OF_SERVICE NETWORK
ip_trustworthiness
string
default: IP_REPUTATION_NONE
Allowed values: IP_REPUTATION_NONE IP_REPUTATION_LOW IP_REPUTATION_HIGH
policy
policy

Policy name.

string
<= 1024 characters
policy_namespace
policy namespace

Policy namespace.

string
<= 1024 characters
policy_rule
policy rule

Policy rule name.

string
<= 1024 characters
waf_event_details
object
action
string
default: ACTION_NONE
Allowed values: ACTION_NONE ALLOW BLOCK REDIRECT
app_firewall
app_firewall

App Firewall name.

string
<= 1024 characters
bot
object
classification
classification

Bot classification.

string
<= 1024 characters
name
name

Bot name

string
>= 6 characters <= 1024 characters
type
name

Bot type

string
<= 1024 characters
enforcement_mode
string
default: ENFORCEMENT_NONE
Allowed values: ENFORCEMENT_NONE MONITORING BLOCKING
signatures
signatures

The signatures that were detected in the request.

Array<object>
Signature

Signature details.

object
accuracy
string
default: ACCURACY_NONE
Allowed values: ACCURACY_NONE ACCURACY_LOW ACCURACY_MEDIUM ACCURACY_HIGH
attack_type
attack_type

Attack type of the signature.

string
<= 1024 characters
context
context

Context of the signature.

string
<= 1024 characters
id
id

Signature ID.

string
>= 1 <= 4094 <= 1024 characters
matching_info
matching_info

Matching info.

string
<= 1024 characters
name
name

Signature name.

string
>= 6 characters <= 1024 characters
state
state

State of the signature, can be enabled, suppressed and etc.

string
<= 1024 characters
threat_campaigns
threat_campaigns

Threat campaigns that were detected in the request.

Array<object>
ThreatCampaign

Threat campaign details.

object
attack_type
attack_type

Attack type of threat campaign.

string
<= 1024 characters
id
id

ThreatCampaign ID.

string
>= 1 <= 4094 <= 1024 characters
name
name

ThreatCampaign name.

string
>= 6 characters <= 1024 characters
violations
violations

The violations that were detected in the request.

Array<object>
Violation

Violation details.

object
attack_type
attack_type

Attack type of the violation.

string
<= 1024 characters
context
context

Context of the violation.

string
<= 1024 characters
matching_info
matching_info

Matching info.

string
<= 1024 characters
name
name

Violation name.

string
>= 6 characters <= 1024 characters
state
state

State of the violation, can be enabled, suppressed and etc.

string
<= 1024 characters
follow_up_queries
follow_up_queries

Follow up Queries to be given as suggestion to users.

Array<string>
gen_dashboard_filter
object
actions
actions

Follow-up actions.

string
<= 1024 characters
links
links

Links that will be presented to the user.

Array<object>
Link

Link for a page.

object
dashboard_link
object
key
key

Key will present a placeholder in a text field to insert the link. For example: To view these events go to the ${{link:db_link}}. Required: YES.

string
>= 7 characters <= 1024 characters
log_filters
log_filters

Logs filter.

Array<object>
LogFilter

Log filter for filter query.

object
key
key

Key to be presented in the filter.

string
>= 7 characters <= 1024 characters
op
string
default: IN
Allowed values: IN NOT_IN
values
values

Values to be presented in the filter.

Array<string>
namespace
Namespace

Namespace for current request.

string
>= 6 characters <= 1024 characters
object_name
object_name

Object name such as LB, VH.

string
<= 1024 characters
time_range
time_range

Time range filter.

string
<= 1024 characters
title
title

Title for the link.

string
>= 6 characters <= 1024 characters
type
string
default: SECURITY_ANALYTICS_EVENTS
Allowed values: SECURITY_ANALYTICS_EVENTS REQUESTS_EVENTS SITES CLOUD_CREDENTIALS SITES_UBER SITE_ALERTS SITE_MANAGEMENT_AWS_VPC_SITES SITE_MANAGEMENT_AWS_TGW_SITES SITE_MANAGEMENT_AZURE_VNET_SITES SITE_MANAGEMENT_GCP_VPC_SITES SITE_MANAGEMENT_APP_STACK_SITES SITE_MANAGEMENT_SECURE_MESH_SITES TENANT_OVERVIEW_PAGE SUPPORT
generic_link
object
key
key

Key will present a placeholder in a text field to insert the link. For example: To view these events go to the ${{link:db_link}}. Required: YES.

string
>= 7 characters <= 1024 characters
title
title

Title for the link.

string
>= 6 characters <= 1024 characters
url
url

Full URL

string format: uri
<= 1024 characters
summary
summary

Events summary.

string
<= 1024 characters
generic_response
object
error
object
code
string
default: EOK
Allowed values: EOK EPERMS EBADINPUT ENOTFOUND EEXISTS EUNKNOWN ESERIALIZE EINTERNAL EPARTIAL
error_obj
object
type_url

A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one ”/” character. The last segment of the URL’s path must represent the fully qualified name of the type (as in path/google.protobuf.duration). The name should be in a canonical form (e.g., leading ”.” is not accepted).

In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme HTTP, HTTPS, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:

  • If no scheme is provided, HTTPS is assumed.
  • An HTTP GET on the URL must yield a [google.protobuf.type][] value in binary format, or produce an error.
  • Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)

Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.

Schemes other than HTTP, HTTPS (or the empty scheme) might be used with implementation specific semantics.

string
<= 1024 characters
value

Must be a valid serialized protocol buffer of the above specified type.

string format: byte
>= 3 characters <= 1024 characters
message
message

A human readable string of the error.

string
<= 1024 characters
is_error
is_error

Configuration parameter for is error

boolean format: boolean
summary
Summary

Configuration parameter for summary

string
<= 1024 characters
list_response
object
external_links
external links

External doc links, that will be presented to the user.

Array<object>
Link

Link for a page.

object
dashboard_link
object
key
key

Key will present a placeholder in a text field to insert the link. For example: To view these events go to the ${{link:db_link}}. Required: YES.

string
>= 7 characters <= 1024 characters
log_filters
log_filters

Logs filter.

Array<object>
LogFilter

Log filter for filter query.

object
key
key

Key to be presented in the filter.

string
>= 7 characters <= 1024 characters
op
string
default: IN
Allowed values: IN NOT_IN
values
values

Values to be presented in the filter.

Array<string>
namespace
Namespace

Namespace for current request.

string
>= 6 characters <= 1024 characters
object_name
object_name

Object name such as LB, VH.

string
<= 1024 characters
time_range
time_range

Time range filter.

string
<= 1024 characters
title
title

Title for the link.

string
>= 6 characters <= 1024 characters
type
string
default: SECURITY_ANALYTICS_EVENTS
Allowed values: SECURITY_ANALYTICS_EVENTS REQUESTS_EVENTS SITES CLOUD_CREDENTIALS SITES_UBER SITE_ALERTS SITE_MANAGEMENT_AWS_VPC_SITES SITE_MANAGEMENT_AWS_TGW_SITES SITE_MANAGEMENT_AZURE_VNET_SITES SITE_MANAGEMENT_GCP_VPC_SITES SITE_MANAGEMENT_APP_STACK_SITES SITE_MANAGEMENT_SECURE_MESH_SITES TENANT_OVERVIEW_PAGE SUPPORT
generic_link
object
key
key

Key will present a placeholder in a text field to insert the link. For example: To view these events go to the ${{link:db_link}}. Required: YES.

string
>= 7 characters <= 1024 characters
title
title

Title for the link.

string
>= 6 characters <= 1024 characters
url
url

Full URL

string format: uri
<= 1024 characters
items
Items

Response will have set of lists.

Array<object>
object
item
item

List of item.

Array<object>
>= 15 characters <= 26 characters
object
link
object
dashboard_link
object
key
key

Key will present a placeholder in a text field to insert the link. For example: To view these events go to the ${{link:db_link}}. Required: YES.

string
>= 7 characters <= 1024 characters
log_filters
log_filters

Logs filter.

Array<object>
LogFilter

Log filter for filter query.

object
key
key

Key to be presented in the filter.

string
>= 7 characters <= 1024 characters
op
string
default: IN
Allowed values: IN NOT_IN
values
values

Values to be presented in the filter.

Array<string>
namespace
Namespace

Namespace for current request.

string
>= 6 characters <= 1024 characters
object_name
object_name

Object name such as LB, VH.

string
<= 1024 characters
time_range
time_range

Time range filter.

string
<= 1024 characters
title
title

Title for the link.

string
>= 6 characters <= 1024 characters
type
string
default: SECURITY_ANALYTICS_EVENTS
Allowed values: SECURITY_ANALYTICS_EVENTS REQUESTS_EVENTS SITES CLOUD_CREDENTIALS SITES_UBER SITE_ALERTS SITE_MANAGEMENT_AWS_VPC_SITES SITE_MANAGEMENT_AWS_TGW_SITES SITE_MANAGEMENT_AZURE_VNET_SITES SITE_MANAGEMENT_GCP_VPC_SITES SITE_MANAGEMENT_APP_STACK_SITES SITE_MANAGEMENT_SECURE_MESH_SITES TENANT_OVERVIEW_PAGE SUPPORT
generic_link
object
key
key

Key will present a placeholder in a text field to insert the link. For example: To view these events go to the ${{link:db_link}}. Required: YES.

string
>= 7 characters <= 1024 characters
title
title

Title for the link.

string
>= 6 characters <= 1024 characters
url
url

Full URL

string format: uri
<= 1024 characters
title
Title

Human-readable title for the resource

string
>= 6 characters <= 1024 characters
summary
summary

Configuration parameter for summary

string
<= 1024 characters
query_id
query_id

Query Identifier.

string
<= 1024 characters
site_analysis_response
object
external_links
external links

External doc links, that will be presented to the user.

Array<object>
Link

Link for a page.

object
dashboard_link
object
key
key

Key will present a placeholder in a text field to insert the link. For example: To view these events go to the ${{link:db_link}}. Required: YES.

string
>= 7 characters <= 1024 characters
log_filters
log_filters

Logs filter.

Array<object>
LogFilter

Log filter for filter query.

object
key
key

Key to be presented in the filter.

string
>= 7 characters <= 1024 characters
op
string
default: IN
Allowed values: IN NOT_IN
values
values

Values to be presented in the filter.

Array<string>
namespace
Namespace

Namespace for current request.

string
>= 6 characters <= 1024 characters
object_name
object_name

Object name such as LB, VH.

string
<= 1024 characters
time_range
time_range

Time range filter.

string
<= 1024 characters
title
title

Title for the link.

string
>= 6 characters <= 1024 characters
type
string
default: SECURITY_ANALYTICS_EVENTS
Allowed values: SECURITY_ANALYTICS_EVENTS REQUESTS_EVENTS SITES CLOUD_CREDENTIALS SITES_UBER SITE_ALERTS SITE_MANAGEMENT_AWS_VPC_SITES SITE_MANAGEMENT_AWS_TGW_SITES SITE_MANAGEMENT_AZURE_VNET_SITES SITE_MANAGEMENT_GCP_VPC_SITES SITE_MANAGEMENT_APP_STACK_SITES SITE_MANAGEMENT_SECURE_MESH_SITES TENANT_OVERVIEW_PAGE SUPPORT
generic_link
object
key
key

Key will present a placeholder in a text field to insert the link. For example: To view these events go to the ${{link:db_link}}. Required: YES.

string
>= 7 characters <= 1024 characters
title
title

Title for the link.

string
>= 6 characters <= 1024 characters
url
url

Full URL

string format: uri
<= 1024 characters
internal_links
internal links

Internal Link like dashboard links, that will be presented to the user.

Array<object>
Link

Link for a page.

object
dashboard_link
object
key
key

Key will present a placeholder in a text field to insert the link. For example: To view these events go to the ${{link:db_link}}. Required: YES.

string
>= 7 characters <= 1024 characters
log_filters
log_filters

Logs filter.

Array<object>
LogFilter

Log filter for filter query.

object
key
key

Key to be presented in the filter.

string
>= 7 characters <= 1024 characters
op
string
default: IN
Allowed values: IN NOT_IN
values
values

Values to be presented in the filter.

Array<string>
namespace
Namespace

Namespace for current request.

string
>= 6 characters <= 1024 characters
object_name
object_name

Object name such as LB, VH.

string
<= 1024 characters
time_range
time_range

Time range filter.

string
<= 1024 characters
title
title

Title for the link.

string
>= 6 characters <= 1024 characters
type
string
default: SECURITY_ANALYTICS_EVENTS
Allowed values: SECURITY_ANALYTICS_EVENTS REQUESTS_EVENTS SITES CLOUD_CREDENTIALS SITES_UBER SITE_ALERTS SITE_MANAGEMENT_AWS_VPC_SITES SITE_MANAGEMENT_AWS_TGW_SITES SITE_MANAGEMENT_AZURE_VNET_SITES SITE_MANAGEMENT_GCP_VPC_SITES SITE_MANAGEMENT_APP_STACK_SITES SITE_MANAGEMENT_SECURE_MESH_SITES TENANT_OVERVIEW_PAGE SUPPORT
generic_link
object
key
key

Key will present a placeholder in a text field to insert the link. For example: To view these events go to the ${{link:db_link}}. Required: YES.

string
>= 7 characters <= 1024 characters
title
title

Title for the link.

string
>= 6 characters <= 1024 characters
url
url

Full URL

string format: uri
<= 1024 characters
overlay_content
object
data
object
priority
priority

Priority for the support ticket.

string
<= 1024 characters
product_data
product data

Product Data for the support ticket.

string
<= 1024 characters
subject
subject

Subject for the support ticket.

string
<= 1024 characters
support_type
type

Type for the support ticket.

string
<= 1024 characters
topic
topic

Topic for the support ticket.

string
<= 1024 characters
workspace
workspace

Workspace for the support ticket.

string
<= 1024 characters
title
title

Title for the link.

string
>= 6 characters <= 1024 characters
type
string
default: SECURITY_ANALYTICS_EVENTS
Allowed values: SECURITY_ANALYTICS_EVENTS REQUESTS_EVENTS SITES CLOUD_CREDENTIALS SITES_UBER SITE_ALERTS SITE_MANAGEMENT_AWS_VPC_SITES SITE_MANAGEMENT_AWS_TGW_SITES SITE_MANAGEMENT_AZURE_VNET_SITES SITE_MANAGEMENT_GCP_VPC_SITES SITE_MANAGEMENT_APP_STACK_SITES SITE_MANAGEMENT_SECURE_MESH_SITES TENANT_OVERVIEW_PAGE SUPPORT
summary
summary

Configuration parameter for summary

string
<= 1024 characters
table_view
object
item
object
field_properties
Field Properties x-displayName: "Field Properties" Lists the name of the field & corresponding properties

Lists the name of the field & corresponding properties.

Array<object>
object
data_type
string
default: COLUMN_TYPE_NONE
Allowed values: COLUMN_TYPE_NONE STRING INT FLOAT BOOL
display
object
colour
string
default: COLOUR_TYPE_NONE
Allowed values: COLOUR_TYPE_NONE DANGER INFO WARNING AMBER SUCCESS MALIBU
display_type
string
default: DISPLAY_TYPE_NONE
Allowed values: DISPLAY_TYPE_NONE ICON DOT_WITH_VALUE PROGRESS_BAR DATE DURATION PROVIDER_ICON
formats
format

Data format specification

Array<string>
Allowed values: FORMAT_TYPE_NONE INLINE BOLD REVERSE_KEY_VALUE_ORDER WRAP
name
Name

Human-readable name for the resource

string
>= 6 characters <= 1024 characters
title
Title

Human-readable title for the resource

string
>= 6 characters <= 1024 characters
tooltip
Tooltip

Tooltip for the field.

string
<= 1024 characters
unit
string
default: UNIT_TYPE_NONE
Allowed values: UNIT_TYPE_NONE GB PERCENT BYTE
rows
rows

List of table rows.

Array<object>
Row

Contains the value for each rows of table.

object
cells
Values

Configuration parameter for cells

Array<object>
object
link
object
dashboard_link
object
key
key

Key will present a placeholder in a text field to insert the link. For example: To view these events go to the ${{link:db_link}}. Required: YES.

string
>= 7 characters <= 1024 characters
log_filters
log_filters

Logs filter.

Array<object>
LogFilter

Log filter for filter query.

object
key
key

Key to be presented in the filter.

string
>= 7 characters <= 1024 characters
op
string
default: IN
Allowed values: IN NOT_IN
values
values

Values to be presented in the filter.

Array<string>
namespace
Namespace

Namespace for current request.

string
>= 6 characters <= 1024 characters
object_name
object_name

Object name such as LB, VH.

string
<= 1024 characters
time_range
time_range

Time range filter.

string
<= 1024 characters
title
title

Title for the link.

string
>= 6 characters <= 1024 characters
type
string
default: SECURITY_ANALYTICS_EVENTS
Allowed values: SECURITY_ANALYTICS_EVENTS REQUESTS_EVENTS SITES CLOUD_CREDENTIALS SITES_UBER SITE_ALERTS SITE_MANAGEMENT_AWS_VPC_SITES SITE_MANAGEMENT_AWS_TGW_SITES SITE_MANAGEMENT_AZURE_VNET_SITES SITE_MANAGEMENT_GCP_VPC_SITES SITE_MANAGEMENT_APP_STACK_SITES SITE_MANAGEMENT_SECURE_MESH_SITES TENANT_OVERVIEW_PAGE SUPPORT
generic_link
object
key
key

Key will present a placeholder in a text field to insert the link. For example: To view these events go to the ${{link:db_link}}. Required: YES.

string
>= 7 characters <= 1024 characters
title
title

Title for the link.

string
>= 6 characters <= 1024 characters
url
url

Full URL

string format: uri
<= 1024 characters
properties
object
status_style
string
default: STATUS_STYLE_UNKNOWN
Allowed values: STATUS_STYLE_UNKNOWN STATUS_STYLE_SUCCESS STATUS_STYLE_DANGER STATUS_STYLE_WARNING STATUS_STYLE_INACTIVE STATUS_STYLE_MINOR
value
Value

Configuration parameter for value

string
>= 3 characters <= 1024 characters
widget_type
string
default: WIDGET_TYPE_NONE
Allowed values: WIDGET_TYPE_NONE TWO_VALUE DISTRIBUTION_CHART TABLE LIST GRID PIE
widget_response
object
item_links
item_links

Links that will be presented to the user.

Array<object>
Link

Link for a page.

object
dashboard_link
object
key
key

Key will present a placeholder in a text field to insert the link. For example: To view these events go to the ${{link:db_link}}. Required: YES.

string
>= 7 characters <= 1024 characters
log_filters
log_filters

Logs filter.

Array<object>
LogFilter

Log filter for filter query.

object
key
key

Key to be presented in the filter.

string
>= 7 characters <= 1024 characters
op
string
default: IN
Allowed values: IN NOT_IN
values
values

Values to be presented in the filter.

Array<string>
namespace
Namespace

Namespace for current request.

string
>= 6 characters <= 1024 characters
object_name
object_name

Object name such as LB, VH.

string
<= 1024 characters
time_range
time_range

Time range filter.

string
<= 1024 characters
title
title

Title for the link.

string
>= 6 characters <= 1024 characters
type
string
default: SECURITY_ANALYTICS_EVENTS
Allowed values: SECURITY_ANALYTICS_EVENTS REQUESTS_EVENTS SITES CLOUD_CREDENTIALS SITES_UBER SITE_ALERTS SITE_MANAGEMENT_AWS_VPC_SITES SITE_MANAGEMENT_AWS_TGW_SITES SITE_MANAGEMENT_AZURE_VNET_SITES SITE_MANAGEMENT_GCP_VPC_SITES SITE_MANAGEMENT_APP_STACK_SITES SITE_MANAGEMENT_SECURE_MESH_SITES TENANT_OVERVIEW_PAGE SUPPORT
generic_link
object
key
key

Key will present a placeholder in a text field to insert the link. For example: To view these events go to the ${{link:db_link}}. Required: YES.

string
>= 7 characters <= 1024 characters
title
title

Title for the link.

string
>= 6 characters <= 1024 characters
url
url

Full URL

string format: uri
<= 1024 characters
items
Items

Response will have different types of widgets.

Array<object>
object
item
object
field_properties
Field Properties x-displayName: "Field Properties" Lists the name of the field & corresponding properties

Lists the name of the field & corresponding properties.

Array<object>
object
data_type
string
default: COLUMN_TYPE_NONE
Allowed values: COLUMN_TYPE_NONE STRING INT FLOAT BOOL
display
object
colour
string
default: COLOUR_TYPE_NONE
Allowed values: COLOUR_TYPE_NONE DANGER INFO WARNING AMBER SUCCESS MALIBU
display_type
string
default: DISPLAY_TYPE_NONE
Allowed values: DISPLAY_TYPE_NONE ICON DOT_WITH_VALUE PROGRESS_BAR DATE DURATION PROVIDER_ICON
formats
format

Data format specification

Array<string>
Allowed values: FORMAT_TYPE_NONE INLINE BOLD REVERSE_KEY_VALUE_ORDER WRAP
name
Name

Human-readable name for the resource

string
>= 6 characters <= 1024 characters
title
Title

Human-readable title for the resource

string
>= 6 characters <= 1024 characters
tooltip
Tooltip

Tooltip for the field.

string
<= 1024 characters
unit
string
default: UNIT_TYPE_NONE
Allowed values: UNIT_TYPE_NONE GB PERCENT BYTE
rows
rows

List of table rows.

Array<object>
Row

Contains the value for each rows of table.

object
cells
Values

Configuration parameter for cells

Array<object>
object
link
object
dashboard_link
object
key
key

Key will present a placeholder in a text field to insert the link. For example: To view these events go to the ${{link:db_link}}. Required: YES.

string
>= 7 characters <= 1024 characters
log_filters
log_filters

Logs filter.

Array<object>
LogFilter

Log filter for filter query.

object
key
key

Key to be presented in the filter.

string
>= 7 characters <= 1024 characters
op
string
default: IN
Allowed values: IN NOT_IN
values
values

Values to be presented in the filter.

Array<string>
namespace
Namespace

Namespace for current request.

string
>= 6 characters <= 1024 characters
object_name
object_name

Object name such as LB, VH.

string
<= 1024 characters
time_range
time_range

Time range filter.

string
<= 1024 characters
title
title

Title for the link.

string
>= 6 characters <= 1024 characters
type
string
default: SECURITY_ANALYTICS_EVENTS
Allowed values: SECURITY_ANALYTICS_EVENTS REQUESTS_EVENTS SITES CLOUD_CREDENTIALS SITES_UBER SITE_ALERTS SITE_MANAGEMENT_AWS_VPC_SITES SITE_MANAGEMENT_AWS_TGW_SITES SITE_MANAGEMENT_AZURE_VNET_SITES SITE_MANAGEMENT_GCP_VPC_SITES SITE_MANAGEMENT_APP_STACK_SITES SITE_MANAGEMENT_SECURE_MESH_SITES TENANT_OVERVIEW_PAGE SUPPORT
generic_link
object
key
key

Key will present a placeholder in a text field to insert the link. For example: To view these events go to the ${{link:db_link}}. Required: YES.

string
>= 7 characters <= 1024 characters
title
title

Title for the link.

string
>= 6 characters <= 1024 characters
url
url

Full URL

string format: uri
<= 1024 characters
properties
object
status_style
string
default: STATUS_STYLE_UNKNOWN
Allowed values: STATUS_STYLE_UNKNOWN STATUS_STYLE_SUCCESS STATUS_STYLE_DANGER STATUS_STYLE_WARNING STATUS_STYLE_INACTIVE STATUS_STYLE_MINOR
value
Value

Configuration parameter for value

string
>= 3 characters <= 1024 characters
widget_type
string
default: WIDGET_TYPE_NONE
Allowed values: WIDGET_TYPE_NONE TWO_VALUE DISTRIBUTION_CHART TABLE LIST GRID PIE
summary
summary

Configuration parameter for summary

string
<= 1024 characters
Example
{
  "explain_log": {
    "bot_defense_event_details": {
      "action": "ACTION_NONE"
    },
    "svc_policy_event_details": {
      "action": "ACTION_NONE",
      "ip_risk": "IP_REPUTATION_NONE",
      "ip_threat_categories": [
        "SPAM_SOURCES"
      ],
      "ip_trustworthiness": "IP_REPUTATION_NONE"
    },
    "waf_event_details": {
      "action": "ACTION_NONE",
      "enforcement_mode": "ENFORCEMENT_NONE",
      "signatures": [
        {
          "accuracy": "ACCURACY_NONE"
        }
      ]
    }
  },
  "gen_dashboard_filter": {
    "links": [
      {
        "dashboard_link": {
          "log_filters": [
            {
              "op": "IN"
            }
          ],
          "type": "SECURITY_ANALYTICS_EVENTS"
        }
      }
    ]
  },
  "generic_response": {
    "error": {
      "code": "EOK"
    }
  },
  "list_response": {
    "external_links": [
      {
        "dashboard_link": {
          "log_filters": [
            {
              "op": "IN"
            }
          ],
          "type": "SECURITY_ANALYTICS_EVENTS"
        }
      }
    ],
    "items": [
      {
        "item": [
          {
            "link": {
              "dashboard_link": {
                "log_filters": [
                  {
                    "op": "IN"
                  }
                ],
                "type": "SECURITY_ANALYTICS_EVENTS"
              }
            }
          }
        ]
      }
    ]
  },
  "site_analysis_response": {
    "external_links": [
      {
        "dashboard_link": {
          "log_filters": [
            {
              "op": "IN"
            }
          ],
          "type": "SECURITY_ANALYTICS_EVENTS"
        }
      }
    ],
    "internal_links": [
      {
        "dashboard_link": {
          "log_filters": [
            {
              "op": "IN"
            }
          ],
          "type": "SECURITY_ANALYTICS_EVENTS"
        }
      }
    ],
    "overlay_content": {
      "type": "SECURITY_ANALYTICS_EVENTS"
    },
    "table_view": {
      "item": {
        "field_properties": [
          {
            "data_type": "COLUMN_TYPE_NONE",
            "display": {
              "colour": "COLOUR_TYPE_NONE",
              "display_type": "DISPLAY_TYPE_NONE",
              "formats": [
                "FORMAT_TYPE_NONE"
              ]
            },
            "unit": "UNIT_TYPE_NONE"
          }
        ],
        "rows": [
          {
            "cells": [
              {
                "link": {
                  "dashboard_link": {
                    "log_filters": [
                      {
                        "op": "IN"
                      }
                    ],
                    "type": "SECURITY_ANALYTICS_EVENTS"
                  }
                },
                "properties": {
                  "status_style": "STATUS_STYLE_UNKNOWN"
                }
              }
            ]
          }
        ],
        "widget_type": "WIDGET_TYPE_NONE"
      }
    }
  },
  "widget_response": {
    "item_links": [
      {
        "dashboard_link": {
          "log_filters": [
            {
              "op": "IN"
            }
          ],
          "type": "SECURITY_ANALYTICS_EVENTS"
        }
      }
    ],
    "items": [
      {
        "item": {
          "field_properties": [
            {
              "data_type": "COLUMN_TYPE_NONE",
              "display": {
                "colour": "COLOUR_TYPE_NONE",
                "display_type": "DISPLAY_TYPE_NONE",
                "formats": [
                  "FORMAT_TYPE_NONE"
                ]
              },
              "unit": "UNIT_TYPE_NONE"
            }
          ],
          "rows": [
            {
              "cells": [
                {
                  "link": {
                    "dashboard_link": {
                      "log_filters": [
                        {
                          "op": "IN"
                        }
                      ],
                      "type": "SECURITY_ANALYTICS_EVENTS"
                    }
                  },
                  "properties": {
                    "status_style": "STATUS_STYLE_UNKNOWN"
                  }
                }
              ]
            }
          ],
          "widget_type": "WIDGET_TYPE_NONE"
        }
      }
    ]
  }
}

401

Section titled “401”

Returned when operation is not authorized.

Media typeapplication/json
string format: string
Examplegenerated
example

403

Section titled “403”

Returned when there is no permission to access resource.

Media typeapplication/json
string format: string
Examplegenerated
example

404

Section titled “404”

Returned when resource is not found.

Media typeapplication/json
string format: string
Examplegenerated
example

409

Section titled “409”

Returned when operation on resource is conflicting with current value.

Media typeapplication/json
string format: string
Examplegenerated
example

429

Section titled “429”

Returned when operation has been rejected as it is happening too frequently.

Media typeapplication/json
string format: string
Examplegenerated
example

500

Section titled “500”

Returned when server encountered an error in processing API.

Media typeapplication/json
string format: string
Examplegenerated
example

503

Section titled “503”

Returned when service is unavailable temporarily.

Media typeapplication/json
string format: string
Examplegenerated
example

504

Section titled “504”

Returned when server timed out processing request.

Media typeapplication/json
string format: string
Examplegenerated
example