List Recommendation Sessions

List Recommendation Sessions
Search and filter recommendation sessions

Queries the system for recommendation sessions matching specific filter criteria.

Notes:

  • Uses POST instead of GET to accommodate complex, nested filter payloads.
  • Multiple top-level filter parameters are combined using AND logic.
  • Supports filtering by context inputs (VMs, groups, applications, environments), status, type, and time.
  • Returns paginated results.
Request
URI
POST
https://{api_host}/intelligence/recommendations/search
COPY
Request Body

Filter criteria for listing recommendation sessions. Includes context input filters, status filters, recommendation type, creation time filters, and pagination parameters. All filter parameters are combined with AND logic.

RecommendationSessionListRequestParameters of type(s) application/json
Required  
This request body class requires all of the following: ListRequestParameters , InlineRecommendationSessionListRequestParameters1 
{
    "sort_by": "start_time",
    "sort_ascending": false,
    "offset": 0,
    "page_size": 1000,
    "created_user": "admin",
    "recommendation_statuses": [
        "ANALYSIS_IN_PROGRESS",
        "READY_TO_PUBLISH",
        "NOTHING_TO_PUBLISH"
    ],
    "group_type": "OBJECT_BASED",
    "rerun_recommended": false,
    "site_ids": [
        "9e0865d0-9d89-44c7-8cc0-9f96a9b35721"
    ],
    "context_inputs": [
        {
            "condition": "OR",
            "context_filters": [
                {
                    "context_filter_type": "APPLICATION",
                    "id": "4bf410bc-1794-4b76-8ae3-3db5fcef796f"
                },
                {
                    "context_filter_type": "ENVIRONMENT_PAIR",
                    "pair": {
                        "source": {
                            "id": "700889c1-d844-4ea7-8bff-6ae531786e76"
                        },
                        "destination": {
                            "id": "537d72a7-b669-4b70-98cc-e39c047abbc8"
                        }
                    }
                }
            ]
        }
    ]
}
Authentication
This operation uses the following authentication methods.
Responses
200

List of recommendations with optional filter parameters specified.

Returns RecommendationSessionListResult of type(s) application/json
This response body class contains all of the following: ListResult , InlineRecommendationSessionListResult1 
{
    "offset": 0,
    "number_of_results": 2,
    "total_result_count": 2,
    "total_pages": 1,
    "sort_ascending": false,
    "sort_by": "start_time",
    "recommendations": [
        {
            "id": "46f6e34e-b835-4ed2-baa3-23edaa885cf2",
            "display_name": "REC 260512 03:28:58",
            "description": "Recommendation created on 5/12/26, 3:28 PM",
            "recommendation_type": "APPLICATION",
            "action": "ANALYZE",
            "start_time": 1778020197491,
            "time_interval": {
                "start_time": 1778020197491,
                "end_time": 1778625155797
            },
            "monitoring_enabled": true,
            "site_ids": [
                "9e0865d0-9d89-44c7-8cc0-9f96a9b35721"
            ],
            "context_application": {
                "id": "4bf410bc-1794-4b76-8ae3-3db5fcef796f",
                "display_name": "Group_R1_Z1_Env1_New_APP1",
                "site_ids": []
            },
            "context_security_policies": [],
            "policy_type": "L4",
            "segmentation_strategies": [
                {
                    "strategy": "ALLOW_INTRA",
                    "logging": false
                }
            ],
            "connectivity_preference": "NONE",
            "connectivity_preference_logging_enabled": false,
            "exclude_multicast_flows": true,
            "exclude_broadcast_flows": true,
            "additional_rules": [],
            "use_private_ip_range_group": false,
            "separate_rules_by_services": false,
            "_create_user": "admin",
            "_create_time": 1778624956242,
            "_last_modified_user": "admin",
            "_last_modified_time": 1778625001739,
            "_revision": 1,
            "_system_owned": false,
            "status": {
                "recommendation_overall_status": "READY_TO_PUBLISH",
                "recommendation_analysis_states": [
                    {
                        "site_id": "9e0865d0-9d89-44c7-8cc0-9f96a9b35721",
                        "status_message": "",
                        "status": "SUCCESS"
                    }
                ],
                "recommendation_result_states": [
                    {
                        "id": "9e0865d0-9d89-44c7-8cc0-9f96a9b35721",
                        "site_id": "9e0865d0-9d89-44c7-8cc0-9f96a9b35721",
                        "status": "READY_TO_PUBLISH"
                    }
                ],
                "rerun_recommended": false,
                "alerts": [],
                "groups_with_alert": []
            }
        },
        {
            "id": "d81c4105-3da3-4cb5-8a08-51f082c175ae",
            "display_name": "REC 260518 03:46:50",
            "description": "Recommendation created on 5/18/26, 3:46 PM",
            "recommendation_type": "APPLICATION",
            "action": "ANALYZE",
            "start_time": 1776552799335,
            "time_interval": {
                "start_time": 1776552799335,
                "end_time": 1779144952584
            },
            "monitoring_enabled": true,
            "site_ids": [
                "9e0865d0-9d89-44c7-8cc0-9f96a9b35721"
            ],
            "context_application": {
                "id": "4bf410bc-1794-4b76-8ae3-3db5fcef796f",
                "display_name": "Group_R1_Z1_Env1_New_APP1",
                "site_ids": []
            },
            "context_security_policies": [],
            "policy_type": "L4",
            "segmentation_strategies": [],
            "connectivity_preference": "NONE",
            "connectivity_preference_logging_enabled": false,
            "exclude_multicast_flows": true,
            "exclude_broadcast_flows": true,
            "additional_rules": [],
            "use_private_ip_range_group": false,
            "separate_rules_by_services": false,
            "_create_user": "admin",
            "_create_time": 1779144426565,
            "_last_modified_user": "admin",
            "_last_modified_time": 1779144803694,
            "_revision": 1,
            "_system_owned": false,
            "status": {
                "recommendation_overall_status": "READY_TO_PUBLISH",
                "recommendation_analysis_states": [
                    {
                        "site_id": "9e0865d0-9d89-44c7-8cc0-9f96a9b35721",
                        "status_message": "",
                        "status": "SUCCESS"
                    }
                ],
                "recommendation_result_states": [
                    {
                        "id": "9e0865d0-9d89-44c7-8cc0-9f96a9b35721",
                        "site_id": "9e0865d0-9d89-44c7-8cc0-9f96a9b35721",
                        "status": "READY_TO_PUBLISH"
                    }
                ],
                "rerun_recommended": false,
                "alerts": [],
                "groups_with_alert": []
            }
        }
    ]
}

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

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 -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/intelligence/recommendations/search
On This Page
Recommendation Operations
POST
Create Recommendation Session
GET
Get Recommendation Session
PUT
Update Recommendation Session
DELETE
Delete Recommendation Session
GET
Get Recommendation Session Status
GET
Get Recommendation Monitoring Result
POST
List Recommendation Sessions
GET
Get Recommendation Result
PUT
Update Recommendation Result
GET
Get Recommendation Result Status
GET
Export Recommendation To Csv