WHM API 1 Functions - authorizesshkey

Do not transfer private keys over insecure ports.
Only the root account can use this function, and it only affects the root keys. To perform this function on a regular user account, call the cPanel API 2 SSH::authkey function through the WHM API.

Examples

JSON API

https://hostname.example.com:2087/cpsess##########/json-api/authorizesshkey?api.version=1&user=username&file=%2Fhome%2Fusername%2Fsshkey&authorize=1

XML API

https://hostname.example.com:2087/cpsess##########/xml-api/authorizesshkey?api.version=1&user=username&file=%2Fhome%2Fusername%2Fsshkey&authorize=1

Command Line

whmapi1 authorizesshkey user=username file=%2Fhome%2Fusername%2Fsshkey authorize=1

Notes:

Unless otherwise noted, you must URI-encode values.
For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command.
If you run CloudLinux™, you must use the full path of the whmapi1 command:
```
/usr/local/cpanel/bin/whmapi1
```

Output (JSON)

{
  "metadata": {
    "reason": "OK",
    "version": 1,
    "command": "authorizesshkey",
    "result": 1
  },
  "data": {
    "file": "test",
    "authorized": 1
  }
}

Output (XML)

<result>
    <metadata>
        <result>1</result>
        <version>1</version>
        <reason>OK</reason>
        <command>authorizesshkey</command>
    </metadata>
    <data>
        <file>test</file>
        <authorized>1</authorized>
    </data>
</result>

Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

Parameters

Note:

You must include either the file or the text parameter.

Parameter	Type	Description	Possible values	Example
`file`	string	The SSH key file's name.	An absolute file path.	`/home/username/` sshkey
`text`	string	The text of the SSH public key file.	A valid SSH key.	Click to view... ssh-rsa AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAB3NzaC1yc2EAAAABIwAAAQEA4fTwKg8fA4Ey5/fwyZdeiWoktiXwx1dAAAAAA AAAAAAAAAAAA AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAB3NzaC1yc2EAAAABIwAAAQEA4fTwKg8fA4Ey5/fwyZdeiWoktiXwx1dAAAAAA AAAAAAAAAAAA AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAB3NzaC1yc2EAAAABIwAAAQEA4fTwKg8fA4Ey5/fwyZdeiWoktiXwx1dAAAAAA AAAAAAAAAAAA AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAB3NzaC1yc2EAAAABIwAAAQEA4fTwKg8fA4Ey5/fwyZdeiWoktiXwx1dAAAAAA AAAAAAAAAAAA == REPO user@example.com
`user`	string	The SSH key's username.	A valid username.	`username`
`authorize`	Boolean	Whether to authorize the SSH key to access the server.	`1` — Authorize. `0` — Do not authorize.	`1`
`options`	string	Options to include with the SSH key.	A valid string.	`null`

Returns

Return	Type	Description	Possible values	Example
`file`	string	The SSH key file's name.	A valid filename.	TestKey
`authorize`	Boolean	Whether the SSH key is authorized to access the server.	`1` — Authorized. `0` — Not authorized.	`1`

Function information

API Version:

WHM API 1

Available in:

WHM 11+

Methods:

GET, POST

Required Parameters:

(none)

Return Formats:

JSON, XML

Important:

cPanel & WHM version 66 deprecated XML output.

About WHM API 1

WHM API 1 performs functions and accesses data in WHM.

Notes:

Some functions and parameters may require that you authenticate as the root user.
You must use the appropriate WHM ports (2086 or 2087) to call WHM API functions.

Find a function

Related functions

Page:

WHM API 1 Sections - Security — Security functions allow you to manage system security services.
Page:

WHM API 1 Functions - authorizesshkey — This function authorizes a key to access the server via SSH.
Page:

WHM API 1 Functions - check_remote_ssh_connection — This function tests an SSH connection to another server.
Page:

WHM API 1 Functions - convertopensshtoputty — This function converts an OpenSSH private key to a PuTTY key.
Page:

WHM API 1 Functions - deletesshkey — This function function deletes an SSH key from the server.

Child pages