Update Recommendation Session

Updates an existing recommendation session

Modifies an existing recommendation session's parameters or triggers lifecycle actions like re-run or cancel analysis.

Notes:

Use the action field to trigger specific operations: ANALYZE (re-runs analysis) or CANCEL (stops an in-progress analysis).
Side Effect: Triggering an ANALYZE action will clean up any existing recommendation results for this session.
Certain configuration updates may be rejected if an analysis is currently in progress.

Request

URI

PUT

https://{api_host}/intelligence/recommendations/{id}

COPY

Path Parameters

string

Required

The id of the resource

Request Body

The updated recommendation session configuration. Can include modifications to monitoring settings, context inputs, analysis parameters, or action triggers (ANALYZE/CANCEL). Only fields that are being updated need to be included.

RecommendationSession of type(s) application/json

Required

This request body class requires all of the following: ManagedResource , InlineRecommendationSession1

{
    "id": "c5ab3a5e-55d1-4f8e-b51a-0c065381dcd6",
    "_revision": 2,
    "display_name": "REC 260507 11:59:56",
    "description": "Recommendation created on 5/7/26, 11:59 AM",
    "site_ids": [
        "9e0865d0-9d89-44c7-8cc0-9f96a9b35721"
    ],
    "start_time": 1776549743681,
    "time_interval": {
        "end_time": 1779141743681,
        "start_time": 1776549743681
    },
    "monitoring_enabled": false,
    "action": "ANALYZE",
    "recommendation_type": "APPLICATION",
    "context_application": {
        "id": "301c802a-b183-40a6-9b26-bace5038ad80",
        "display_name": "R1_Z1_Env1_APP1",
        "site_ids": [
            "9e0865d0-9d89-44c7-8cc0-9f96a9b35721"
        ]
    },
    "segmentation_strategies": [],
    "connectivity_preference": "NONE",
    "connectivity_preference_logging_enabled": false,
    "exclude_multicast_flows": true,
    "exclude_broadcast_flows": true,
    "policy_type": "L4",
    "additional_rules": []
}

Authentication

This operation uses the following authentication methods.

enterprise_admin

security_engineer

Responses

202

The recommendation session update request has been accepted and is being processed asynchronously. This typically occurs when an action (such as ANALYZE or CANCEL) is triggered that requires background processing. The response includes an async operation identifier for tracking the update status.

Returns AsyncApiResponse of type(s) application/json

{
    "id": "55115cba-17bc-4cd1-b29f-b78bc1639446",
    "status_url": "https://<ssp_host>/intelligence/recommendations/55115cba-17bc-4cd1-b29f-b78bc1639446/status"
}

string

Optional

UUID identifier of the response.

string

status_url

Optional

The URL to check the status of the operation.

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 PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/intelligence/recommendations/{id}

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

202 Response Body

Errors

Recommendation Operations

POST

Create Recommendation Session