Get Ssp Feature Deployment Status

Get Ssp Feature Deployment Status
Read live deployment and pre-check status for a platform feature

Retrieves the comprehensive execution status of a platform feature. This includes the overall deployment phase, pre-check aggregate, deployment results, and progress percentage.

Chain: After PUT /lcm/features/{feature}, poll this endpoint until overall_status reaches a terminal success or failure state.

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

Platform feature key (case-sensitive). See SspFeature; for example NDR for Network Detection & Response.

Responses
200

Returns the comprehensive execution status of the feature. This includes the overall deployment phase, pre-check aggregate, deployment results, and progress percentage.

Returns SspFeatureDeploymentStatus of type(s) application/json 
{
    "action": "DEPLOY",
    "deployment_results": {
        "_revision": 1,
        "deployment_details": [
            {
                "action": "DEPLOY_Global_POST",
                "status": "DEPLOYMENT_SUCCESSFUL"
            },
            {
                "action": "DEPLOY_napp-upgrade",
                "status": "DEPLOYMENT_SUCCESSFUL"
            },
            {
                "action": "DEPLOY_upgrade-coordinator_napp-upgrade_POST_CHART",
                "status": "DEPLOYMENT_SUCCESSFUL"
            },
            {
                "action": "DEPLOY_upgrade-coordinator_napp-upgrade_PRE_CHART",
                "status": "DEPLOYMENT_SUCCESSFUL"
            },
            {
                "action": "DEPLOY_Global_PRE",
                "status": "DEPLOYMENT_SUCCESSFUL"
            }
        ],
        "deployment_progress": {
            "error_details": null,
            "message": "Install of upgrade-coordinator completed successfully",
            "percentage": 100
        },
        "deployment_status": "DEPLOYMENT_SUCCESSFUL",
        "reason": "Started deploying feature upgrade-coordinator"
    },
    "feature": "UPGRADE_COORDINATOR",
    "overall_progress": 100,
    "overall_status": "DEPLOYMENT_SUCCESSFUL",
    "precheck_results": {
        "_revision": 0,
        "failed_checks": 0,
        "overall_status": "NOT_STARTED",
        "passed_checks": 0,
        "prechecks": [],
        "progress": 0,
        "system_status": "READY",
        "total_checks": 0
    }
}
string
feature
Required  

vDefend feature name enum. Feature METRICS is pre-installed with Security Services Platform and cannot be installed or uninstalled separately.

Enumeration: MALWARE_PREVENTION, INTELLIGENCE, NDR, BAREMETAL_SECURITY, RULE_ANALYSIS, AI_ASSISTANT_PLATFORM, AI_ASSISTANT_THREAT_DEFENSE, MALWARE_ANALYSIS_VC, SPAC, NETWORK_TRAFFIC_ANALYSIS, UPGRADE_COORDINATOR, CLOUD_CONNECTOR, METRICS
precheck_results
Required  

Summary of the overall status, per-check results, progress percentage, and initialization state for pre-checks.

deployment_results
Required  

Results of the deployment action.

string
action
Required  

Chooses which lifecycle operation to queue for the feature.

  • 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.
Enumeration: RUN_PRECHECK, DEPLOY, UNDEPLOY, FORCE_UNDEPLOY
string
overall_status
Required  

High-level lifecycle state for the feature.

  • QUEUED: Accepted but not yet executing.
  • PRECHECKS_IN_PROGRESS: Prechecks running.
  • DEPLOYMENT_IN_PROGRESS: Deployment or activation work running.
  • DEPLOYMENT_SUCCESSFUL: Feature active.
  • PRECHECKS_FAILED: Validation blocked deployment; fix findings before redeploying.
  • PRECHECKS_SUCCESSFUL: Checks passed but deployment not started or not yet requested.
  • DEPLOYMENT_FAILED: Deploy failed; inspect logs and deployment_results.
  • UNDEPLOYMENT_IN_PROGRESS: Removal running.
  • UNDEPLOYMENT_FAILED: Removal failed; may require force path or manual cleanup.
  • NOT_DEPLOYED: Feature not deployed.
  • UNKNOWN: Transitional or indeterminate. Retry status later.
  • DEPLOYMENT_PARTIAL_SUCCESS: Partial deploy; some subcomponents unhealthy.

Terminal states differ by operation: a successful remove ends in NOT_DEPLOYED after undeployment completes.

Enumeration: QUEUED, PRECHECKS_IN_PROGRESS, DEPLOYMENT_IN_PROGRESS, DEPLOYMENT_SUCCESSFUL, PRECHECKS_FAILED, PRECHECKS_SUCCESSFUL, DEPLOYMENT_FAILED, UNDEPLOYMENT_IN_PROGRESS, UNDEPLOYMENT_FAILED, NOT_DEPLOYED, UNKNOWN, DEPLOYMENT_PARTIAL_SUCCESS
integer
overall_progress
Optional
Constraints: minimum: 0 maximum: 100

Progress of the feature deployment as a percentage (0-100)


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 retrieving deployment status. This could be due to authentication issues, authorization failures, invalid requests, 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 -H 'Authorization: <value>' https://{api_host}/ssp/lcm/features/{feature}/status
On This Page
Platform Features Operations
PUT
Manage Ssp Feature Deployment
GET
Get Ssp Feature Deployment
GET
Get Ssp Feature Deployment Status