Skip to main content
API Explorer|API Explorer
Identity & Access/Credentials
POSTCredentialSince 1.0SynchronousAuth Required

TriggerHealthScan

Trigger an immediate health scan to refresh expiry status for all credentials.

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Request Inputs

This API requires no request parameters.

Responses

200 OK

On success, this API returns the following response structure.

  • messageString

    Human-readable message describing the health scan result.

    Example: Health scan triggered successfully

Endpoint

POST/api/v1/credentials/health-scan

/api/v1/credentials/health-scan

Operation ID

TriggerHealthScan

Permalink

Request Example

curl -X POST '{host}/api/v1/credentials/health-scan' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"key": "value"}'

Response Example

200
{
  "message": "Health scan triggered successfully"
}

Change History

This API has no change history records yet.

View all change history