Platform Features APIs

Platform Features APIs

APIs for lifecycle management of SSP features. Use these APIs to activate, deactivate and handle necessary configuration changes for each feature.

API Categories
Cloud Connector Config

Update Cloud Connector Configuration Update configuration for Cloud Connector deployment.

The Cloud Connector configuration must be provided before deploying the Cloud Connector feature. Cloud Connector can be deployed directly via its deployment API, or it is deployed automatically when required as part of the deployment of dependent features (e.g., NDR or Malware Prevention) that are configured to require cloud connectivity.

Once the Cloud Connector feature has been deployed, configuration changes require the feature to be removed and re-deployed with the new settings.

Feature Lifecycle

APIs for security services platform feature lifecycle management, including pre-checks, deployment, removal, and status read.

Endpoint Guide:

  • PUT /lcm/features/{feature}
    • Queue a deployment action (RUN_PRECHECK, DEPLOY, UNDEPLOY, FORCE_UNDEPLOY).
    • Returns 202 when the action is accepted for async processing.
  • GET /lcm/features/{feature}
    • Read the staged deployment resource (action, _revision) used for optimistic concurrency before PUT.
  • GET /lcm/features/{feature}/status
    • Read live deployment phase, Prechecks aggregate, per-action history, and progress for polling after PUT.

Workflow:

  • GET /lcm/features/{feature} to read _revision
  • PUT /lcm/features/{feature} with action and _revision
  • Poll GET /lcm/features/{feature}/status until overall_status is terminal
    • Retain AsyncApiResponse identifiers from PUT when returned for correlation.

Intelligence Config

Security Intelligence APIs.

Malware Analysis Vc Config

Malware Analysis VC APIs.

Malware Prevention Config

Malware Prevention Configuration APIs.

Ndr Config

NDR (Network Detection and Response) APIs.