Press CTRL+K to open search

System current health request

  • Published on Sep 3, 2026
  • 7 minute(s) read
Prev Next

Returns the current system health status.

GET https://<address>/wsapis/v2.0.0/common/health/current

Availability

This command is available on the following appliances:

  • Email Security — Server

  • Central Management System

  • Network Security

Required headers:

X-FeApi-Token: [API-Token]
X-FeClient-Token: [Client-Token]

Parameters

  • service_id—Returns status for the specified service.

  • category—Returns status for the specified category. Value can be system or services.

  • status—Returns status for the specified status. Value can be HEALTHY, DEGRADED, FAILED, or DISABLED.

Example request

GET https://xxx.xxx.xxx.xxx:443/wsapis/v2.0.0/common/health/current
GET https://xxx.xxx.xxx.xxx:443/wsapis/v2.0.0/common/health/current?category=System

Request headers:

X-FeApi-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
X-FeClient-Token: BigDataInc

System current health response

Line breaks have been added for readability.

HTTP/1.1 [Response Code] [Response Message]
Date: [Date]
Response

  • Response Code—A standard HTML response code.

    • 200—Request successful.

    • 401—Request unsuccessful because the session token was invalid.

  • Response Message—A standard HTML response message.

    • OK—Request successful.

    • Unauthorized—Request unsuccessful because the session token was invalid.

  • Date—Standard HTML date format.

Example

Line breaks have been added for readability.

{
  "last_updated": "2021-11-01T23:30:00",
  "services_status": [
    {
      "service_id": "fenet",
      "name": "FENET Cloud Services",
      "details": {"text": "Healthy"},
      "category": "DTI",
      "status": "Healthy"
    },
    {
      "service_id": "fe_licenses",
      "name": "Licenses Monitoring",
      "details": {"text": "Healthy"},
      "category": "System",
      "status": "Healthy"
    },
    {
      "service_id": "scontent",
      "name": "Security Contents",
      "details": {"text": "Healthy"},
      "category": "DTI",
      "status": "Healthy"
    },
    {
      "service_id": "gi",
      "name": "Guest Images",
      "details": {"text": "Installed Version: 21.0301"},
      "category": "DTI",
      "status": "Healthy"
    },
    {
      "service_id": "diskio",
      "name": "Disk Storage",
      "details": {"text": "Healthy"},
      "category": "System",
      "status": "Healthy"
    },
    {
      "service_id": "perfmon_health",
      "name": "System Performance Monitor",
      "details": {"text": "Healthy"},
      "category": "System",
      "status": "Healthy"
    },
    {
      "service_id": "system_load_health",
      "name": "System Load",
      "details": {"text": "Healthy"},
      "category": "System",
      "status": "Healthy"
    },
    {
      "service_id": "system_memory_health",
      "name": "System Memory",
      "details": {"text": "Healthy"},
      "category": "System",
      "status": "Healthy"
    },
    {
      "service_id": "cms_server",
      "name": "CMS Server Connectivity",
      "details": {"text": "No CMS configured"},
      "category": "DTI",
      "status": "Disabled"
    },
    {
      "service_id": "interface_health",
      "name": "Ethernet Interfaces",
      "details": {"text": "Healthy"},
      "category": "System",
      "status": "Healthy"
    },
    {
      "service_id": "wsapi",
      "name": "WSAPI Service",
      "details": {"text": "Healthy"},
      "category": "System",
      "status": "Healthy"
    },
    {
      "service_id": "sa_python",
      "name": "Static Analysis - YARA",
      "details": {"text": "Healthy"},
      "category": "Analysis",
      "status": "Healthy"
    },
    {
      "service_id": "ecd",
      "name": "Email Campaign Detection",
      "details": {"text": "Healthy"},
      "category": "Email Processing",
      "status": "Healthy"
    },
    {
      "service_id": "fedb_external",
      "name": "Database Service",
      "details": {"text": "Healthy, {\"free_space\": \"188.490478515625 GB\", \"db_size\": \"0.6100072860717773 GB\"}"},
      "category": "System",
      "status": "Healthy"
    },
    {
      "service_id": "helix_datastreaming",
      "name": "Helix Datastreaming",
      "user_recovery_steps": [
        "1. Ensure that the username and password credentials for the Enrollment and Helix service are correct by using CLI 'show fenet dti configuration",
        "2. Ensure that all required licenses are active",
        "3. Check the status of the discovery client by invoking the 'show fenet rds discovery status'",
        "4. Check to ensure that the Helix bootstrap is installed by invoking the 'show helix' CLI",
        "5. Call FireEye Customer Support is the failure persists."
      ],
      "details": {"text": "The Helix bootstrap certificate could not be installed: 'Could not fetch bootstrap certificate: unknown url type: ':///helix/api/bootstraps/getByCustomer''"},
      "category": "Metadata Streaming",
      "status": "Warning"
    },
    {
      "service_id": "retro",
      "name": "Retroactive Detection",
      "details": {"text": "Healthy"},
      "category": "Cloud Detection",
      "status": "Healthy"
    },
    {
      "service_id": "remediator",
      "name": "Retroactive Email Remediation",
      "details": {"text": "Disabled by user config"},
      "category": "Email Processing",
      "status": "Disabled"
    },
    {
      "service_id": "email_parser",
      "name": "Email Parsing",
      "details": {"text": "Healthy"},
      "category": "Email Processing",
      "status": "Healthy"
    },
    {
      "service_id": "email_yara",
      "name": "Email YARA",
      "details": {"text": "Healthy"},
      "category": "Email Processing",
      "status": "Healthy"
    },
    {
      "service_id": "url_rewrite",
      "name": "URL Rewrite",
      "details": {"text": "Disabled by user config"},
      "category": "Email Processing",
      "status": "Disabled"
    },
    {
      "service_id": "email_queue",
      "name": "Email Queue",
      "details": {"text": "Healthy"},
      "category": "Email Processing",
      "status": "Healthy"
    },
    {
      "service_id": "feconnect",
      "name": "HelixConnect",
      "details": {"text": "Disabled by user config"},
      "category": "System",
      "status": "Disabled"
    },
    {
      "service_id": "analysis_queue",
      "name": "Submission Queue",
      "details": {"text": "Healthy"},
      "category": "Analysis",
      "status": "Healthy"
    },
    {
      "service_id": "nexthop_mta",
      "name": "Next-Hop MTA",
      "details": {"text": "Healthy"},
      "category": "Email Processing",
      "status": "Healthy"
    },
    {
      "service_id": "globalcache",
      "name": "Global Cache",
      "details": {"text": "Healthy"},
      "category": "Cloud Detection",
      "status": "Healthy"
    },
    {
      "service_id": "dua",
      "name": "Dynamic URL Analysis (Live Mode)",
      "details": {"text": "Disabled by user config"},
      "category": "Analysis",
      "status": "Disabled"
    },
    {
      "service_id": "url_transform",
      "name": "URL Transform",
      "details": {"text": "Healthy"},
      "category": "Analysis",
      "status": "Healthy"
    },
    {
      "service_id": "url_extract",
      "name": "URL Extract",
      "details": {"text": "Healthy"},
      "category": "Analysis",
      "status": "Healthy"
    },
    {
      "service_id": "faude",
      "name": "Advanced URL Defense",
      "details": {"text": "Healthy"},
      "category": "Cloud Detection",
      "status": "Healthy"
    },
    {
      "service_id": "snort",
      "name": "URL Static Analysis",
      "details": {"text": "Healthy"},
      "category": "Analysis",
      "status": "Healthy"
    },
    {
      "service_id": "submission_client",
      "name": "MVX Submission Client",
      "details": {"text": "Disabled by user config"},
      "category": "Analysis",
      "status": "Disabled"
    }
  ]
}

