List Infra Service Categories

List Infra Service Categories
Browse all infrastructure service categories (e.g., DNS, AD, LDAP)

Returns a paginated list of all infrastructure service categories defined in the system. Each category groups one or more related port/protocol services (e.g., the DNS category contains UDP/53 and TCP/53 services).

How to use this endpoint:

  • The id of each returned category is the service-category-id required by every other endpoint under /monitoring/infra/service-categories/{service-category-id}.
  • Use this endpoint to discover valid service-category-id values before calling /summary, /details, /discovered-servers, or /publish-config.
  • For a richer view that includes monitoring stats (new servers, rules status), use POST /intelligence/monitoring/infra/service-categories/summary instead.
Request
URI
GET
https://{api_host}/intelligence/monitoring/infra/service-categories
COPY
Query Parameters
integer
offset
Optional
Constraints: minimum: 0 default: 0

Offset pagination parameter used to exclude from a response the first N items of a resource collection. Combine the offset and the page_size options to request a particular set or page of items.

integer
page_size
Optional
Constraints: minimum: 0 default: 1000

Number of records to be returned in the API request from the provided offset

boolean,null
sort_ascending
Optional
Constraints: default: false

True, if the list of records returned need to be sorted in ascending order, false otherwise.

string
sort_by
Optional

The parameter name on which to sort the list of records. Only top-level parameters in the returned list of records will be supported. If not provided, system will define the parameter by which results are sorted.

string
site_id
Optional

Scope results to a specific site. When omitted, categories from all sites are returned. Obtain valid site IDs from your environment configuration or the site_ids field on your infrastructure objects.

Authentication
This operation uses the following authentication methods.
Responses
200

List of infrastructure service categories returned successfully

