WHM API.
Download OpenAPI description
Overview
URL
WebPros International, LLC
License
Languages
Servers
Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/
A server running WHM.
https://{host}:{port}/json-api/
Query
Whether to abort the function if the user already has a key with the same name.
1— Abort.0— Continue.
Default 1
Enum01
Example: abort_on_existing_key=1
The key's encryption algorithm. The parameter defaults to the system's default algorithm.
Enum"rsa2""dsa"
Example: algorithm=dsa
The key's bits:
1024— The DSA algorithm's default value.20484096— The RSA algorithm's default value.
Enum102420484096
Example: bits=2048
The key's filename.
This parameter defaults to id_rsa if the algorithm is RSA, and id_dsa if the algorithm is DSA.
Default "id_rsa"
Example: name=KeyFile
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/generatesshkeypair
- A server running WHM.
https://whm-server.tld:2087/json-api/generatesshkeypair
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://api.docs.cpanel.net/_mock/specifications/whm.openapi/generatesshkeypair?abort_on_existing_key=1&algorithm=dsa&bits=2048&comment=NoComment&name=KeyFile&passphrase=123456luggage'Response
application/json
{ "data": { "fingerprint": null, "name": "KeyFile" }, "metadata": { "command": "generatesshkeypair", "reason": "OK", "result": 1, "version": 1 } }
Query
The key's contents.
Example: key=-----BEGIN RSA PRIVATE KEY----- hPH+o4NgZrky7iGBb5iUg8R4aQzLPexpYfet25bLESvHOtutsBkbN7UWAaoM0pgM hytunlM8UU4BArJWlJyY6AD59aluZowBbuowKeU+f+TRaeJNJvkxTCOAipzp6LyG nrSVJ5hxSN/RPfntho1MEsdWYewVI4eLayuiZJyD+VONCYJh/vPLaZ9AVUJuMerl s/ZJ24AwCW8cILG+C3TWJRCjl4Ji+sJ9A5P29p/ad18cyJc1F+wmAzMULWitCaB7 mmE0i1nkiZRygQzzKjqdBYWCjujxfoE2+nPufAJg8ZdIEI1xSVBe5jKnj8DRX67w NAnNjXANMRePo39/RbDOSEXsD62h1qH93SnPsAhYT1JE6xHKV85AVIVOe8ktTA8t jMBBioCudBFngqPHknUrIJZ2QfUm0fkKBZaoKW4yr3JjGk+5y6kg02gSDIA7/jGc 8rs3iKN+QJ/ug2x/v7Xe0OozVqpl5QTltEMGJzJ1jFh9WnqgsgLTiJWlE7x5VSv8 fV8A5WTafOhBHnKuOpmpjAel1GD5DT1jNx3LhWXMHOayawC0WY04lT5kkLLWhuN2 pNqY6UBk6Z3m1ifPINq85RdnHriJiD3H/+6P+cUyGSOznni8yqU764LId4nNClWd Xc+VvM1Udw0Sm7xF7err9CKHYUg3HfFYQPBQOfI0ib9wqOi7zWq2vhH21B5OgcTg Bsw/HJUQ/IVnTbsqgZSn0sckaRguv/ifmwbISO1aQ4Yxcohe/4miOw05r6ihbYGW LO5kP0I8SBMCibkGFh5AxVnNgoGAW0l33hOPPSIVUTkE+8d3zYXLzupTFXCvmohl jq0it7uIGOxSglf7XH3eXlNKaZjK7pBJgS5HeXM80JI8FCfifqnkaik8XTE66Ll0 s1ySaGevGkPpX5Rhbgsm4IqddAeFvlmKIND8Zvh/wfT++bbD7bbFwFlrWCU3chce 8KaNVUP+whCAlaS7oGcs38ygaRFXIE3vug4Ra8Xiy/qfyp4YR67sMg46avHyoVky uFbVv2n7HphZb7g3WS3ns3/gCQQv9TYcdBoRnKW2yEqbzOQb9Fdt7EjgMohT/bdS pM6nRWFNdmWoihLzLbSi3bnc9iDwXZA8KyE3mpVi4QFfijR4dfrVWxEz5Ln2l9HC SZA6VPGzEOwOVVND98/HTu3oViJUV1gyDIWlyggSUDTyhfo/Z+c3tTHa+cv0f7xY oL63hWLgZQD2m/g6rKpsN3NhC77tCyCNZavdKy7usvZyCsoH/mPR2129LcwAwbJ3 u2Ec7qLncztSePHOmfmCTTED00a0YzFhKIQoJf7GrgLCMapYN/YPu0vgTDMPSi11 RH0rdyzd6MuPVDZwLnWO+SltjX85yz1ba/Q199HZwQOw6ZyejDaPSWJHOndD3k+r Q0T38gci9k4D87EwmfpK7zOaCoaiGiRQ6+DdYOv6hlzQ6Fdb2FOtlGQZharQ9WTC jOJBEj2oGUruc6P3fqhfUVllWi4cck0GgWZwcsmG1dDr8W6K9lrGA1dPbXoOns1B l58ghMGtHG7D0VlHs6SIqFmHr5kUgSQ4jJ2KZkVU8CrPBZ2HRtHQJJyjZWW2AbrE -----END RSA PRIVATE KEY-----
Whether to extract and save only the private key.
1— Private key only.0— All data.
Note:
This parameter defaults to 1 for PPK (PuTTY Key Generator) files and 0 for all other imports.
Enum01
Example: extract_private=0
Whether to extract and save only the public key.
1— Public key only.0— All data.
Note:
This parameter defaults to 1 for PPK (PuTTY Key Generator) files and 0 for all other imports.
Enum01
Example: extract_public=0
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/importsshkey
- A server running WHM.
https://whm-server.tld:2087/json-api/importsshkey
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://api.docs.cpanel.net/_mock/specifications/whm.openapi/importsshkey?key=-----BEGIN+RSA+PRIVATE+KEY-----+hPH%2Bo4NgZrky7iGBb5iUg8R4aQzLPexpYfet25bLESvHOtutsBkbN7UWAaoM0pgM+hytunlM8UU4BArJWlJyY6AD59aluZowBbuowKeU%2Bf%2BTRaeJNJvkxTCOAipzp6LyG+nrSVJ5hxSN%2FRPfntho1MEsdWYewVI4eLayuiZJyD%2BVONCYJh%2FvPLaZ9AVUJuMerl+s%2FZJ24AwCW8cILG%2BC3TWJRCjl4Ji%2BsJ9A5P29p%2Fad18cyJc1F%2BwmAzMULWitCaB7+mmE0i1nkiZRygQzzKjqdBYWCjujxfoE2%2BnPufAJg8ZdIEI1xSVBe5jKnj8DRX67w+NAnNjXANMRePo39%2FRbDOSEXsD62h1qH93SnPsAhYT1JE6xHKV85AVIVOe8ktTA8t+jMBBioCudBFngqPHknUrIJZ2QfUm0fkKBZaoKW4yr3JjGk%2B5y6kg02gSDIA7%2FjGc+8rs3iKN%2BQJ%2Fug2x%2Fv7Xe0OozVqpl5QTltEMGJzJ1jFh9WnqgsgLTiJWlE7x5VSv8+fV8A5WTafOhBHnKuOpmpjAel1GD5DT1jNx3LhWXMHOayawC0WY04lT5kkLLWhuN2+pNqY6UBk6Z3m1ifPINq85RdnHriJiD3H%2F%2B6P%2BcUyGSOznni8yqU764LId4nNClWd+Xc%2BVvM1Udw0Sm7xF7err9CKHYUg3HfFYQPBQOfI0ib9wqOi7zWq2vhH21B5OgcTg+Bsw%2FHJUQ%2FIVnTbsqgZSn0sckaRguv%2FifmwbISO1aQ4Yxcohe%2F4miOw05r6ihbYGW+LO5kP0I8SBMCibkGFh5AxVnNgoGAW0l33hOPPSIVUTkE%2B8d3zYXLzupTFXCvmohl+jq0it7uIGOxSglf7XH3eXlNKaZjK7pBJgS5HeXM80JI8FCfifqnkaik8XTE66Ll0+s1ySaGevGkPpX5Rhbgsm4IqddAeFvlmKIND8Zvh%2FwfT%2B%2BbbD7bbFwFlrWCU3chce+8KaNVUP%2BwhCAlaS7oGcs38ygaRFXIE3vug4Ra8Xiy%2Fqfyp4YR67sMg46avHyoVky+uFbVv2n7HphZb7g3WS3ns3%2FgCQQv9TYcdBoRnKW2yEqbzOQb9Fdt7EjgMohT%2FbdS+pM6nRWFNdmWoihLzLbSi3bnc9iDwXZA8KyE3mpVi4QFfijR4dfrVWxEz5Ln2l9HC+SZA6VPGzEOwOVVND98%2FHTu3oViJUV1gyDIWlyggSUDTyhfo%2FZ%2Bc3tTHa%2Bcv0f7xY+oL63hWLgZQD2m%2Fg6rKpsN3NhC77tCyCNZavdKy7usvZyCsoH%2FmPR2129LcwAwbJ3+u2Ec7qLncztSePHOmfmCTTED00a0YzFhKIQoJf7GrgLCMapYN%2FYPu0vgTDMPSi11+RH0rdyzd6MuPVDZwLnWO%2BSltjX85yz1ba%2FQ199HZwQOw6ZyejDaPSWJHOndD3k%2Br+Q0T38gci9k4D87EwmfpK7zOaCoaiGiRQ6%2BDdYOv6hlzQ6Fdb2FOtlGQZharQ9WTC+jOJBEj2oGUruc6P3fqhfUVllWi4cck0GgWZwcsmG1dDr8W6K9lrGA1dPbXoOns1B+l58ghMGtHG7D0VlHs6SIqFmHr5kUgSQ4jJ2KZkVU8CrPBZ2HRtHQJJyjZWW2AbrE+-----END+RSA+PRIVATE+KEY-----&name=TestKey&extract_private=0&extract_public=0&passphrase=123456luggage'Response
application/json
{ "metadata": { "command": "importsshkey", "reason": "OK", "result": 1, "version": 1 } }
Query
Whether to display only private keys.
1— Display only private keys.0— Display all keys.
Default 1
Enum01
Example: private=0
Whether to include private key text.
1— Include private key text.0— Do not include private key text.
Default 1
Enum01
Example: private_texts=0
Whether to display only public keys.
1— Display only public keys.0— Display all keys.
Enum01
Example: public=0
Whether to include public key text.
1— Include public key text.0— Do not include public key text.
Default 0
Enum01
Example: public_texts=0
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/listsshkeys
- A server running WHM.
https://whm-server.tld:2087/json-api/listsshkeys
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://api.docs.cpanel.net/_mock/specifications/whm.openapi/listsshkeys?files=TestKey&private=0&private_texts=0&public=0&public_texts=0&sync_authorized=0'Response
application/json
{ "data": { "keys": [ … ] }, "metadata": { "command": "listsshkeys", "reason": "OK", "result": 1, "version": 1 } }