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

UpdateCredential

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

Execution Availability

Try It Out

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

Path Parameters

Request Inputs

Path Parameters

  • uuidStringRequired

    Unique identifier of the credential to update.

Body Fields

  • nameStringRequired

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

    Example: my-resource

  • descriptionStringRequired

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

    Example: A brief description

  • valueStringRequired

    Updated sensitive credential value.

    Example: new-s3cr3t-v@lue

  • expiresAtStringRequired

    Updated expiry timestamp for the credential.

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

  • operatorStringRequired

    Account or principal performing the update.

    Example: ops@example.com

Responses

200 OK

On success, this API returns the following response structure.

  • 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

Endpoint

PUT/api/v1/credentials/{uuid}

/api/v1/credentials/{uuid}

Operation ID

UpdateCredential

Permalink

Request Example

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

Response Example

200
{
  "uuid": "cred-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "name": "prod-db-password",
  "description": "Primary database password for production environment",
  "type": {},
  "healthStatus": {},
  "expiresAt": "example",
  "createdBy": "admin@example.com",
  "createDate": "example"
}

Change History

This API has no change history records yet.

View all change history