The Modifying a Credential call modifies its attributes through parameters to the API.

API Call


http://host/dmadminweb/API/mod/Environment/cred_id

[?param=value]

[&param=value]+


Where:

Host

Is the hostname and port of the DeployHub Server (e.g.: hostname:8080 or for SaaS console.deployhub.com)

cred_id

Is the ID of the credential to be modified. Either its name, its qualified name (i.e.: with its parent Domain(s) included in dot notation) or its internal ID.

Param=value

Is an credential attribute (listed below)

       

domain

Is the identifier of the domain to which the credential is to be moved. Either its name, its qualified name (i.e.: with its parent domain(s) included in dot notation) or its internal ID.

summary

Is the credential's summary text.

username

The new username for credentials of kind encrypted, vars or ppk. If the credential kind is encrypted, the username is encrypted before being saved against the credential.

password

The new password for credentials of kind encrypted and vars. If the credential kind is encrypted, the password is encrypted before being saved against the credential.

keyfile

The new path of the private keyfile for credentials of kind ppk.

filename

The new path of the Harvest DFO file for credentials of kind dfo.



Example Result:


{

       success: true

}


NOTE: It is not possible to modify the Credential's kind (encrypted, vars, dfo or ppk) once it has been created. If you need to change the kind of the Credential, you must delete it and recreate it.