TrustRolloutStatus

TrustRolloutStatus
Certificate Rotation Status

Represents the current state of a certificate rotation workflow across all platform components (verticals). This is the top-level response object for all /trust/trust-rollout-status operations.

Check overall_status first to determine the workflow phase. Use progress_percent for a coarse progress indicator during active rotations. Inspect vertical_status for a per-participant breakdown. Node-level arrays within each entry (success_nodes, failed_nodes, pending_nodes) are only populated when using the filtered POST endpoint with explicit filter criteria.

JSON Example 
{
    "rollout_type": "string",
    "informational_messages": [
        "string"
    ],
    "progress_percent": 0,
    "vertical_status": [
        {
            "vertical_key": "string",
            "rollout_result": "string",
            "status_summary": {
                "success_node_count": 0,
                "failed_node_count": 0,
                "pending_node_count": 0
            },
            "success_nodes": [
                {
                    "node_display_name": "string",
                    "node_id": "string",
                    "error_message": "string",
                    "update_status": "string"
                }
            ],
            "failed_nodes": [
                {
                    "node_display_name": "string",
                    "node_id": "string",
                    "error_message": "string",
                    "update_status": "string"
                }
            ],
            "pending_nodes": [
                {
                    "node_display_name": "string",
                    "node_id": "string",
                    "error_message": "string",
                    "update_status": "string"
                }
            ]
        }
    ],
    "overall_status": "string",
    "start_time": 0
}
TrustRolloutTaskType
rollout_type
Optional

Identifies which certificate is being rotated in this workflow run.

  • PLATFORM_CA - The platform root CA certificate is being renewed and all certificates signed by that CA are being re-issued and distributed across all verticals. Triggered automatically by the platform when the root CA is near expiration, or initiated via the Trust Management UI. This is the most common rotation type.
  • INGRESS - The external-facing ingress (TLS) certificate is being rotated. Initiated via the Trust Management UI only, when a new CA-signed ingress certificate is applied. Affects inbound connections to the SSP platform from external clients.

The active rollout_type is returned in TrustRolloutStatus.rollout_type.

Enumeration: INGRESS, PLATFORM_CA
array of string
informational_messages
Optional

Human-readable log of key events during the rotation workflow, ordered chronologically. Useful for understanding the sequence of steps taken and diagnosing issues. These messages are also visible in the SSP Trust Management UI.

integer
progress_percent
Optional

Approximate percentage of the rotation workflow that has completed, ranging from 0 to 100. Updated continuously during an active rotation. This value is an estimate based on both rotation steps and participant node completion counts and may not increase linearly.

array of VerticalTrustRolloutStatus
vertical_status
Optional

Per-vertical breakdown of certificate rotation status. Each entry corresponds to one platform component (vertical) participating in the rotation. The vertical_key in each entry is a valid input for vertical_names in the POST /trust/trust-rollout-status filter request.

TrustRolloutOverallStatus
overall_status
Optional

The aggregate status of the entire certificate rotation workflow across all participating verticals.

  • SCHEDULED - Rotation is queued but has not started yet.
  • IN_ROTATION - Rotation is actively in progress; do not call DELETE /trust/trust-rollout-status while in this state.
  • COMPLETED_SUCCESSFULLY - All verticals and all nodes successfully rotated their certificates. Safe to call DELETE to reset.
  • COMPLETED_WITH_FAILURES - The rotation finished but one or more nodes failed. Use POST /trust/trust-rollout-status with include_status: ["FAILED"] to retrieve failure details before calling DELETE to reset.
Enumeration: IN_ROTATION, COMPLETED_SUCCESSFULLY, COMPLETED_WITH_FAILURES, SCHEDULED
integer As int64 As int64
start_time
Optional

Unix epoch timestamp in milliseconds when the certificate rotation workflow began execution. Use this to correlate rotation events with platform logs.

Returned By