Get Ai Assistant Firewall Status

Get Ai Assistant Firewall Status
Get AI Assistants for Firewall status.

Get status information for AI Assistants for Firewall including bundle import status, license, and daily quota.

Request
URI
GET
https://{api_host}/ai-assistants/platform/firewall/status
COPY
Authentication
This operation uses the following authentication methods.
Responses
200

Get operation completed successfully.

Returns AIAssistantsVerticalStatus of type(s) application/json 
{
    "overall_status": "OPERATIONAL",
    "quota_status": "QUOTA_OK",
    "license_status": "LICENSE_VALID",
    "bundle_import_status": "BUNDLE_IMPORT_COMPLETED",
    "bundle_import_time": 1734567890000,
    "current_bundle_version": "5.2.0_20251001",
    "llm_reachability": "REACHABLE",
    "llm_key_status": "VALID",
    "service_status": "UP"
}
string
overall_status
Optional

The overall health of the vertical, considering license, token quota, bundle import status, LLM key status, and service health.

Enumeration: OPERATIONAL, DEGRADED, INITIALIZING
string
quota_status
Optional

The status of the daily token quota.

Enumeration: QUOTA_OK, QUOTA_EXCEEDED, QUOTA_NEARING_LIMIT, QUOTA_NOT_APPLICABLE, QUOTA_NOT_AVAILABLE, QUOTA_UNKNOWN
string
license_status
Optional

The status of the license for AI Assistants for this vertical.

Enumeration: LICENSE_VALID, LICENSE_INVALID, LICENSE_EXPIRED
string
bundle_import_status
Read-Only  

Status of the bundle import process.

Enumeration: BUNDLE_IMPORT_NOT_STARTED, BUNDLE_IMPORT_IN_PROGRESS, BUNDLE_IMPORT_COMPLETED, BUNDLE_IMPORT_FAILED
integer
bundle_import_progress
Read-Only  

Percentage of the bundle import process completed (0-100). Meaningful when bundle_import_status is BUNDLE_IMPORT_IN_PROGRESS.

string
bundle_import_message
Read-Only  

Human-readable status for the bundle download progress.

integer As int64 As int64
bundle_import_time
Optional

Timestamp in milliseconds since epoch.

string
current_bundle_version
Read-Only  

Version of the currently imported bundle.

string
llm_reachability
Read-Only  

Status of connectivity to the configured LLM provider.

Enumeration: REACHABLE, UNREACHABLE, UNKNOWN
string
llm_key_status
Read-Only  

Status of the configured LLM key (user-provided or Broadcom-managed).

Enumeration: VALID, EXPIRED, UNKNOWN
string
service_status
Read-Only  

Health status of the ai-assistant service from cluster monitor.

Enumeration: UP, DOWN, DEGRADED, UNKNOWN
string
error_message
Read-Only  

Error message if there is a failure.


400

Bad Request

Returns BadRequest of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required  

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required  

Message describing the error.


401

Unauthorized

Returns Unauthorized of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required  

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required  

Message describing the error.


403

Forbidden

Returns Forbidden of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required  

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required  

Message describing the error.


404

AI Assistants for Firewall not configured.

Returns Error of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required  

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required  

Message describing the error.


412

Precondition Failed

Returns PreconditionFailed of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required  

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required  

Message describing the error.


428

Precondition Required

Returns PreconditionRequired of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required  

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required  

Message describing the error.


429

Too Many Requests

Returns TooManyRequests of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required  

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required  

Message describing the error.


default

Get operation encountered error.

Returns Error of type(s) application/json 
{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}
integer
error_code
Required  

HTTP Status or Application error code.

string
module_name
Optional

Module where the error happened.

string
error_message
Required  

Message describing the error.


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/ai-assistants/platform/firewall/status
On This Page
Ai Assistants Platform Firewall Operations
GET
Get Ai Assistants Firewall Config
PUT
Update Ai Assistants Firewall Config
GET
Get Ai Assistant Firewall Status