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

ListCredentials

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

Execution Availability

Try It Out

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

Query Parameters

Request Inputs

Query Parameters

  • typeString

    Filter results to only credentials of this type.

    Example: CREDENTIAL_TYPE_UNSPECIFIED

  • healthStatusString

    Filter results to only credentials with this health status.

    Example: CREDENTIAL_HEALTH_STATUS_UNSPECIFIED

  • limitInteger

    Maximum number of items to return in the response.

    Example: 0

  • offsetInteger

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

    Example: 0

  • componentUuidString

    UUID of the component whose credentials should be listed.

Responses

200 OK

On success, this API returns the following response structure.

  • itemsList

    List of credential metadata records matching the query.

    Example: (nested array)

    • uuidString

      Unique identifier of the credential.

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

    • nameString

      Human-readable name of the credential.

      Example: prod-db-password

    • descriptionString

      Free-text description of the credential's purpose.

      Example: Primary database password for production environment

    • typeString

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

      Example: CREDENTIAL_TYPE_UNSPECIFIED

    • healthStatusString

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

      Example: CREDENTIAL_HEALTH_STATUS_UNSPECIFIED

    • expiresAtString

      Timestamp when the credential will expire.

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

    • createdByString

      Account or principal that originally created the credential.

      Example: admin@example.com

    • createDateString

      Timestamp when the credential record was created.

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

    • lastOpDateString

      Timestamp of the most recent operation performed on this credential.

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

  • totalInteger

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

    Example: 42

  • limitInteger

    Maximum number of items returned per page.

    Example: 20

  • offsetInteger

    Number of items skipped before this page.

    Example: 20

Endpoint

GET/api/v1/credentials

/api/v1/credentials

Operation ID

ListCredentials

Permalink

Request Example

curl -X GET '{host}/api/v1/credentials' -H 'Authorization: Bearer {token}'

Response Example

200
{
  "items": [
    {}
  ],
  "total": 42,
  "limit": 20,
  "offset": 20
}

Change History

This API has no change history records yet.

View all change history