Skip to content

Commit 15b1b9c

Browse files
Add credential store example command
1 parent 49e44fd commit 15b1b9c

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

docs/commandline.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,12 +76,16 @@ To generate a template:
7676
### Stored Credentials
7777
For advanced automation scenarios you can add/update stored credentials or list your existing items:
7878

79-
- `certify credential store <unique storage key GUID> "<title>" "<type id>" "<secret>"` : for advanced automation use. Stores or updates a stored credential.
79+
- `certify credential store <unique storage key GUID> "<title>" "<type id>" "<secret values as JSON>"` : for advanced automation use. Stores or updates a stored credential.
8080

8181
- `certify credential list` : list current stored credential summary information. This does not show secret values.
8282

8383
Note that when storing credentials information such as the Type ID and JSON format for the secrets will vary by credential type and are not arbitrary. [See an export](https://github.com/webprofusion/certify-plugins/blob/development/src/DeploymentTasks/Examples/Misc/storedcredential-definitions.txt) of the current list on github or contact support to discuss your requirements.
8484

85+
Below is an example command adding a stored credential for the Cloudflare DNS API. The GUID ID is generated by you and just needs to be unique where you are using it:
86+
87+
`./certify credential store "00213bb0-ec38-49db-bbec-f38f40e91809" "A test credential" DNS01.API.Cloudflare "{'apitoken':'anexampletokenvalue'}"`
88+
8589
### Diagnostics
8690

8791
- `certify diag` : check existing ssl bindings and managed certificate integrity

0 commit comments

Comments
 (0)