Skip to main content
ZStack
Identity & Access/Credentials

UpdateCredential

Update an existing credential's metadata or rotate its stored value.

PUT/api/v1/credentials/{uuid}

Operation ID

UpdateCredential

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

application/json

Path Parameters

  • uuid
    StringRequired

    Unique identifier of the credential to update.

Body Fields

  • name
    StringRequired

    New human-readable name for the credential (optional).

    Example: my-resource

  • description
    StringRequired

    New description of the credential's purpose (optional).

    Example: A brief description

  • value
    StringRequired

    Updated sensitive credential value.

    Example: new-s3cr3t-v@lue

  • expiresAt
    StringRequired

    Updated expiry timestamp for the credential.

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

  • operator
    StringRequired

    Account or principal performing the update.

    Example: ops@example.com

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • 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