Manage Ssp Feature Deployment

Manage Ssp Feature Deployment
Submit a deployment action for a platform feature

Queues an asynchronous deployment workflow for one platform feature, for example Security Intelligence.

Actions:

  • RUN_PRECHECK: Run pre-flight validation checks against the feature configuration
  • DEPLOY: Execute pre-flight validation checks and deploy the feature using the staged configuration
  • UNDEPLOY: Remove the deployed feature (fails if dependencies exist)
  • FORCE_UNDEPLOY: Forcefully remove the deployed feature and cascade delete dependencies

Chain: Asynchronous Polling: To monitor the progress of a feature operation, poll GET /lcm/features/{feature}/status. Ongoing operations return a 202 Accepted response formatted as an AsyncApiResponse. Clients should retain the response id for activity correlation and continue polling the provided status_url until the operation concludes.

Notes:

  • Do not treat a '202' Accepted status as a completed operation. It strictly indicates that the background task has been queued and requires subsequent polling.
  • Concurrency conflicts yield a '412' status. Resolve this by fetching the latest resource, merging your payload updates, and submitting a new request with the updated _revision token.

See Endpoint Guide for route comparison and workflow.

Request
URI
PUT
https://{api_host}/ssp/lcm/features/{feature}
COPY
Path Parameters
SspFeature
feature
Required  

Platform feature key to manage. Values are case-sensitive and listed in the SspFeature schema. For example INTELLIGENCE corresponds to Security Intelligence.

Request Body

Deployment command body: required _revision from GET, plus action. Named examples include sample payloads.

SspFeatureDeployment of type(s) application/json
Required  
This request body class requires all of the following: ManagedResource , InlineSspFeatureDeployment1 
{
    "_create_user": "string",
    "_create_time": 0,
    "_last_modified_user": "string",
    "_last_modified_time": 0,
    "_revision": 0,
    "_resource_type": "string",
    "_system_owned": false,
    "id": "string",
    "display_name": "string",
    "description": "string",
    "site_ids": [
        "string"
    ],
    "action": "string"
}
Authentication
This operation uses the following authentication methods.
Responses
202

The deployment action has been successfully queued for background processing. To monitor the live execution state, poll GET /lcm/features/{feature}/status. Clients should extract and retain any asynchronous identifiers provided in the response envelope to correlate with system activity logs.

Returns AsyncApiResponse of type(s) application/json 
{
    "id": "8f7e7db8-9c4a-4f2e-a501-7c4f8d6e2b11",
    "status_url": "/ssp/lcm/features/INTELLIGENCE/status"
}
string
id
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

An error occurred while processing the request. This could be due to authentication issues, authorization failures, invalid requests, precondition failures (such as revision mismatch), or internal server errors.

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 '{"action":"string","_revision":"{}"}' https://{api_host}/ssp/lcm/features/{feature}
On This Page
Platform Features Operations
PUT
Manage Ssp Feature Deployment
GET
Get Ssp Feature Deployment
GET
Get Ssp Feature Deployment Status