Skip to main content
ZStack
Identity & Access/Credentials

GetCredentialStatistics

Retrieve aggregated statistics about credential counts grouped by health status.

GET/api/v1/credentials/statistics

Operation ID

GetCredentialStatistics

Since

1.0.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

This API requires no request parameters.

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • total
    String

    Total number of credentials across all health statuses.

    Example: 50

  • ok
    String

    Number of credentials in healthy (OK) status.

    Example: 40

  • expiring
    String

    Number of credentials that are expiring soon or approaching warning/critical thresholds.

    Example: 5

  • expired
    String

    Number of credentials that have already expired.

    Example: 3

  • unknown
    String

    Number of credentials whose health status could not be determined.

    Example: 2