This CLI command retrieves the details of WebAPI keys for integrating with Zend Server.

Command Specific Arguments

This table specifies the various arguments used in the command:

Abbreviated Full Description Required/Optional



The WebAPI key name.


Common Arguments

This table lists arguments common to all zs-manage commands:

Abbreviated Full Description Required/Optional



WebAPI key name.




WebAPI secret key.




Zend Server URL. Default: http://localhost:10081/ZendServer.

Required - when action is performed on a remote server.



Show usage information and exit.




Instructions on how to complete a procedure

To use api-keys-get-list:

  1. Open your CLI.
  1. Enter a help command for the api-keys-get-list action to learn which arguments your command should include:

/usr/local/zend/bin/zs-manage api-keys-get-list --help

  1. Enter the command with the required arguments (replace brackets with your value):

/usr/local/zend/bin/zs-manage api-keys-get-list -n <key name> -N <existing key name> -K <existing key secret>

Your CLI will return the details of the WebAPI key specified. Save these details for future use:

KEY_NAME = newkey


KEY_HASH = ed4ff21bb839b55d870c1c485deddd8c1164634c70c3dbe17da9fb3f410178a3



If you want to retrieve the details of more than one key, just add another '-n' parameter with the name of the key.