Plesk

secret_key: Authentication in Plesk XML API

To authenticate API requests, you can use secret keys instead of credentials.
This topic describes how to create and manage secret keys using the secret_key CLI utility.

You can also create and manage secret keys via Plesk XML API.

Note: For security reasons, Plesk does not store secret keys. It stores only their hashes.

Usage

secret_key <command> [
<option_1> [<param>]
[<option_2> [<param>]]
]

Example

The following command creates a secret key assigned to the IP address 192.0.2.1:

plesk bin secret_key -c -ip-address 192.0.2.1

Note: Once you have created a secret key, copy it and keep it safe.
For security reasons, secret keys are shown only when they are created.
The secret_key CLI utility will not show them after that.

Commands

Command Parameter Description Example
--create or -c  

Creates a secret key assigning it to the specified IP address (if any)
or to the IP address of the request sender.

Can be used with the -ip-address and -description options.
If you do not specify -ip-address, Plesk will assign the secret key to the IP address of the request sender.

Note:

Once you have created a secret key, copy it and keep it safe.
For security reasons, secret keys are shown only when they are created.
The secret_key CLI utility will not show them after that.

To create a secret key assigned to the…

Exit mobile version