Clear Trust Rollout Status

Clear Trust Rollout Status
Reset Certificate Rotation Status After Workflow Completion

Clears and permanently resets the certificate rotation rollout status, returning the system to an idle state. This corresponds to the "Clear Status" action in the SSP Trust Management UI.

When to use: Call this endpoint after the rotation workflow has reached a terminal overall_status (COMPLETED_SUCCESSFULLY or COMPLETED_WITH_FAILURES) and you have acknowledged the result. This resets the system so a new rotation can be tracked cleanly in the future.

Preconditions:

  • The workflow must NOT be actively running. If overall_status is IN_ROTATION, this call returns 400. Verify the current state with GET /trust/trust-rollout-status before calling this endpoint.

Side Effects:

  • All rollout status data is permanently deleted. Subsequent GET /trust/trust-rollout-status calls will return an empty/reset status object.
  • This does NOT reverse or undo any certificate changes made during the rotation.
  • This action is irreversible - cleared status cannot be recovered.
Request
URI
DELETE
https://{api_host}/ssp/trust/trust-rollout-status
COPY
Authentication
This operation uses the following authentication methods.
Responses
200

OK - The rollout status has been successfully cleared. Subsequent GET requests will return an empty status.

Operation doesn't return any data structure

400

Bad Request - Cannot clear status while a certificate rotation workflow is actively running (overall_status is IN_ROTATION). Verify the current state via GET /trust/trust-rollout-status and retry once the rotation reaches a terminal state.

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.


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 -X DELETE -H 'Authorization: <value>' https://{api_host}/ssp/trust/trust-rollout-status
On This Page
Certificates Operations
GET
Get Trust Rollout Status
POST
Filter Trust Rollout Status
DELETE
Clear Trust Rollout Status