cURL code sample: system current health

The following code sample can be copied and executed from any command-line interface that includes the cURL library. This sample builds on the authentication cURL code sample.

Note

In this sample, line breaks are added for readability. Remove these line breaks before you paste the code sample into your command-line tool.

curl -qgsSkH --no-progress-bar --header "X-FeApi-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" https://xxx.xxx.xxx.xxx:443/wsapis/v2.0.0/common/health/current

This cURL sample includes the following:

  • -q—This option specifies that the curlrc config file is not read or used. Although this is an optional setting, Trellix recommends that you include this option.

  • -g—This option turns off the URL globbing parser. Although this is an optional setting, Trellix recommends that you include this option.

  • -s—This option turns off the progress meter and error message. Although this is an optional setting, Trellix recommends that you include this option.

  • -S—When used with the -s option, this option shows error messages if your cURL switch fails. Although this is an optional setting, Trellix recommends that you include this option.

  • -k—This option explicitly allows cURL to perform insecure SSL connections and transfers. This allows you to test your SSL connection without installing a CA certificate.

  • -H—This option allows you to specify a custom header with the --header switch.

  • --no-progress-bar—This option suppresses the cURL download progress bar, which can interfere with the request.

  • --header "X-FeApi-Token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"—This custom header returns the API token that was provided during the authentication request. In the authentication cURL code sample, this token was included in the auth.txt file. Replace the token in the sample with the token value received in the response to your authentication request.

    Note

    By default, the X-FeApi-Token times out after 15 minutes of inactivity.

  • https://xxx.xxx.xxx.xxx:443/wsapis/v2.0.0/common/health/current—The system health request URL. Replace the IP address xxx.xxx.xxx.xxx with the IP address of your appliance.

Results

This example returns a report of the current system health.

:
Related articles
Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy.
Products
Company
Top Features
Solutions
Existing Users
Connect With Us
Sales and Support
Copyright © Abc Inc. All Rights Reserved