Skip to main content
ZStack
Identity & Access/Credentials

ListCredentials

List credentials with optional filtering by type, health status, and component.

GET/api/v1/credentials

Operation ID

ListCredentials

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

Query Parameters

  • type
    String

    Filter results to only credentials of this type.

    Example: CREDENTIAL_TYPE_UNSPECIFIED

  • healthStatus
    String

    Filter results to only credentials with this health status.

    Example: CREDENTIAL_HEALTH_STATUS_UNSPECIFIED

  • limit
    Integer

    Maximum number of items to return in the response.

    Example: 0

  • offset
    Integer

    Number of items to skip before starting to collect results (for pagination).

    Example: 0

  • componentUuid
    String

    UUID of the component whose credentials should be listed.

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • items
    List

    List of credential metadata records matching the query.

    Example: (nested array)

    • uuid
      String

      Unique identifier of the credential.

      Example: cred-a1b2c3d4-e5f6-7890-abcd-ef1234567890

    • name
      String

      Human-readable name of the credential.

      Example: prod-db-password

    • description
      String

      Free-text description of the credential's purpose.

      Example: Primary database password for production environment

    • type
      String

      Type of the credential (e.g. password, API key, TLS cert, SSH key).

      Example: CREDENTIAL_TYPE_UNSPECIFIED

    • healthStatus
      String

      Current health status indicating whether the credential is valid or expiring.

      Example: CREDENTIAL_HEALTH_STATUS_UNSPECIFIED

    • expiresAt
      String

      Timestamp when the credential will expire.

      Example: 2026-01-15T08:00:00Z

    • createdBy
      String

      Account or principal that originally created the credential.

      Example: admin@example.com

    • createDate
      String

      Timestamp when the credential record was created.

      Example: 2026-01-15T08:00:00Z

    • lastOpDate
      String

      Timestamp of the most recent operation performed on this credential.

      Example: 2026-01-15T08:00:00Z

  • total
    Integer

    Total number of credentials matching the filter (before pagination).

    Example: 42

  • limit
    Integer

    Maximum number of items returned per page.

    Example: 20

  • offset
    Integer

    Number of items skipped before this page.

    Example: 20