admin

Available methods

Description

Provides methods to access and modify PAYG ssh connection data

Namespace:

admin

Method: create

HTTP POST

Description:

Create a new ssh connection data to extract data from

Parameters:

  • string sessionKey

  • string description

  • string host - hostname or IP address to the instance, will fail if already in use.

  • int port

  • string username

  • string password

  • string key - private key to use in authentication

  • string keyPassword

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: create

HTTP POST

Description:

Create a new ssh connection data to extract data from

Parameters:

  • string sessionKey

  • string description

  • string host - hostname or IP address to the instance, will fail if already in use.

  • int port

  • string username

  • string password

  • string key - private key to use in authentication

  • string keyPassword

  • string bastionHost - hostname or IP address to a bastion host

  • int bastionPort

  • string bastionUsername

  • string bastionPassword

  • string bastionKey - private key to use in bastion authentication

  • string bastionKeyPassword

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: delete

HTTP POST

Description:

Returns a list of ssh connection data registered.

Parameters:

  • string sessionKey

  • string host - hostname or IP address of the instance

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: getDetails

HTTP POST

Description:

Returns a list of ssh connection data registered.

Parameters:

  • string sessionKey

  • string host - hostname or IP address of the instance, will fail if host doesn’t exist.

Returns:

  • * struct SSH data

    • string "description"

    • string "hostname"

    • int "port"

    • string "username"

    • string "bastion_hostname"

    • int "bastion_port"

    • string "bastion_username"

Method: list

HTTP POST

Description:

Returns a list of ssh connection data registered.

Parameters:

  • string sessionKey

Returns:

  • array :

  • struct SSH data

    • string "description"

    • string "hostname"

    • int "port"

    • string "username"

    • string "bastion_hostname"

    • int "bastion_port"

    • string "bastion_username"

Method: setDetails

HTTP POST

Description:

Updates the details of a ssh connection data

Parameters:

  • string sessionKey

  • string host - hostname or IP address to the instance, will fail if host doesn’t exist.

  • struct details - user details

    • string "description"

    • int "port"

    • string "username"

    • string "password"

    • string "key"

    • string "key_password"

    • string "bastion_host"

    • int "bastion_port"

    • string "bastion_username"

    • string "bastion_password"

    • string "bastion_key"

    • string "bastion_key_password"

Returns:

  • int - 1 on success, exception thrown otherwise.