Sign in
CredentialService

Update credential by credential id

Changed on
patch/api/v2/credentials/{credentialId}

Request

  • The document declares no server URL.
  • Auth: none declared

Path parameters

credentialIdstring required

the credential id of the credential

Request body

userNamestring required
credentialType'CREDENTIAL_TYPE_UNSPECIFIED' | 'HOST' | 'TIDB' required
  • CREDENTIAL_TYPE_UNSPECIFIED: resource type unspecified
  • HOST: credential type host
  • TIDB: credential type tidb
validateType'CREDENTIAL_VALIDATE_TYPE_UNSPECIFIED' | 'PASSWORD' | 'RSAKEY' required
  • CREDENTIAL_VALIDATE_TYPE_UNSPECIFIED: validate type unspecified
  • PASSWORD: validate by password
  • RSAKEY: validate by rsa key
credentialNamestring
descriptionstring
forceUpdateboolean

Response

A successful response.

credentialIdstring
userNamestring required
credentialType'CREDENTIAL_TYPE_UNSPECIFIED' | 'HOST' | 'TIDB' required
  • CREDENTIAL_TYPE_UNSPECIFIED: resource type unspecified
  • HOST: credential type host
  • TIDB: credential type tidb
validateType'CREDENTIAL_VALIDATE_TYPE_UNSPECIFIED' | 'PASSWORD' | 'RSAKEY' required
  • CREDENTIAL_VALIDATE_TYPE_UNSPECIFIED: validate type unspecified
  • PASSWORD: validate by password
  • RSAKEY: validate by rsa key
credentialNamestring
descriptionstring

Changes