alert.list_categories
=====================

List all types of alerts which the system can issue.

.. raw:: html

    <div id="json-schema">
    <span class="badge badge-dark value-type">Type: object</span><br/>
    <div class="accordion" id="accordionCall_parameters">
    <div class="card">
    <div class="card-header" id="headingCall_parameters">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters" data-toggle="collapse" onclick="setAnchor('#Call_parameters')" type="button"><span class="property-name">Call parameters</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters" class="collapse property-definition-div" data-parent="#accordionCall_parameters" id="Call_parameters">
    <div class="card-body pl-5">
    <span class="badge badge-dark value-type">Type: array</span><br/>
    <span class="badge badge-info no-additional">No Additional Items</span><h4>Tuple Validation</h4>
    <h5>Parameter 1: options</h5>
    <div class="card">
    <div class="card-body items-definition" id="Call_parameters_items_i0">
    <h4>options</h4><span class="badge badge-dark value-type">Type: object</span> <div class="json-default-value">Default:<div class="value">{
      "include_all_products": false,
      "include_hidden_classes": false
    }</div></div><br/>
    <span class="description"><p>List options.</p>
    </span> <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionCall_parameters_items_i0_include_all_products">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_include_all_products">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_include_all_products" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_include_all_products" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_include_all_products')" type="button"><span class="property-name">include_all_products</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_include_all_products" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_include_all_products" id="Call_parameters_items_i0_include_all_products">
    <div class="card-body pl-5">
    <h4>Include All Products</h4><span class="badge badge-dark value-type">Type: boolean</span> <span class="badge badge-success default-value">Default: false</span><br/>
    <span class="description"><p>Include alert classes for all products, not just the current one.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_include_hidden_classes">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_include_hidden_classes">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_include_hidden_classes" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_include_hidden_classes" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_include_hidden_classes')" type="button"><span class="property-name">include_hidden_classes</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_include_hidden_classes" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_include_hidden_classes" id="Call_parameters_items_i0_include_hidden_classes">
    <div class="card-body pl-5">
    <h4>Include Hidden Classes</h4><span class="badge badge-dark value-type">Type: boolean</span> <span class="badge badge-success default-value">Default: false</span><br/>
    <span class="description"><p>Include hidden alert classes.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value">
    <div class="card">
    <div class="card-header" id="headingReturn_value">
    <h2 class="mb-0">
    <button aria-controls="Return_value" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value" data-toggle="collapse" onclick="setAnchor('#Return_value')" type="button"><span class="property-name">Return value</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value" class="collapse property-definition-div" data-parent="#accordionReturn_value" id="Return_value">
    <div class="card-body pl-5">
    <h4>Result</h4><span class="badge badge-dark value-type">Type: array of object</span><br/>
    <span class="description"><p>Array of available alert categories and their classes.</p>
    </span>
    <span class="badge badge-info no-additional">No Additional Items</span><h5>Each item of this array must be:</h5>
    <div class="card">
    <div class="card-body items-definition" id="Return_value_items">
    <h4>AlertCategory</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionReturn_value_items_id">
    <div class="card">
    <div class="card-header" id="headingReturn_value_items_id">
    <h2 class="mb-0">
    <button aria-controls="Return_value_items_id" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_items_id" data-toggle="collapse" onclick="setAnchor('#Return_value_items_id')" type="button"><span class="property-name">id</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_items_id" class="collapse property-definition-div" data-parent="#accordionReturn_value_items_id" id="Return_value_items_id">
    <div class="card-body pl-5">
    <h4>Id</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Unique identifier for the alert category.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_items_title">
    <div class="card">
    <div class="card-header" id="headingReturn_value_items_title">
    <h2 class="mb-0">
    <button aria-controls="Return_value_items_title" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_items_title" data-toggle="collapse" onclick="setAnchor('#Return_value_items_title')" type="button"><span class="property-name">title</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_items_title" class="collapse property-definition-div" data-parent="#accordionReturn_value_items_title" id="Return_value_items_title">
    <div class="card-body pl-5">
    <h4>Title</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Human-readable title for the alert category.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_items_classes">
    <div class="card">
    <div class="card-header" id="headingReturn_value_items_classes">
    <h2 class="mb-0">
    <button aria-controls="Return_value_items_classes" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_items_classes" data-toggle="collapse" onclick="setAnchor('#Return_value_items_classes')" type="button"><span class="property-name">classes</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_items_classes" class="collapse property-definition-div" data-parent="#accordionReturn_value_items_classes" id="Return_value_items_classes">
    <div class="card-body pl-5">
    <h4>Classes</h4><span class="badge badge-dark value-type">Type: array of object</span><br/>
    <span class="description"><p>Array of alert classes within this category.</p>
    </span>
    <span class="badge badge-info no-additional">No Additional Items</span><h5>Each item of this array must be:</h5>
    <div class="card">
    <div class="card-body items-definition" id="Return_value_items_classes_items">
    <h4>AlertCategoryClass</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionReturn_value_items_classes_items_id">
    <div class="card">
    <div class="card-header" id="headingReturn_value_items_classes_items_id">
    <h2 class="mb-0">
    <button aria-controls="Return_value_items_classes_items_id" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_items_classes_items_id" data-toggle="collapse" onclick="setAnchor('#Return_value_items_classes_items_id')" type="button"><span class="property-name">id</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_items_classes_items_id" class="collapse property-definition-div" data-parent="#accordionReturn_value_items_classes_items_id" id="Return_value_items_classes_items_id">
    <div class="card-body pl-5">
    <h4>Id</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Unique identifier for the alert class.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_items_classes_items_title">
    <div class="card">
    <div class="card-header" id="headingReturn_value_items_classes_items_title">
    <h2 class="mb-0">
    <button aria-controls="Return_value_items_classes_items_title" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_items_classes_items_title" data-toggle="collapse" onclick="setAnchor('#Return_value_items_classes_items_title')" type="button"><span class="property-name">title</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_items_classes_items_title" class="collapse property-definition-div" data-parent="#accordionReturn_value_items_classes_items_title" id="Return_value_items_classes_items_title">
    <div class="card-body pl-5">
    <h4>Title</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Human-readable title for the alert class.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_items_classes_items_level">
    <div class="card">
    <div class="card-header" id="headingReturn_value_items_classes_items_level">
    <h2 class="mb-0">
    <button aria-controls="Return_value_items_classes_items_level" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_items_classes_items_level" data-toggle="collapse" onclick="setAnchor('#Return_value_items_classes_items_level')" type="button"><span class="property-name">level</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_items_classes_items_level" class="collapse property-definition-div" data-parent="#accordionReturn_value_items_classes_items_level" id="Return_value_items_classes_items_level">
    <div class="card-body pl-5">
    <h4>Level</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Default severity level for alerts in this class.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_items_classes_items_product_types">
    <div class="card">
    <div class="card-header" id="headingReturn_value_items_classes_items_product_types">
    <h2 class="mb-0">
    <button aria-controls="Return_value_items_classes_items_product_types" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_items_classes_items_product_types" data-toggle="collapse" onclick="setAnchor('#Return_value_items_classes_items_product_types')" type="button"><span class="property-name">product_types</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_items_classes_items_product_types" class="collapse property-definition-div" data-parent="#accordionReturn_value_items_classes_items_product_types" id="Return_value_items_classes_items_product_types">
    <div class="card-body pl-5">
    <h4>Product Types</h4><span class="badge badge-dark value-type">Type: array of enum (of string)</span><br/>
    <span class="description"><p>Product types where this alert class is available.</p>
    </span>
    <span class="badge badge-info no-additional">No Additional Items</span><h5>Each item of this array must be:</h5>
    <div class="card">
    <div class="card-body items-definition" id="Return_value_items_classes_items_product_types_items">
    <span class="badge badge-dark value-type">Type: enum (of string)</span><br/>
    <div class="enum-value" id="Return_value_items_classes_items_product_types_items_enum">
    <h5>Must be one of:</h5>
    <ul class="list-group"><li class="list-group-item enum-item">"COMMUNITY_EDITION"</li><li class="list-group-item enum-item">"ENTERPRISE"</li></ul>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_items_classes_items_proactive_support">
    <div class="card">
    <div class="card-header" id="headingReturn_value_items_classes_items_proactive_support">
    <h2 class="mb-0">
    <button aria-controls="Return_value_items_classes_items_proactive_support" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_items_classes_items_proactive_support" data-toggle="collapse" onclick="setAnchor('#Return_value_items_classes_items_proactive_support')" type="button"><span class="property-name">proactive_support</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_items_classes_items_proactive_support" class="collapse property-definition-div" data-parent="#accordionReturn_value_items_classes_items_proactive_support" id="Return_value_items_classes_items_proactive_support">
    <div class="card-body pl-5">
    <h4>Proactive Support</h4><span class="badge badge-dark value-type">Type: boolean</span><br/>
    <span class="description"><p>Whether this alert class is included in proactive support monitoring.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div><br><br>

*Required roles:* ALERT_LIST_READ