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
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.