Get Trust Rollout Status

Get Current Certificate Rotation Status

Retrieves the current status of an active or recently completed certificate rotation workflow, including overall progress and per-vertical summary node counts.

When to use: Use this endpoint to get a high-level view of the certificate rotation. It returns the overall_status, progress_percent, and per-vertical summary counts (success/failed/pending nodes) for all participating platform components.

Notes:

This endpoint returns summary-level data only - node-level detail arrays (success_nodes, failed_nodes, pending_nodes) are empty. To retrieve node-level details for specific verticals or statuses, use POST /trust/trust-rollout-status with filter criteria.
When no rotation is active (or after calling DELETE), the response body will reflect an empty/reset state.
This endpoint is safe to poll during an active rotation. The progress_percent field is updated continuously and represents an approximate progress indicator.
The vertical_key values in the vertical_status array are the valid inputs for the vertical_names filter in POST /trust/trust-rollout-status.

Request

URI

GET

https://{api_host}/ssp/trust/trust-rollout-status

COPY

Authentication

This operation uses the following authentication methods.

Responses

200

OK - Returns the current certificate rotation status with per-vertical summaries.

Returns TrustRolloutStatus of type(s) application/json

{
    "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
}

string

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 object

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.

string

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.

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.

Code Samples

COPY

                    curl -H 'Authorization: <value>' https://{api_host}/ssp/trust/trust-rollout-status

On This Page

Description

Request

Authentication

Response

200 Response Body

Errors

Certificates Operations

GET

Get Trust Rollout Status

POST

Filter Trust Rollout Status

DELETE

Clear Trust Rollout Status