Returns InfraServiceCategoryList of type(s) application/json
This response body class contains all of the following: ListResult , InlineInfraServiceCategoryList1 
{
    "offset": 0,
    "number_of_results": 13,
    "total_result_count": 13,
    "total_pages": 1,
    "sort_ascending": false,
    "sort_by": "displayName",
    "results": [
        {
            "display_name": "SYSLOG-UDP",
            "_revision": 0,
            "id": "9b9d0c0e-5a65-41bb-b003-e7af60f417d1",
            "site_ids": [],
            "infra_groups": [],
            "last_publish_job_status": {
                "job_id": "d070ba6b-12c7-4317-8e21-8c33cea47568",
                "status": "COMPLETED",
                "service_id": "",
                "service_category_id": "9b9d0c0e-5a65-41bb-b003-e7af60f417d1",
                "created_time": 1782776681049,
                "updated_time": 1782776689300,
                "completed_time": 1782776689300,
                "results": [
                    {
                        "action_type": "HIERARCHY_IDS_RULE_CREATE",
                        "action_status": "SUCCESS",
                        "action_index": 0,
                        "status_message": "IDS rule publish completed successfully"
                    }
                ]
            },
            "aggregated_port_protocols": [],
            "is_monitoring_enabled": true,
            "is_custom": false
        },
        {
            "display_name": "SYSLOG",
            "_revision": 0,
            "id": "71999e87-adc1-4c12-b92d-7450a03f640b",
            "site_ids": [],
            "infra_groups": [],
            "last_publish_job_status": {
                "job_id": "ea70a34a-2f9e-492d-af1f-2c4214ce20c9",
                "status": "COMPLETED",
                "service_id": "",
                "service_category_id": "71999e87-adc1-4c12-b92d-7450a03f640b",
                "created_time": 1782776681531,
                "updated_time": 1782776689820,
                "completed_time": 1782776689820,
                "results": [
                    {
                        "action_type": "HIERARCHY_IDS_RULE_CREATE",
                        "action_status": "SUCCESS",
                        "action_index": 0,
                        "status_message": "IDS rule publish completed successfully"
                    }
                ]
            },
            "aggregated_port_protocols": [],
            "is_monitoring_enabled": true,
            "is_custom": false
        },
        {
            "display_name": "SNMP",
            "_revision": 0,
            "id": "e0eafb95-994d-4f9b-acc5-1169e77d3872",
            "site_ids": [],
            "infra_groups": [],
            "last_publish_job_status": {
                "job_id": "7d9d2f6c-cfb6-4de3-9ccc-fdf391ed124d",
                "status": "COMPLETED",
                "service_id": "",
                "service_category_id": "e0eafb95-994d-4f9b-acc5-1169e77d3872",
                "created_time": 1782776681946,
                "updated_time": 1782776690319,
                "completed_time": 1782776690319,
                "results": [
                    {
                        "action_type": "HIERARCHY_IDS_RULE_CREATE",
                        "action_status": "SUCCESS",
                        "action_index": 0,
                        "status_message": "IDS rule publish completed successfully"
                    }
                ]
            },
            "aggregated_port_protocols": [],
            "is_monitoring_enabled": true,
            "is_custom": false
        },
        {
            "display_name": "NTP",
            "_revision": 0,
            "id": "65ccc40f-3759-45f6-99ec-d916650f909b",
            "site_ids": [],
            "infra_groups": [],
            "last_publish_job_status": {
                "job_id": "f0118805-0511-42e8-afe8-406c40f8b31d",
                "status": "COMPLETED",
                "service_id": "",
                "service_category_id": "65ccc40f-3759-45f6-99ec-d916650f909b",
                "created_time": 1782776682330,
                "updated_time": 1782776690909,
                "completed_time": 1782776690909,
                "results": [
                    {
                        "action_type": "HIERARCHY_IDS_RULE_CREATE",
                        "action_status": "SUCCESS",
                        "action_index": 0,
                        "status_message": "IDS rule publish completed successfully"
                    }
                ]
            },
            "aggregated_port_protocols": [],
            "is_monitoring_enabled": true,
            "is_custom": false
        },
        {
            "display_name": "LDAPS",
            "_revision": 0,
            "id": "82c6e09c-6e7a-4d44-b238-a505734a944f",
            "site_ids": [],
            "infra_groups": [],
            "last_publish_job_status": {
                "job_id": "3d49df13-7b14-488d-8f6f-25502287204c",
                "status": "COMPLETED",
                "service_id": "",
                "service_category_id": "82c6e09c-6e7a-4d44-b238-a505734a944f",
                "created_time": 1782776682739,
                "updated_time": 1782776691373,
                "completed_time": 1782776691373,
                "results": [
                    {
                        "action_type": "HIERARCHY_IDS_RULE_CREATE",
                        "action_status": "SUCCESS",
                        "action_index": 0,
                        "status_message": "IDS rule publish completed successfully"
                    }
                ]
            },
            "aggregated_port_protocols": [],
            "is_monitoring_enabled": true,
            "is_custom": false
        },
        {
            "display_name": "LDAP-UDP",
            "_revision": 0,
            "id": "128da6dc-fb11-4a93-b223-2958092d38c5",
            "site_ids": [],
            "infra_groups": [],
            "last_publish_job_status": {
                "job_id": "cccb1634-24e1-4cfa-ae20-7cdc113c7ffa",
                "status": "COMPLETED",
                "service_id": "",
                "service_category_id": "128da6dc-fb11-4a93-b223-2958092d38c5",
                "created_time": 1782776683134,
                "updated_time": 1782776691820,
                "completed_time": 1782776691820,
                "results": [
                    {
                        "action_type": "HIERARCHY_IDS_RULE_CREATE",
                        "action_status": "SUCCESS",
                        "action_index": 0,
                        "status_message": "IDS rule publish completed successfully"
                    }
                ]
            },
            "aggregated_port_protocols": [],
            "is_monitoring_enabled": true,
            "is_custom": false
        },
        {
            "display_name": "LDAP",
            "_revision": 0,
            "id": "4cf1a77c-f7bd-48e6-b7c2-b87cfb4a4c8a",
            "site_ids": [],
            "infra_groups": [],
            "last_publish_job_status": {
                "job_id": "0845b781-50bb-48bc-89c9-a681c4875c02",
                "status": "COMPLETED",
                "service_id": "",
                "service_category_id": "4cf1a77c-f7bd-48e6-b7c2-b87cfb4a4c8a",
                "created_time": 1782776683509,
                "updated_time": 1782776692197,
                "completed_time": 1782776692197,
                "results": [
                    {
                        "action_type": "HIERARCHY_IDS_RULE_CREATE",
                        "action_status": "SUCCESS",
                        "action_index": 0,
                        "status_message": "IDS rule publish completed successfully"
                    }
                ]
            },
            "aggregated_port_protocols": [],
            "is_monitoring_enabled": true,
            "is_custom": false
        },
        {
            "display_name": "ICMP",
            "_revision": 0,
            "id": "f8f326aa-51c1-4466-b3a7-2dfd34ce506c",
            "site_ids": [],
            "infra_groups": [],
            "aggregated_port_protocols": [],
            "is_monitoring_enabled": false,
            "is_custom": false
        },
        {
            "display_name": "DNS-UDP",
            "_revision": 0,
            "id": "c2369f79-c190-4f47-a0d4-a980042895c9",
            "site_ids": [],
            "infra_groups": [],
            "last_publish_job_status": {
                "job_id": "6c1cd937-7b56-48e6-9d1c-33f202e04782",
                "status": "COMPLETED",
                "service_id": "",
                "service_category_id": "c2369f79-c190-4f47-a0d4-a980042895c9",
                "created_time": 1782776683892,
                "updated_time": 1782776692561,
                "completed_time": 1782776692561,
                "results": [
                    {
                        "action_type": "HIERARCHY_IDS_RULE_CREATE",
                        "action_status": "SUCCESS",
                        "action_index": 0,
                        "status_message": "IDS rule publish completed successfully"
                    }
                ]
            },
            "aggregated_port_protocols": [],
            "is_monitoring_enabled": true,
            "is_custom": false
        },
        {
            "display_name": "DNS",
            "_revision": 0,
            "id": "21a775ee-1f76-4491-96f2-fcf07fe73da9",
            "site_ids": [],
            "infra_groups": [],
            "last_publish_job_status": {
                "job_id": "443d50af-785c-4971-b2fc-e87e7baccfe0",
                "status": "COMPLETED",
                "service_id": "",
                "service_category_id": "21a775ee-1f76-4491-96f2-fcf07fe73da9",
                "created_time": 1782776684264,
                "updated_time": 1782776692946,
                "completed_time": 1782776692946,
                "results": [
                    {
                        "action_type": "HIERARCHY_IDS_RULE_CREATE",
                        "action_status": "SUCCESS",
                        "action_index": 0,
                        "status_message": "IDS rule publish completed successfully"
                    }
                ]
            },
            "aggregated_port_protocols": [],
            "is_monitoring_enabled": true,
            "is_custom": false
        },
        {
            "display_name": "DHCPv6",
            "_revision": 0,
            "id": "3de4fbe1-3e3c-4683-803b-d3cb245adc3d",
            "site_ids": [],
            "infra_groups": [],
            "last_publish_job_status": {
                "job_id": "dc084886-015e-44ac-b7b1-f2e8532804a7",
                "status": "COMPLETED",
                "service_id": "",
                "service_category_id": "3de4fbe1-3e3c-4683-803b-d3cb245adc3d",
                "created_time": 1782776684655,
                "updated_time": 1782776693409,
                "completed_time": 1782776693409,
                "results": [
                    {
                        "action_type": "HIERARCHY_IDS_RULE_CREATE",
                        "action_status": "SUCCESS",
                        "action_index": 0,
                        "status_message": "IDS rule publish completed successfully"
                    }
                ]
            },
            "aggregated_port_protocols": [],
            "is_monitoring_enabled": true,
            "is_custom": false
        },
        {
            "display_name": "DHCP",
            "_revision": 0,
            "id": "cffcf105-9d86-4d9a-887b-8327c7e1a09f",
            "site_ids": [],
            "infra_groups": [],
            "last_publish_job_status": {
                "job_id": "4825e96e-3435-4a4e-aff6-2164ffd53cb6",
                "status": "COMPLETED",
                "service_id": "",
                "service_category_id": "cffcf105-9d86-4d9a-887b-8327c7e1a09f",
                "created_time": 1782776685052,
                "updated_time": 1782776693825,
                "completed_time": 1782776693825,
                "results": [
                    {
                        "action_type": "HIERARCHY_IDS_RULE_CREATE",
                        "action_status": "SUCCESS",
                        "action_index": 0,
                        "status_message": "IDS rule publish completed successfully"
                    }
                ]
            },
            "aggregated_port_protocols": [],
            "is_monitoring_enabled": true,
            "is_custom": false
        },
        {
            "display_name": "AD",
            "_revision": 0,
            "id": "afdec911-d4ec-4deb-8a9c-fda4ceabf2c7",
            "site_ids": [],
            "nsx_service_paths": [
                "/infra/services/SSP_Active_Directory_Service"
            ],
            "infra_groups": [],
            "aggregated_port_protocols": [],
            "is_monitoring_enabled": true,
            "is_custom": false
        }
    ]
}

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.


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

Unexpected 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}/intelligence/monitoring/infra/service-categories
On This Page
Infrastructure Monitoring Operations
GET
List Infra Service Categories
POST
Get Infra Service Categories Summary
GET
Get Infra Service Category
GET
List Infra Services
GET
Get Infra Service
POST
Get Discovered Servers For Infra Service Category
GET
Get Server Exclusions For Infra Service Category
POST
Exclude Servers For Infra Service Category
POST
Remove Excluded Servers For Infra Service Category
POST
Get Infra Service Category Details
POST
Get Ids Proposed Rules For Service Category
POST
Get Proposed Infrastructure Rules For Service Category
POST
Publish Infra Service Category
GET
Get Infra Service Category Publish Job Status
POST
Get Infra Assets Security Info Batch