openapi: 3.2.0 info: title: Cpanel SSL API version: 11.137.9999.106 contact: email: cs@cpanel.net name: WebPros International, LLC url: https://cpanel.net/support/ license: name: cPanel License url: https://cpanel.net/legal-notices/ termsOfService: https://cpanel.net/legal-notices/ x-api-evangelist-provenance: 'Harvested verbatim from cPanel''s developer portal on 2026-09-05 via the MCP tool get-full-api-description at https://api.docs.cpanel.net/mcp. ONE mechanical change was made before storage: example values containing PEM private-key or certificate blocks, and AWS-access-key-shaped example strings, were replaced with REDACTED_* placeholders so the file can be stored in a public git repository without tripping secret scanning. No path, operation, parameter, schema or description was altered, added or removed.' description: 'Operations tagged SSL across 2 of this provider''s published API definitions: cpanel-uapi-openapi.yml, cpanel-whm-api-openapi.yml. Each path carries the servers of the definition it was published in.' servers: - description: A server running cPanel. url: https://{host}:{port}/execute variables: host: default: cpanel-server.tld description: The hostname of a server running cPanel. port: default: '2083' description: The cPanel port. - description: A server running WHM. url: https://{host}:{port}/json-api variables: host: default: whm-server.tld description: The hostname of a server running WHM. port: default: '2087' description: The WHM port. security: - BasicAuth: [] tags: - description: The SSL module for UAPI. name: SSL paths: /SSL/add_autossl_excluded_domains: get: x-readonly: false x-rollback: none description: 'This function disables AutoSSL for the domains that you specify. **Important:** When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system **disables** this function.' operationId: SSL-add_autossl_excluded_domains parameters: - description: 'A comma-separated list of domains for which to disable AutoSSL. **Note:** For browser-based calls, use a URI encoded comma (`%2C`).' in: query name: domains required: true schema: example: example.com,example2.com format: domain type: string responses: '200': content: application/json: schema: properties: apiversion: description: The version of the API. example: 3 type: integer func: description: The name of the method called. example: add_autossl_excluded_domains type: string module: description: The name of the module called. example: SSL type: string result: properties: data: default: null type: - object - 'null' errors: description: List of errors if the API failed. example: null items: type: string type: - array - 'null' messages: description: List of messages generated by the API. example: null items: type: string type: - array - 'null' metadata: properties: {} status: description: '* `1` - Success. * `0` - Failed. Check the `errors` field for more details.' enum: - 0 - 1 example: 1 type: integer warnings: description: List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API. example: null items: type: string type: - array - 'null' type: object description: HTTP Request was successful. summary: Disable AutoSSL for domains tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "uapi --output=jsonpretty \\\n --user=username \\\n SSL \\\n add_autossl_excluded_domains \\\n domains='example.com,example2.com'\n" - label: URL lang: HTTP source: https://hostname.example.com:2083/cpsess##########/execute/SSL/add_autossl_excluded_domains?domains=example.com%2cexample2.com - label: LiveAPI Perl lang: Perl source: "#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_add_autossl_excluded_domains.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend//\n# to .../frontend//api_examples/SSL_add_autossl_excluded_domains.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n q/SSL/,\n q/add_autossl_excluded_domains/,\n {\n 'domains' => 'example.com,example2.com',\n }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n my $data = $response->{cpanelresult}{result}{data};\n # Do something with the $data\n # So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n # Report errors:\n print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n require JSON;\n my $str = JSON->new->pretty->encode($_[0]);\n return $str;\n}\n" - label: LiveAPI PHP lang: PHP source: " is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_add_autossl_excluded_domains.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend//\n// to .../frontend//api_examples/SSL_add_autossl_excluded_domains.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n 'SSL',\n 'add_autossl_excluded_domains',\n array (\n 'domains' => 'example.com,example2.com',\n )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n $data = $response['cpanelresult']['result']['data'];\n // Do something with the $data\n // So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n // Report errors:\n print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n return json_encode($data, JSON_PRETTY_PRINT);\n}" x-cpanel-api-version: UAPI x-cpanel-available-version: cPanel 66 servers: - description: A server running cPanel. url: https://{host}:{port}/execute variables: host: default: cpanel-server.tld description: The hostname of a server running cPanel. port: default: '2083' description: The cPanel port. /SSL/can_ssl_redirect: get: x-readonly: true description: This function determines whether the system can automatically redirect domains on a cPanel account to use SSL. operationId: SSL-can_ssl_redirect parameters: [] responses: '200': content: application/json: schema: properties: apiversion: description: The version of the API. example: 3 type: integer func: description: The name of the method called. example: can_ssl_redirect type: string module: description: The name of the module called. example: SSL type: string result: properties: data: description: 'Whether the system can automatically redirect the domains to use SSL. * `1` - Can redirect. * `0` - **Cannot** redirect.' enum: - 0 - 1 example: 1 type: integer errors: description: List of errors if the API failed. example: null items: type: string type: - array - 'null' messages: description: List of messages generated by the API. example: null items: type: string type: - array - 'null' metadata: properties: {} status: description: '* `1` - Success. * `0` - Failed. Check the `errors` field for more details.' enum: - 0 - 1 example: 1 type: integer warnings: description: List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API. example: null items: type: string type: - array - 'null' type: object type: object description: HTTP Request was successful. summary: Return whether domains can redirect to secure URL tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "uapi --output=jsonpretty \\\n --user=username \\\n SSL \\\n can_ssl_redirect\n" - label: URL lang: HTTP source: https://hostname.example.com:2083/cpsess##########/execute/SSL/can_ssl_redirect - label: LiveAPI Perl lang: Perl source: "#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_can_ssl_redirect.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend//\n# to .../frontend//api_examples/SSL_can_ssl_redirect.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n q/SSL/,\n q/can_ssl_redirect/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n my $data = $response->{cpanelresult}{result}{data};\n # Do something with the $data\n # So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n # Report errors:\n print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n require JSON;\n my $str = JSON->new->pretty->encode($_[0]);\n return $str;\n}\n" - label: LiveAPI PHP lang: PHP source: " is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_can_ssl_redirect.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend//\n// to .../frontend//api_examples/SSL_can_ssl_redirect.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n 'SSL',\n 'can_ssl_redirect'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n $data = $response['cpanelresult']['result']['data'];\n // Do something with the $data\n // So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n // Report errors:\n print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n return json_encode($data, JSON_PRETTY_PRINT);\n}" x-cpanel-api-version: UAPI x-cpanel-available-version: cPanel 80 servers: - description: A server running cPanel. url: https://{host}:{port}/execute variables: host: default: cpanel-server.tld description: The hostname of a server running cPanel. port: default: '2083' description: The cPanel port. /SSL/check_shared_cert: get: x-readonly: true deprecated: true description: This function checks whether a shared SSL certificate is associated with the account. operationId: SSL-check_shared_cert parameters: [] responses: '200': content: application/json: schema: properties: apiversion: description: The version of the API. example: 3 type: integer func: description: The name of the method called. example: check_shared_cert type: string module: description: The name of the module called. example: SSL type: string result: properties: data: description: 'Whether a shared SSL certificate is associated with the account. * `1` - Associated. * `0` - Not associated.' enum: - 0 - 1 example: 0 type: integer errors: description: List of errors if the API failed. example: null items: type: string type: - array - 'null' messages: description: List of messages generated by the API. example: null items: type: string type: - array - 'null' metadata: properties: {} status: description: '* `1` - Success. * `0` - Failed. Check the `errors` field for more details.' enum: - 0 - 1 example: 0 type: integer warnings: description: List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API. example: null items: type: string type: - array - 'null' type: object type: object description: HTTP Request was successful. summary: Return whether shared SSL certificate exists tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "uapi --output=jsonpretty \\\n --user=username \\\n SSL \\\n check_shared_cert\n" - label: URL lang: HTTP source: https://hostname.example.com:2083/cpsess##########/execute/SSL/check_shared_cert - label: LiveAPI Perl lang: Perl source: "#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_check_shared_cert.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend//\n# to .../frontend//api_examples/SSL_check_shared_cert.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n q/SSL/,\n q/check_shared_cert/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n my $data = $response->{cpanelresult}{result}{data};\n # Do something with the $data\n # So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n # Report errors:\n print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n require JSON;\n my $str = JSON->new->pretty->encode($_[0]);\n return $str;\n}\n" - label: LiveAPI PHP lang: PHP source: " is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_check_shared_cert.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend//\n// to .../frontend//api_examples/SSL_check_shared_cert.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n 'SSL',\n 'check_shared_cert'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n $data = $response['cpanelresult']['result']['data'];\n // Do something with the $data\n // So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n // Report errors:\n print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n return json_encode($data, JSON_PRETTY_PRINT);\n}" x-cpanel-api-version: UAPI x-cpanel-available-version: cPanel 11.42 servers: - description: A server running cPanel. url: https://{host}:{port}/execute variables: host: default: cpanel-server.tld description: The hostname of a server running cPanel. port: default: '2083' description: The cPanel port. /SSL/delete_cert: get: x-readonly: false x-rollback: none description: 'This function deletes an SSL certificate. **Note:** * When you call this function, you **must** include the `id` or the `friendly_name` parameter. * This function **only** deletes certificates from SSL storage. To end SSL coverage for a domain, use the UAPI `SSL::delete_ssl` function instead. **Important:** When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system **disables** this function.' operationId: SSL-delete_cert parameters: - description: The certificate's friendly name. in: query name: friendly_name required: false schema: example: TestCert type: string - description: The certificate's ID. in: query name: id required: false schema: example: example_com_cb497_a394d_1397249671_d1272da8f13a1fd837493a5ad1f0a0f3 type: string responses: '200': content: application/json: schema: properties: apiversion: description: The version of the API. example: 3 type: integer func: description: The name of the method called. example: delete_cert type: string module: description: The name of the module called. example: SSL type: string result: properties: data: items: properties: created: description: The date the certificate was created. example: 1538308800 format: unix_timestamp type: integer domains: description: A list of the domains that the certificate covers. items: example: example.com format: domain type: string type: array ecdsa_curve_name: description: 'The ECDSA curve that the certificate''s key uses. * `prime256v1` * `secp384r1` * `null` — The certificate''s key is **not** an ECDSA key.' enum: - prime256v1 - secp384r1 example: prime256v1 type: - string - 'null' ecdsa_public: description: 'The certificate''s key''s ECDSA compressed public point, in hexadecimal format. * `null` — The certificate''s key is **not** an ECDSA key.' example: null type: - string - 'null' friendly_name: description: The certificate's friendly name. example: TestCert type: string id: description: The certificate's ID. example: example_com_cb497_a394d_1397249671_d1272da8f13a1fd837493a5ad1f0a0f3 type: string is_self_signed: description: 'Whether the certificate is self-signed. * `1` — Self-signed. * `0` — Not self-signed.' enum: - 1 - 0 example: 1 type: integer issuer.commonName: description: The certificate's Common Name. example: example.com type: string issuer.organizationName: description: The certificate's Organization Name. example: Organization type: string issuer_text: description: The certificate's issuer information. example: 'countryName US stateOrProvinceName TX localityName Houston organizationName Organization commonName example.com' type: string key_algorithm: description: 'The certificate''s key''s algorithm. * `rsaEncryption` — RSA. * `id-ecPublicKey` — ECDSA.' enum: - rsaEncryption - id-ecPublicKey example: rsaEncryption type: string modulus: description: 'The certificate''s key''s modulus, in hexadecimal format. * `null` — The certificate''s key is **not** an RSA key.' example: a673c3b17344664b35f8791f562d3aea6bf4d8faa3ae3fc0a519380fd453964a36677c34d48677ecb7f5ed035df026f5f0f8fbfe21745e52daf1f3b9e58c73f0baefdb709320e2202e7d05250b051a59b30ff1fef22d83d7140c1c81cea314a0890ce8d2226799872181c58a74016c7aaa2cff5ac72b575cecde8f304aa572a2ea03d8b173ab76c6e8cdb9dfd0da81e1119cefd4b8b4dbfbe0e46c7f1ee2fe8b5fd5504e58ccbc0d13b4fa41ecc9ebd0dabe1d1fec5c724f748167e7c0553e997f9b77eb36abce70973f06df151748d41b758de3efd7afa6f2464a1547f5ff158469d96e248be464df9eda0e7ce854a89332a2c1278b17c425368a9604f454db type: - string - 'null' modulus_length: description: 'The length, in bits, of the certificate''s key''s modulus. * `null` — The certificate''s key is **not** an RSA key.' example: 2048 type: - integer - 'null' not_after: description: The date the certificate expired. example: 1569844800 format: unix_timestamp type: integer not_before: description: The date the certificate started. example: 1538308800 format: unix_timestamp type: integer serial: description: The certificate's serial number. example: 45462cd0d6537b20cf2f3eb8aec07140 type: string signature_algorithm: description: The certificate's OID signature hash algorithm. example: sha256WithRSAEncryption type: string subject.commonName: description: The certificate's Common Name. example: example.com type: string subject_text: description: The certificate's subject text information. example: 'commonName www.example.com' type: string validation_type: description: 'The certificate''s validation type. * `ev` — Extended Validation. * `ov` — Organization Validation. * `dv` — Domain Validation. * `null` — The system could not parse and determine the certificate''s validation type.' enum: - ev - ov - dv example: dv type: - string - 'null' type: object type: array errors: description: List of errors if the API failed. example: null items: type: string type: - array - 'null' messages: description: List of messages generated by the API. example: null items: type: string type: - array - 'null' metadata: properties: transformed: description: Post-processing may have transformed the data. enum: - 1 example: 1 type: integer status: description: '* `1` — Success. * `0` — Failed. Check the `errors` field for more details.' enum: - 1 - 0 example: 1 type: integer warnings: description: List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API. example: null items: type: string type: - array - 'null' type: object type: object description: HTTP Request was successful. summary: Delete SSL certificate tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "uapi --output=jsonpretty \\\n --user=username \\\n SSL \\\n delete_cert\n" - label: URL lang: HTTP source: https://hostname.example.com:2083/cpsess##########/execute/SSL/delete_cert - label: LiveAPI Perl lang: Perl source: "#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_delete_cert.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend//\n# to .../frontend//api_examples/SSL_delete_cert.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n q/SSL/,\n q/delete_cert/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n my $data = $response->{cpanelresult}{result}{data};\n foreach my $item (@{$data}) {\n # Do something with the $item\n }\n\n # So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n # Report errors:\n print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n require JSON;\n my $str = JSON->new->pretty->encode($_[0]);\n return $str;\n}\n" - label: LiveAPI PHP lang: PHP source: " is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_delete_cert.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend//\n// to .../frontend//api_examples/SSL_delete_cert.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n 'SSL',\n 'delete_cert'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n $data = $response['cpanelresult']['result']['data'];\n foreach ($data as $item) {\n // Do something with the $item\n }\n\n // So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n // Report errors:\n print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n return json_encode($data, JSON_PRETTY_PRINT);\n}" x-cpanel-api-version: UAPI x-cpanel-available-version: cPanel 11.42 servers: - description: A server running cPanel. url: https://{host}:{port}/execute variables: host: default: cpanel-server.tld description: The hostname of a server running cPanel. port: default: '2083' description: The cPanel port. /SSL/delete_csr: get: x-readonly: false x-rollback: none description: 'This function deletes a certificate signing request (CSR). **Note:** * When you call this function, you **must** include the `id` or the `friendly_name` parameter. * To delete a private key, use the UAPI `SSL::delete_key` function instead. **Important:** When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system **disables** this function.' operationId: SSL-delete_csr parameters: - description: The CSR's friendly name. in: query name: friendly_name required: false schema: example: TestCSR type: string - description: The CSR's ID. in: query name: id required: false schema: example: example_com_e095f_0ab2f_ebcbe4a571276f48562241411556647f type: string responses: '200': content: application/json: schema: properties: apiversion: description: The version of the API. example: 3 type: integer func: description: The name of the method called. example: delete_csr type: string module: description: The name of the module called. example: SSL type: string result: properties: data: items: properties: commonName: description: The CSR's Common Name. example: example.com format: domain type: string created: description: The CSR's creation date. example: 1538308800 format: unix_timestamp type: integer domains: description: A list of the domains that the CSR covers. items: example: example.com type: string type: array ecdsa_curve_name: description: 'The ECDSA curve that the CSR''s key uses. * `prime256v1` * `secp384r1` * `null` — The CSR''s key is **not** an ECDSA key.' enum: - prime256v1 - secp384r1 example: prime256v1 type: - string - 'null' ecdsa_public: description: 'The CSR''s key''s ECDSA compressed public point, in hexadecimal format. * `null` — The CSR''s key is **not** an ECDSA key.' example: null type: - string - 'null' friendly_name: description: The CSR's friendly name. example: TestCSR type: string id: description: The CSR's ID. example: example_com_e095f_0ab2f_ebcbe4a571276f48562241411556647f type: string key_algorithm: description: 'The CSR''s key''s algorithm. * `rsaEncryption` — RSA. * `id-ecPublicKey` — ECDSA.' enum: - rsaEncryption - id-ecPublicKey example: rsaEncryption type: string modulus: description: 'The CSR''s key''s modulus, in hexadecimal format. * `null` — The CSR''s key is **not** an RSA key.' example: 'a74f7636fa6ac93ee6836a83a995b55deb5019ea36d7ba3dafb00e38d693acd b0c81b2ff777d6b433a420fae523f127f352a68bcc8b8f2d6ee7b70395bafab d8237ada8164fdddf8376b30375c35d4d4cbcce7d33d08069c17b409176a368 9f1ebc97c0b08fe6ae44c19a92ac6d68448e7f1d13f3b360affd4222a51b4f3 5342de99b5a1fb5548e438f2d824664562a448002eed7fce24dedc7dc3e1ed1 79973d1dae959b33716eeb410d172708954e00632cbf60a0e26419860c8c0bc 285d6bfe4b479de0dd189772a5dae676bd2a92acccc1369821be8cffddd8a7e 6ecc061f8a32a9ae0661e4e946ed8e3827b277138d3a76116567cbd129cbd86 9ef9dddf' type: - string - 'null' type: object type: array errors: description: List of errors if the API failed. example: null items: type: string type: - array - 'null' messages: description: List of messages generated by the API. example: null items: type: string type: - array - 'null' metadata: properties: transformed: description: Post-processing may have transformed the data. enum: - 1 example: 1 type: integer status: description: '* `1` — Success. * `0` — Failed. Check the `errors` field for more details.' enum: - 1 - 0 example: 1 type: integer warnings: description: List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API. example: null items: type: string type: - array - 'null' type: object type: object description: HTTP Request was successful. summary: Delete certificate signing request tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "uapi --output=jsonpretty \\\n --user=username \\\n SSL \\\n delete_csr\n" - label: URL lang: HTTP source: https://hostname.example.com:2083/cpsess##########/execute/SSL/delete_csr - label: LiveAPI Perl lang: Perl source: "#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_delete_csr.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend//\n# to .../frontend//api_examples/SSL_delete_csr.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n q/SSL/,\n q/delete_csr/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n my $data = $response->{cpanelresult}{result}{data};\n foreach my $item (@{$data}) {\n # Do something with the $item\n }\n\n # So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n # Report errors:\n print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n require JSON;\n my $str = JSON->new->pretty->encode($_[0]);\n return $str;\n}\n" - label: LiveAPI PHP lang: PHP source: " is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_delete_csr.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend//\n// to .../frontend//api_examples/SSL_delete_csr.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n 'SSL',\n 'delete_csr'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n $data = $response['cpanelresult']['result']['data'];\n foreach ($data as $item) {\n // Do something with the $item\n }\n\n // So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n // Report errors:\n print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n return json_encode($data, JSON_PRETTY_PRINT);\n}" x-cpanel-api-version: UAPI x-cpanel-available-version: cPanel 11.42 servers: - description: A server running cPanel. url: https://{host}:{port}/execute variables: host: default: cpanel-server.tld description: The hostname of a server running cPanel. port: default: '2083' description: The cPanel port. /SSL/delete_key: get: x-readonly: false x-rollback: none description: 'This function deletes a private key. **Note:** * When you call this function, you **must** include the `id` or the `friendly_name` parameter. * To delete a certificate signing request (CSR), use the UAPI `SSL::delete_csr` function instead. **Important:** When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system **disables** this function.' operationId: SSL-delete_key parameters: - description: The private key's friendly name. in: query name: friendly_name required: false schema: example: TestKey type: string - description: The private key's ID. in: query name: id required: false schema: example: example_com_e095f_0ab2f_ebcbe4a571276f48562241411556647f type: string responses: '200': content: application/json: schema: properties: apiversion: description: The version of the API. example: 3 type: integer func: description: The name of the method called. example: delete_key type: string module: description: The name of the module called. example: SSL type: string result: properties: data: items: properties: created: description: The private key's creation date. example: 1538308800 format: unix_timestamp type: integer ecdsa_curve_name: description: 'The ECDSA curve that the key uses. * `prime256v1` * `secp384r1` * `null` — The key is **not** an ECDSA key.' enum: - prime256v1 - secp384r1 example: prime256v1 type: - string - 'null' ecdsa_public: description: 'The key''s ECDSA compressed public point, in hexadecimal format. * `null` — The key is **not** an ECDSA key.' example: null type: - string - 'null' friendly_name: description: The private key's friendly name. example: TestKey type: string key_algorithm: description: 'The key''s algorithm. * `rsaEncryption` — RSA. * `id-ecPublicKey` — ECDSA.' enum: - rsaEncryption - id-ecPublicKey example: rsaEncryption type: string modulus: description: 'The key''s modulus, in hexadecimal format. * `null` — The key is **not** an RSA key.' example: a673c3b17344664b35f8791f562d3aea6bf4d8faa3ae3fc0a519380fd453964a36677c34d48677ecb7f5ed035df026f5f0f8fbfe21745e52daf1f3b9e58c73f0baefdb709320e2202e7d05250b051a59b30ff1fef22d83d7140c1c81cea314a0890ce8d2226799872181c58a74016c7aaa2cff5ac72b575cecde8f304aa572a2ea03d8b173ab76c6e8cdb9dfd0da81e1119cefd4b8b4dbfbe0e46c7f1ee2fe8b5fd5504e58ccbc0d13b4fa41ecc9ebd0dabe1d1fec5c724f748167e7c0553e997f9b77eb36abce70973f06df151748d41b758de3efd7afa6f2464a1547f5ff158469d96e248be464df9eda0e7ce854a89332a2c1278b17c425368a9604f454db type: - string - 'null' modulus_length: description: 'The length, in bits, of the key''s modulus. * `null` — The key is **not** an RSA key.' example: 2048 type: - integer - 'null' type: object type: array errors: description: List of errors if the API failed. example: null items: type: string type: - array - 'null' messages: description: List of messages generated by the API. example: null items: type: string type: - array - 'null' metadata: properties: transformed: description: Post-processing may have transformed the data. enum: - 1 example: 1 type: integer status: description: '* `1` — Success. * `0` — Failed. Check the `errors` field for more details.' enum: - 1 - 0 example: 1 type: integer warnings: description: List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API. example: null items: type: string type: - array - 'null' type: object type: object description: HTTP Request was successful. summary: Delete private key tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "uapi --output=jsonpretty \\\n --user=username \\\n SSL \\\n delete_key\n" - label: URL lang: HTTP source: https://hostname.example.com:2083/cpsess##########/execute/SSL/delete_key - label: LiveAPI Perl lang: Perl source: "#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_delete_key.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend//\n# to .../frontend//api_examples/SSL_delete_key.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n q/SSL/,\n q/delete_key/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n my $data = $response->{cpanelresult}{result}{data};\n foreach my $item (@{$data}) {\n # Do something with the $item\n }\n\n # So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n # Report errors:\n print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n require JSON;\n my $str = JSON->new->pretty->encode($_[0]);\n return $str;\n}\n" - label: LiveAPI PHP lang: PHP source: " is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_delete_key.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend//\n// to .../frontend//api_examples/SSL_delete_key.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n 'SSL',\n 'delete_key'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n $data = $response['cpanelresult']['result']['data'];\n foreach ($data as $item) {\n // Do something with the $item\n }\n\n // So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n // Report errors:\n print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n return json_encode($data, JSON_PRETTY_PRINT);\n}" x-cpanel-api-version: UAPI x-cpanel-available-version: cPanel 11.42 servers: - description: A server running cPanel. url: https://{host}:{port}/execute variables: host: default: cpanel-server.tld description: The hostname of a server running cPanel. port: default: '2083' description: The cPanel port. /SSL/delete_ssl: get: x-readonly: false x-rollback: none description: 'This function removes SSL from a domain. **Note:** This function removes domains from the current certificate to end SSL coverage for those domains. To delete certificates from SSL storage, use the UAPI function `SSL::delete_cert` instead. **Important:** When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, **and** Web Server roles, the system **disables** this function.' operationId: SSL-delete_ssl parameters: - description: The domain name. in: query name: domain required: true schema: example: example.com format: domain type: string responses: '200': content: application/json: schema: properties: apiversion: description: The version of the API. example: 3 type: integer func: description: The name of the method called. example: delete_ssl type: string module: description: The name of the module called. example: SSL type: string result: properties: data: default: null type: - object - 'null' errors: description: List of errors if the API failed. example: null items: type: string type: - array - 'null' messages: description: An array containing a message about the domain's SSL removal. example: - The SSL host was successfully removed. items: type: string type: - array - 'null' metadata: properties: {} status: description: '* `1` - Success. * `0` - Failed. Check the `errors` field for more details.' enum: - 0 - 1 example: 1 type: integer warnings: description: List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API. example: null items: type: string type: - array - 'null' type: object type: object description: HTTP Request was successful. summary: Remove SSL for domain tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "uapi --output=jsonpretty \\\n --user=username \\\n SSL \\\n delete_ssl \\\n domain='example.com'\n" - label: URL lang: HTTP source: https://hostname.example.com:2083/cpsess##########/execute/SSL/delete_ssl?domain=example.com - label: LiveAPI Perl lang: Perl source: "#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_delete_ssl.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend//\n# to .../frontend//api_examples/SSL_delete_ssl.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n q/SSL/,\n q/delete_ssl/,\n {\n 'domain' => 'example.com',\n }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n my $data = $response->{cpanelresult}{result}{data};\n # Do something with the $data\n # So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n # Report errors:\n print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n require JSON;\n my $str = JSON->new->pretty->encode($_[0]);\n return $str;\n}\n" - label: LiveAPI PHP lang: PHP source: " is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_delete_ssl.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend//\n// to .../frontend//api_examples/SSL_delete_ssl.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n 'SSL',\n 'delete_ssl',\n array (\n 'domain' => 'example.com',\n )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n $data = $response['cpanelresult']['result']['data'];\n // Do something with the $data\n // So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n // Report errors:\n print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n return json_encode($data, JSON_PRETTY_PRINT);\n}" x-cpanel-api-version: UAPI x-cpanel-available-version: cPanel 11.42 servers: - description: A server running cPanel. url: https://{host}:{port}/execute variables: host: default: cpanel-server.tld description: The hostname of a server running cPanel. port: default: '2083' description: The cPanel port. /SSL/disable_mail_sni: get: x-readonly: false x-rollback: none description: 'This function disables SNI mail services on the specified domains. **Note:** Mail SNI is **always** enabled. * After you change the SNI status, you **must** run UAPI''s `rebuild_mail_sni_config` function. * Functions that enable Mail SNI succeed with a warning that Mail SNI is always enabled. * Functions that disable Mail SNI fail and make no changes.' operationId: SSL-disable_mail_sni parameters: - description: A pipe-delimited list of the account's domains. in: query name: domains required: true schema: example: example.com|example1.com|example2.com type: string responses: '200': content: application/json: schema: properties: apiversion: description: The version of the API. example: 3 type: integer func: description: The name of the method called. example: disable_mail_sni type: string module: description: The name of the module called. example: SSL type: string result: properties: data: example: failed_domains: example2.com: Sorry, example2.com is not one of the domains on your account. updated_domains: example.com: 1 example1.com: 1 properties: failed_domains: additionalProperties: description: "The reason the domain failed to disable SNI.\n\n**Note:**\n\n The domain name is the return name." type: string description: "An object containing the domains that failed to disable\n mail SNI." type: object updated_domains: additionalProperties: description: 'Whether the domain''s SNI is disabled. * `1` - Disabled. * `0` - Not disabled. **Note:** The domain name is the return name.' enum: - 0 - 1 type: integer description: AN object containing the domains with disabled mail SNI. type: object type: object errors: description: List of errors if the API failed. example: null items: type: string type: - array - 'null' messages: description: List of messages generated by the API. example: null items: type: string type: - array - 'null' metadata: properties: {} status: description: '* `1` - Success * `0` - Failed: Check the errors field for more details.' enum: - 0 - 1 example: 1 type: integer warnings: description: "List of warnings generated by the API. Warnings\n describe non-critical failures or other problematic conditions\n noted while running a API." example: null items: type: string type: - array - 'null' type: object type: object description: HTTP Request was successful. summary: Disable SNI mail services for domain tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "uapi --output=jsonpretty \\\n --user=username \\\n SSL \\\n disable_mail_sni \\\n domains='example.com|example1.com|example2.com'\n" - label: URL lang: HTTP source: https://hostname.example.com:2083/cpsess##########/execute/SSL/disable_mail_sni?domains=example.com%7cexample1.com%7cexample2.com - label: LiveAPI Perl lang: Perl source: "#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_disable_mail_sni.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend//\n# to .../frontend//api_examples/SSL_disable_mail_sni.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n q/SSL/,\n q/disable_mail_sni/,\n {\n 'domains' => 'example.com|example1.com|example2.com',\n }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n my $data = $response->{cpanelresult}{result}{data};\n # Do something with the $data\n # So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n # Report errors:\n print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n require JSON;\n my $str = JSON->new->pretty->encode($_[0]);\n return $str;\n}\n" - label: LiveAPI PHP lang: PHP source: " is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_disable_mail_sni.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend//\n// to .../frontend//api_examples/SSL_disable_mail_sni.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n 'SSL',\n 'disable_mail_sni',\n array (\n 'domains' => 'example.com|example1.com|example2.com',\n )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n $data = $response['cpanelresult']['result']['data'];\n // Do something with the $data\n // So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n // Report errors:\n print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n return json_encode($data, JSON_PRETTY_PRINT);\n}" x-cpanel-api-version: UAPI x-cpanel-available-version: cPanel 11.48 servers: - description: A server running cPanel. url: https://{host}:{port}/execute variables: host: default: cpanel-server.tld description: The hostname of a server running cPanel. port: default: '2083' description: The cPanel port. /SSL/enable_mail_sni: get: x-readonly: false x-rollback: none description: 'This function enables SNI mail services on the specified domains. **Warning:** Mail SNI is **always** enabled. * Mail SNI is **not** compatible with Webmail and will **not** function for any Webmail connection. Webmail connections use the cPanel service SSL certificate. * Functions that enable Mail SNI succeed with a warning that Mail SNI is always enabled. * Functions that disable Mail SNI fail and make no changes. **Important:** When you disable the *Calendars and Contacts*, *Mail Receive*, *Web Disk*, *Webmail*, **and** *Web Server* roles, the system **disables** this function.' operationId: SSL-enable_mail_sni parameters: - description: A pipe-delimited list of the account's domains. in: query name: domains required: true schema: example: example.com|example1.com|example2.com type: string responses: '200': content: application/json: schema: properties: apiversion: description: The version of the API. example: 3 type: integer func: description: The name of the method called. example: enable_mail_sni type: string module: description: The name of the module called. example: SSL type: string result: properties: data: example: failed_domains: example2.com: Sorry, example.com is not one of the domains on your account. updated_domains: example.com: 1 example1.com: 1 properties: failed_domains: additionalProperties: description: "The reason the domain failed to enable mail SNI.\n\n**Note:**\n\n The domain name is the return name." example: Sorry, example.com is not one of the domains on your account. type: string description: An object that contains the domains that did not enable mail SNI. type: object updated_domains: additionalProperties: description: 'Whether the domain''s SNI is enabled. * `1` - Enabled. * `0` - Not enabled. **Note:** The domain name is the return name.' enum: - 0 - 1 example: 1 type: integer description: An object that contains the domains with disabled mail SNI. type: object type: object errors: description: List of errors if the API failed. example: null items: type: string type: - array - 'null' messages: description: List of messages generated by the API. example: - cPanel & WHM always enables mail SNI from now on. items: type: string type: - array - 'null' metadata: properties: {} status: description: '* `1` - Success * `0` - Failed: Check the errors field for more details.' enum: - 0 - 1 example: 1 type: integer warnings: description: List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API. example: null items: type: string type: - array - 'null' type: object type: object description: HTTP Request was successful. summary: Enable SNI mail services for domain tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "uapi --output=jsonpretty \\\n --user=username \\\n SSL \\\n enable_mail_sni \\\n domains='example.com|example1.com|example2.com'\n" - label: URL lang: HTTP source: https://hostname.example.com:2083/cpsess##########/execute/SSL/enable_mail_sni?domains=example.com%7cexample1.com%7cexample2.com - label: LiveAPI Perl lang: Perl source: "#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_enable_mail_sni.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend//\n# to .../frontend//api_examples/SSL_enable_mail_sni.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n q/SSL/,\n q/enable_mail_sni/,\n {\n 'domains' => 'example.com|example1.com|example2.com',\n }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n my $data = $response->{cpanelresult}{result}{data};\n # Do something with the $data\n # So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n # Report errors:\n print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n require JSON;\n my $str = JSON->new->pretty->encode($_[0]);\n return $str;\n}\n" - label: LiveAPI PHP lang: PHP source: " is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_enable_mail_sni.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend//\n// to .../frontend//api_examples/SSL_enable_mail_sni.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n 'SSL',\n 'enable_mail_sni',\n array (\n 'domains' => 'example.com|example1.com|example2.com',\n )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n $data = $response['cpanelresult']['result']['data'];\n // Do something with the $data\n // So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n // Report errors:\n print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n return json_encode($data, JSON_PRETTY_PRINT);\n}" x-cpanel-api-version: UAPI x-cpanel-available-version: cPanel 11.48 servers: - description: A server running cPanel. url: https://{host}:{port}/execute variables: host: default: cpanel-server.tld description: The hostname of a server running cPanel. port: default: '2083' description: The cPanel port. /SSL/fetch_best_for_domain: get: x-readonly: false x-rollback: none description: 'This function retrieves the best-available certificate for the domain. The function also retrieves the certificate''s associated private key and CA bundle, if available. **Important:** When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system **disables** this function.' operationId: SSL-fetch_best_for_domain parameters: - description: The domain name. in: query name: domain required: true schema: example: example.com format: domain type: string responses: '200': content: application/json: schema: properties: apiversion: description: The version of the API. example: 3 type: integer func: description: The name of the method called. example: fetch_best_for_domain type: string module: description: The name of the module called. example: SSL type: string result: properties: data: properties: cab: description: The CA bundle's contents (if applicable). example: REDACTED_CERTIFICATE_EXAMPLE format: pem-certificate type: string crt: description: The certificate's contents. example: REDACTED_CERTIFICATE_EXAMPLE format: pem-certificate type: string crt_origin: description: The username that generated the certificate. example: username format: username type: string domain: description: The domain that generated the private key. example: example.com format: domain type: string ip: description: The IP address. example: 192.168.0.1 format: ipv4 type: string key: description: The private key. example: REDACTED_PRIVATE_KEY_EXAMPLE format: pem-private-key type: string key_origin: description: The username that generated the private key. example: username format: username type: string searched_users: description: The cPanel accounts that the system searched for domain information. items: example: username format: username type: string type: array status: description: 'Whether the certificate is active. * `1` - Active. * `0` - Inactive.' enum: - 0 - 1 example: 1 type: integer statusmsg: description: The certificate's status. example: ok type: string user: description: The username that stores the private key. example: username format: username type: string type: object errors: description: List of errors if the API failed. example: null items: type: string type: - array - 'null' messages: description: List of messages generated by the API. example: null items: type: string type: - array - 'null' metadata: properties: {} status: description: '* `1` - Success. * `0` - Failed. Check the `errors` field for more details.' enum: - 0 - 1 example: 1 type: integer warnings: description: List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API. example: null items: type: string type: - array - 'null' type: object type: object description: HTTP Request was successful. summary: Request best SSL certificate tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "uapi --output=jsonpretty \\\n --user=username \\\n SSL \\\n fetch_best_for_domain \\\n domain='example.com'\n" - label: URL lang: HTTP source: https://hostname.example.com:2083/cpsess##########/execute/SSL/fetch_best_for_domain?domain=example.com - label: LiveAPI Perl lang: Perl source: "#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_fetch_best_for_domain.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend//\n# to .../frontend//api_examples/SSL_fetch_best_for_domain.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n q/SSL/,\n q/fetch_best_for_domain/,\n {\n 'domain' => 'example.com',\n }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n my $data = $response->{cpanelresult}{result}{data};\n # Do something with the $data\n # So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n # Report errors:\n print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n require JSON;\n my $str = JSON->new->pretty->encode($_[0]);\n return $str;\n}\n" - label: LiveAPI PHP lang: PHP source: " is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_fetch_best_for_domain.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend//\n// to .../frontend//api_examples/SSL_fetch_best_for_domain.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n 'SSL',\n 'fetch_best_for_domain',\n array (\n 'domain' => 'example.com',\n )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n $data = $response['cpanelresult']['result']['data'];\n // Do something with the $data\n // So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n // Report errors:\n print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n return json_encode($data, JSON_PRETTY_PRINT);\n}" x-cpanel-api-version: UAPI x-cpanel-available-version: cPanel 11.42 servers: - description: A server running cPanel. url: https://{host}:{port}/execute variables: host: default: cpanel-server.tld description: The hostname of a server running cPanel. port: default: '2083' description: The cPanel port. /SSL/fetch_cert_info: get: x-readonly: false x-rollback: none description: 'This function retrieves all of a certificate''s available information. **Important:** * You **must** call either the `friendly_name` or `id` parameter. * When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system **disables** this function.' operationId: SSL-fetch_cert_info parameters: - description: The certificate's human readable name. in: query name: friendly_name required: true schema: example: TestCert type: string - description: The certificate's ID. in: query name: id required: true schema: example: example_com_cb497_a394d_1397249671_d1272da8f13a1fd837493a5ad1f0a0f3 type: string responses: '200': content: application/json: schema: properties: apiversion: description: The version of the API. example: 3 type: integer func: description: The name of the method called. example: fetch_cert_info type: string module: description: The name of the module called. example: SSL type: string result: properties: data: properties: cabundle: description: The CA bundle's contents (if applicable). example: REDACTED_CERTIFICATE_EXAMPLE format: pem-certificate type: - string - 'null' certificate: description: The certificate's contents. example: REDACTED_CERTIFICATE_EXAMPLE format: pem-certificate type: string is_self_signed: description: 'Whether the certificate is self-signed. * `1` - Self-signed. * `0` - **Not** self-signed.' enum: - 0 - 1 example: 1 type: integer key: description: The private key. example: REDACTED_PRIVATE_KEY_EXAMPLE format: pem-private-key type: string subject.commonName_ip: description: The IP address. example: 192.168.0.1 format: ipv4 type: string type: object errors: description: List of errors if the API failed. example: null items: type: string type: - array - 'null' messages: description: List of messages generated by the API. example: null items: type: string type: - array - 'null' metadata: properties: {} status: description: '* `1` - Success. * `0` - Failed. Check the `errors` field for more details.' enum: - 0 - 1 example: 1 type: integer warnings: description: List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API. example: null items: type: string type: - array - 'null' type: object type: object description: HTTP Request was successful. summary: Return SSL certificate information tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "uapi --output=jsonpretty \\\n --user=username \\\n SSL \\\n fetch_cert_info \\\n id='example_com_cb497_a394d_1397249671_d1272da8f13a1fd837493a5ad1f0a0f3' \\\n friendly_name='TestCert'\n" - label: URL lang: HTTP source: https://hostname.example.com:2083/cpsess##########/execute/SSL/fetch_cert_info?id=example_com_cb497_a394d_1397249671_d1272da8f13a1fd837493a5ad1f0a0f3&friendly_name=TestCert - label: LiveAPI Perl lang: Perl source: "#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_fetch_cert_info.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend//\n# to .../frontend//api_examples/SSL_fetch_cert_info.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n q/SSL/,\n q/fetch_cert_info/,\n {\n 'id' => 'example_com_cb497_a394d_1397249671_d1272da8f13a1fd837493a5ad1f0a0f3',\n 'friendly_name' => 'TestCert',\n }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n my $data = $response->{cpanelresult}{result}{data};\n # Do something with the $data\n # So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n # Report errors:\n print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n require JSON;\n my $str = JSON->new->pretty->encode($_[0]);\n return $str;\n}\n" - label: LiveAPI PHP lang: PHP source: " is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_fetch_cert_info.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend//\n// to .../frontend//api_examples/SSL_fetch_cert_info.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n 'SSL',\n 'fetch_cert_info',\n array (\n 'id' => 'example_com_cb497_a394d_1397249671_d1272da8f13a1fd837493a5ad1f0a0f3',\n 'friendly_name' => 'TestCert',\n )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n $data = $response['cpanelresult']['result']['data'];\n // Do something with the $data\n // So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n // Report errors:\n print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n return json_encode($data, JSON_PRETTY_PRINT);\n}" x-cpanel-api-version: UAPI x-cpanel-available-version: cPanel 11.42 servers: - description: A server running cPanel. url: https://{host}:{port}/execute variables: host: default: cpanel-server.tld description: The hostname of a server running cPanel. port: default: '2083' description: The cPanel port. /SSL/fetch_certificates_for_fqdns: get: x-readonly: false x-rollback: none description: This function retrieves the certificate information for all fully qualified domain names (FQDNs) that the account owns. operationId: SSL-fetch_certificates_for_fqdns parameters: - description: A domain or comma-delimited list of domains for which to retrieve information. examples: multiple: summary: Multiple domains. value: domains=example1.com,example2.com single: summary: A single domain. value: example.com explode: false in: query name: domains required: true schema: type: string style: form responses: '200': content: application/json: schema: properties: apiversion: description: The version of the API. example: 3 type: integer func: description: The name of the method called. example: fetch_certificates_for_fqdns type: string module: description: The name of the module called. example: SSL type: string result: properties: data: items: properties: cab: description: The CA bundle's contents. example: REDACTED_CERTIFICATE_EXAMPLE format: pem-certificate type: string created: description: When the certificate was created. example: 1496950287 format: unix_timestamp type: integer crt: description: The certificate's contents in Base64 PEM format. example: REDACTED_CERTIFICATE_EXAMPLE format: pem-certificate type: string domain_is_configured: description: 'Whether the certificate is installed on the account. * `1` — Installed. * `0` — Not installed.' enum: - 0 - 1 example: 1 type: integer domains: description: The domains that the CSR covers. example: - example.servername.com - example.com - mail.example.com - www.example.com - www.example.servername.com items: type: string type: array ecdsa_curve_name: description: 'The ECDSA curve that the certificate''s key uses. * `prime256v1` * `secp384r1` * `null` — The certificate''s key is **not** an ECDSA key.' enum: - prime256v1 - secp384r1 example: prime256v1 type: - string - 'null' ecdsa_public: description: 'The certificate''s key''s ECDSA compressed public point, in hexadecimal format. * `null` — The certificate''s key is **not** an ECDSA key.' example: null type: - string - 'null' friendly_name: description: The certificate's friendly name. example: Cert for example.servername.com type: string id: description: The certificate's identification. example: example_servername_com_ce52d_6e643_2813308004_119580f9b01960cjones72bc519206bc type: string is_self_signed: description: 'Whether the certificate is self-signed. - `1` — Self-signed. - `0` — Not self-signed.' enum: - 0 - 1 example: 1 type: integer issuer.commonName: description: The name that issued the certificate. example: example.servername.com type: string issuer.organizationName: description: The certificate's organization. example: Organization type: string issuer_text: description: The certificate's issuer information. example: stateOrProvinceName\nTX\nlocalityName\nHouston\ncountryName\nUS\ncommonName\nexample.com\norganizationName\ncPanel type: string key: description: The private key in Base64 PEM format. example: REDACTED_PRIVATE_KEY_EXAMPLE format: pem-private-key type: string key_algorithm: description: 'The certificate''s key''s algorithm. * `rsaEncryption` — RSA. * `id-ecPublicKey` — ECDSA.' enum: - rsaEncryption - id-ecPublicKey example: rsaEncryption type: string modulus: description: 'The length, in bits, of the certificate''s key''s modulus. * `null` — The certificate''s key is **not** an RSA key.' example: 'ce52db786fd2776f69057ed8ee0d8ab267a2f328a66a3afd8 76017a99d061ec5d24d646f80ec258c696cb742e2bcd2fef920177144d9126a4 779c1a21ca5589ff06e673556116903493100dfba385a62d11aeec57f47e5b20 ad8d1142fbe93f003fb62403cdcc0012ccd407009ac21639623bc52a5d6d3814 ff9c45a7c246799f0229b4854af2aeddfa755ab13814132424f5b1680f2c357e 1476af7422bd5863102cfc5982b3ddad7fecdeae5c1cb73789008be9ce2f24fe 27c9202b3bca6524ba29a30972f14cbf06f0a1b7998c2361ed90221f40829faf 644adc7b8da6f948d8745ffbe8e5b6f0c8e7ea9ef2bc26413f90666ef1200407 eab7c3b71c6e643' type: - string - 'null' modulus_length: description: 'The length, in bits, of the certificate''s key''s modulus. * `null` — The certificate''s key is **not** an RSA key.' example: 2048 minimum: 1 type: - integer - 'null' not_after: description: When the certificate expired. example: 1528486286 format: unix_timestamp type: integer not_before: description: When the certificate started. example: 1496950286 format: unix_timestamp type: integer serial: description: The certificate's serial number. example: 01e57e4d92 type: string signature_algorithm: description: The OID of the hash algorithm used to sign the certificate request. example: sha256WithRSAEncryption type: string subject.commonName: description: The certificate's common name. example: example.servername.com format: domain type: string subject_text: description: The certificate's subject text information. example: stateOrProvinceName\nTX\nlocalityName\nHouston\ncountryName\nUS\ncommonName\nexample.com\norganizationName\ncPanel type: string validation_type: description: 'The certificate''s validation type. * `ev` — Extended Validation. * `ov` — Organization Validated. * `dv` — Domain Validated. * `null` — The system could not parse and determine the certificate''s validation type.' example: dv type: string verify_error: description: A message that explains the reason for a verification error. example: DEPTH_ZERO_SELF_SIGNED_CERT type: string type: object type: array errors: description: List of errors if the API failed. example: null items: type: string type: - array - 'null' messages: description: List of messages generated by the API. example: null items: type: string type: - array - 'null' metadata: properties: transformed: description: Post-processing may have transformed the data. enum: - 1 example: 1 type: integer status: description: '- `1` — Success. - `0` — Failed. Check the `errors` field for more details.' enum: - 0 - 1 example: 1 type: integer warnings: description: List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API. example: null items: type: string type: - array - 'null' type: object type: object description: HTTP Request was successful. summary: Return SSL certificate information for all FQDN tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "uapi --output=jsonpretty \\\n --user=username \\\n SSL \\\n fetch_certificates_for_fqdns \\\n domains='example.com'\n" - label: URL lang: HTTP source: https://hostname.example.com:2083/cpsess##########/execute/SSL/fetch_certificates_for_fqdns?domains=example.com - label: LiveAPI Perl lang: Perl source: "#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_fetch_certificates_for_fqdns.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend//\n# to .../frontend//api_examples/SSL_fetch_certificates_for_fqdns.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n q/SSL/,\n q/fetch_certificates_for_fqdns/,\n {\n 'domains' => 'example.com',\n }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n my $data = $response->{cpanelresult}{result}{data};\n foreach my $item (@{$data}) {\n # Do something with the $item\n }\n\n # So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n # Report errors:\n print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n require JSON;\n my $str = JSON->new->pretty->encode($_[0]);\n return $str;\n}\n" - label: LiveAPI PHP lang: PHP source: " is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_fetch_certificates_for_fqdns.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend//\n// to .../frontend//api_examples/SSL_fetch_certificates_for_fqdns.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n 'SSL',\n 'fetch_certificates_for_fqdns',\n array (\n 'domains' => 'example.com',\n )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n $data = $response['cpanelresult']['result']['data'];\n foreach ($data as $item) {\n // Do something with the $item\n }\n\n // So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n // Report errors:\n print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n return json_encode($data, JSON_PRETTY_PRINT);\n}" x-cpanel-api-version: UAPI x-cpanel-available-version: cPanel 66 servers: - description: A server running cPanel. url: https://{host}:{port}/execute variables: host: default: cpanel-server.tld description: The hostname of a server running cPanel. port: default: '2083' description: The cPanel port. /SSL/fetch_key_and_cabundle_for_certificate: post: x-readonly: false x-rollback: none description: 'This function extracts the private key and CA bundle information from a certificate. **Note:** Due to the limited field length of `HTTP GET` method calls, you **must** use the `HTTP POST` method. For this reason, you **cannot** use a cPanel or Webmail session URL to call this function.' operationId: SSL-fetch_key_and_cabundle_for_certificate parameters: - description: An SSL certificate. in: query name: certificate required: true schema: example: REDACTED_CERTIFICATE_EXAMPLE format: pem-certificate type: string requestBody: content: multipart/form-data: schema: properties: certificate: description: The certificate file. format: pem-certificate type: string type: object description: The certificate's contents. responses: '200': content: application/json: schema: properties: apiversion: description: The version of the API. example: 3 type: integer func: description: The name of the method called. example: fetch_key_and_cabundle_for_certificate type: string module: description: The name of the module called. example: SSL type: string result: properties: data: properties: cab: description: The CA bundle's contents (if applicable). example: REDACTED_CERTIFICATE_EXAMPLE format: pem-certificate type: string crt: description: The certificate's contents. example: REDACTED_CERTIFICATE_EXAMPLE format: pem-certificate type: string crt_origin: description: The username that generated the certificate. example: username format: username type: string domain: description: The domain that generated the private key. example: example.com format: domain type: string ip: description: The IP address. example: 192.168.0.1 format: ipv4 type: string key: description: The private key. example: REDACTED_PRIVATE_KEY_EXAMPLE format: pem-private-key type: string key_origin: description: The username that generated the private key. example: username format: username type: string searched_users: description: The users that the system searched for certificate information. items: example: username format: username type: string type: array status: description: 'Whether the certificate is active. * `1` - Active. * `0` - Inactive.' enum: - 0 - 1 example: 1 type: integer statusmsg: description: The certificate's status. example: ok type: string user: description: The username that stores the private key. example: username format: username type: string type: object errors: description: List of errors if the API failed. example: null items: type: string type: - array - 'null' messages: description: List of messages generated by the API. example: null items: type: string type: - array - 'null' metadata: properties: {} status: description: '* `1` - Success. * `0` - Failed. Check the `errors` field for more details.' enum: - 0 - 1 example: 1 type: integer warnings: description: List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API. example: null items: type: string type: - array - 'null' type: object type: object description: HTTP Request was successful. summary: Return private key and CA bundle tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "uapi --input=json --output=jsonpretty \\\n --user=username \\\n SSL \\\n fetch_key_and_cabundle_for_certificate\n" - label: HTTP Request (Wire Format) lang: HTTP source: 'POST /cpsess##########/execute/SSL/fetch_key_and_cabundle_for_certificate HTTP/1.1 Host: example.com:2083 Cookie: ################################### Content-Type: application/json Content-Length: 0 ' x-cpanel-api-version: UAPI x-cpanel-available-version: cPanel 11.42 servers: - description: A server running cPanel. url: https://{host}:{port}/execute variables: host: default: cpanel-server.tld description: The hostname of a server running cPanel. port: default: '2083' description: The cPanel port. /SSL/find_certificates_for_key: get: x-readonly: false x-rollback: none description: 'This function retrieves SSL certificates for a private key. **Note:** When you call this function, you **must** include either the `id` **or** the `friendly_name` parameter.' operationId: SSL-find_certificates_for_key parameters: - description: The key's friendly name. in: query name: friendly_name required: false schema: example: TestKey type: string - description: The key's ID. in: query name: id required: false schema: example: example_com_cb497_a394d_1397249671_d1272da8f13a1fd837493a5ad1f0a0f3 type: string responses: '200': content: application/json: schema: properties: apiversion: description: The version of the API. example: 3 type: integer func: description: The name of the method called. example: find_certificates_for_key type: string module: description: The name of the module called. example: SSL type: string result: properties: data: items: properties: created: description: The date the certificate was created. example: 1538308800 format: unix_timestamp type: integer domains: description: A list of the domains that the certificate covers. items: example: example.com format: domain type: string type: array ecdsa_curve_name: description: 'The ECDSA curve that the certificate''s key uses. * `prime256v1` * `secp384r1` * `null` — The certificate''s key is **not** an ECDSA key.' enum: - prime256v1 - secp384r1 example: prime256v1 type: - string - 'null' ecdsa_public: description: 'The certificate''s key''s ECDSA compressed public point, in hexadecimal format. * `null` — The certificate''s key is **not** an ECDSA key.' example: null type: - string - 'null' friendly_name: description: The certificate's friendly name. example: TestCert type: string id: description: The certificate's ID. example: example_com_a74f7_9dddf_1446659822_eae1ff43c4ec1991e195877c55755eff type: string is_self_signed: description: 'Whether the certificate is self-signed. * `1` — Self-signed. * `0` — Not self-signed.' enum: - 1 - 0 example: 1 type: integer issuer.commonName: description: The name that issued the certificate. example: example.com type: string issuer.organizationName: description: The certificate's organization name. example: The Example Organization type: string issuer_text: description: The certificate's issuer information. example: 'countryName US commonNamexample.com localityName Houston organizationName cPanel stateOrProvinceName tx' type: string key_algorithm: description: 'The certificate''s key''s algorithm. * `rsaEncryption` — RSA. * `id-ecPublicKey` — ECDSA.' enum: - rsaEncryption - id-ecPublicKey example: rsaEncryption type: string modulus: description: 'The certificate''s key''s modulus, in hexadecimal format. * `null` — The certificate''s key is **not** an RSA key.' example: a673c3b17344664b35f8791f562d3aea6bf4d8faa3ae3fc0a519380fd453964a36677c34d48677ecb7f5ed035df026f5f0f8fbfe21745e52daf1f3b9e58c73f0baefdb709320e2202e7d05250b051a59b30ff1fef22d83d7140c1c81cea314a0890ce8d2226799872181c58a74016c7aaa2cff5ac72b575cecde8f304aa572a2ea03d8b173ab76c6e8cdb9dfd0da81e1119cefd4b8b4dbfbe0e46c7f1ee2fe8b5fd5504e58ccbc0d13b4fa41ecc9ebd0dabe1d1fec5c724f748167e7c0553e997f9b77eb36abce70973f06df151748d41b758de3efd7afa6f2464a1547f5ff158469d96e248be464df9eda0e7ce854a89332a2c1278b17c425368a9604f454db type: - string - 'null' modulus_length: description: 'The length, in bits, of the certificate''s key''s modulus. * `null` — The certificate''s key is **not** an RSA key.' example: 2048 type: - integer - 'null' not_after: description: The date the certificate expired. example: 1569844800 format: unix_timestamp type: integer not_before: description: The date the certificate started. example: 1538308800 format: unix_timestamp type: integer signature_algorithm: description: The certificate's signature OID hash algorithm. example: sha256WithRSAEncryption type: string subject.commonName: description: The certificate's Common Name. example: example.com type: string subject_text: description: The certificate's subject text information. example: 'countryName US commonNamexample.com localityName Houston organizationName cPanel stateOrProvinceName tx' type: string validation_type: description: 'The certificate''s validation type. * `ev` — Extended Validation. * `ov` — Organization Validation. * `dv` — Domain Validation. * `null` — The system could not parse and determine the certificate''s validation type.' enum: - ev - ov - dv example: dv type: - string - 'null' type: object type: array errors: description: List of errors if the API failed. example: null items: type: string type: - array - 'null' messages: description: List of messages generated by the API. example: null items: type: string type: - array - 'null' metadata: properties: transformed: description: Post-processing may have transformed the data. enum: - 1 example: 1 type: integer status: description: '* `1` — Success. * `0` — Failed. Check the `errors` field for more details.' enum: - 1 - 0 example: 1 type: integer warnings: description: List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API. example: null items: type: string type: - array - 'null' type: object type: object description: HTTP Request was successful. summary: Return SSL certificate for private key tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "uapi --output=jsonpretty \\\n --user=username \\\n SSL \\\n find_certificates_for_key\n" - label: URL lang: HTTP source: https://hostname.example.com:2083/cpsess##########/execute/SSL/find_certificates_for_key - label: LiveAPI Perl lang: Perl source: "#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_find_certificates_for_key.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend//\n# to .../frontend//api_examples/SSL_find_certificates_for_key.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n q/SSL/,\n q/find_certificates_for_key/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n my $data = $response->{cpanelresult}{result}{data};\n foreach my $item (@{$data}) {\n # Do something with the $item\n }\n\n # So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n # Report errors:\n print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n require JSON;\n my $str = JSON->new->pretty->encode($_[0]);\n return $str;\n}\n" - label: LiveAPI PHP lang: PHP source: " is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_find_certificates_for_key.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend//\n// to .../frontend//api_examples/SSL_find_certificates_for_key.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n 'SSL',\n 'find_certificates_for_key'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n $data = $response['cpanelresult']['result']['data'];\n foreach ($data as $item) {\n // Do something with the $item\n }\n\n // So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n // Report errors:\n print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n return json_encode($data, JSON_PRETTY_PRINT);\n}" x-cpanel-api-version: UAPI x-cpanel-available-version: cPanel 11.42 servers: - description: A server running cPanel. url: https://{host}:{port}/execute variables: host: default: cpanel-server.tld description: The hostname of a server running cPanel. port: default: '2083' description: The cPanel port. /SSL/find_csrs_for_key: get: x-readonly: false x-rollback: none description: 'This function retrieves certificate signing requests (CSR) for a private key. **Note:** When you call this function, you **must** include either the `id` or the `friendly_name` parameter.' operationId: SSL-find_csrs_for_key parameters: - description: The key's friendly name. in: query name: friendly_name required: false schema: example: TestKey type: string - description: The key's ID. in: query name: id required: false schema: example: example_com_cb497_a394d_1397249671_d1272da8f13a1fd837493a5ad1f0a0f3 type: string responses: '200': content: application/json: schema: properties: apiversion: description: The version of the API. example: 3 type: integer func: description: The name of the method called. example: find_csrs_for_key type: string module: description: The name of the module called. example: SSL type: string result: properties: data: items: properties: commonName: description: The CSR's common name. example: example.com format: domain type: string created: description: The date the CSR was created. example: 1538265600 format: unix_timestamp type: integer domains: description: A list of the domains that the CSR covers. items: example: example.com format: domain type: string type: array ecdsa_curve_name: description: 'The ECDSA curve that the CSR''s key uses. * `prime256v1` * `secp384r1` * `null` — The CSR''s key is **not** an ECDSA key.' enum: - prime256v1 - secp384r1 example: prime256v1 type: - string - 'null' ecdsa_public: description: 'The CSR''s key''s ECDSA compressed public point, in hexadecimal format. * `null` — The CSR''s key is **not** an ECDSA key.' example: null type: - string - 'null' friendly_name: description: The CSR's friendly name. example: TestCSR type: string id: description: The CSR's ID. example: example_com_a74f7_9dddf_2c5d1615e85db817d6b640f65335fb62 type: string key_algorithm: description: 'The CSR''s key''s algorithm. * `rsaEncryption` — RSA. * `id-ecPublicKey` — ECDSA.' enum: - rsaEncryption - id-ecPublicKey example: rsaEncryption type: string modulus: description: 'The CSR''s key''s modulus, in hexadecimal format. * `null` — The CSR''s key is **not** an RSA key.' example: a673c3b17344664b35f8791f562d3aea6bf4d8faa3ae3fc0a519380fd453964a36677c34d48677ecb7f5ed035df026f5f0f8fbfe21745e52daf1f3b9e58c73f0baefdb709320e2202e7d05250b051a59b30ff1fef22d83d7140c1c81cea314a0890ce8d2226799872181c58a74016c7aaa2cff5ac72b575cecde8f304aa572a2ea03d8b173ab76c6e8cdb9dfd0da81e1119cefd4b8b4dbfbe0e46c7f1ee2fe8b5fd5504e58ccbc0d13b4fa41ecc9ebd0dabe1d1fec5c724f748167e7c0553e997f9b77eb36abce70973f06df151748d41b758de3efd7afa6f2464a1547f5ff158469d96e248be464df9eda0e7ce854a89332a2c1278b17c425368a9604f454db type: - string - 'null' type: object type: array errors: description: List of errors if the API failed. example: null items: type: string type: - array - 'null' messages: description: List of messages generated by the API. example: null items: type: string type: - array - 'null' metadata: properties: transformed: description: Post-processing may have transformed the data. enum: - 1 example: 1 type: integer status: description: '* `1` — Success. * `0` — Failed. Check the `errors` field for more details.' enum: - 1 - 0 example: 1 type: integer warnings: description: List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API. example: null items: type: string type: - array - 'null' type: object type: object description: HTTP Request was successful. summary: Return private key's certificate signing requests tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "uapi --output=jsonpretty \\\n --user=username \\\n SSL \\\n find_csrs_for_key\n" - label: URL lang: HTTP source: https://hostname.example.com:2083/cpsess##########/execute/SSL/find_csrs_for_key - label: LiveAPI Perl lang: Perl source: "#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_find_csrs_for_key.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend//\n# to .../frontend//api_examples/SSL_find_csrs_for_key.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n q/SSL/,\n q/find_csrs_for_key/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n my $data = $response->{cpanelresult}{result}{data};\n foreach my $item (@{$data}) {\n # Do something with the $item\n }\n\n # So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n # Report errors:\n print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n require JSON;\n my $str = JSON->new->pretty->encode($_[0]);\n return $str;\n}\n" - label: LiveAPI PHP lang: PHP source: " is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_find_csrs_for_key.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend//\n// to .../frontend//api_examples/SSL_find_csrs_for_key.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n 'SSL',\n 'find_csrs_for_key'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n $data = $response['cpanelresult']['result']['data'];\n foreach ($data as $item) {\n // Do something with the $item\n }\n\n // So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n // Report errors:\n print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n return json_encode($data, JSON_PRETTY_PRINT);\n}" x-cpanel-api-version: UAPI x-cpanel-available-version: cPanel 11.42 servers: - description: A server running cPanel. url: https://{host}:{port}/execute variables: host: default: cpanel-server.tld description: The hostname of a server running cPanel. port: default: '2083' description: The cPanel port. /SSL/generate_cert: get: x-readonly: false x-rollback: none description: 'This function generates a self-signed SSL certificate. **Important:** When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system **disables** this function.' operationId: SSL-generate_cert parameters: - description: The two-letter country code. in: query name: countryName required: true schema: example: US format: ISO-3166-1 (alpha-2) type: string - description: A comma-separated list of domains for which to generate the certificate. examples: multiple: summary: Generate certificates for multiple domains. value: domains=example1.com,example2.com,example3.com single: summary: Generate a certificate for a domain. value: example.com in: query name: domains required: true schema: format: domain type: string - description: The key's ID. in: query name: key_id required: true schema: example: example_com_cb497_a394d_1397249671_d1272da8f13a1fd837493a5ad1f0a0f3 type: string - description: The certificate's city or locality name. in: query name: localityName required: true schema: example: Houston type: string - description: The certificate's Organization Name. in: query name: organizationName required: true schema: example: Organization type: string - description: The two-letter state or locality abbreviation. in: query name: stateOrProvinceName required: true schema: example: TX type: string - description: An email address to associate with the certificate. in: query name: emailAddress required: false schema: example: username@example.com format: email type: string - description: 'A friendly name for the new certificate. This parameter defaults to the domain''s name for which you generated the certificate.' in: query name: friendly_name required: false schema: example: TestCert type: string - description: The certificate's organizational unit or department name. in: query name: organizationalUnitName required: false schema: default: '' example: Department type: string responses: '200': content: application/json: schema: properties: apiversion: description: The version of the API. example: 3 type: integer func: description: The name of the method called. example: generate_cert type: string module: description: The name of the module called. example: SSL type: string result: properties: data: properties: created: description: The certificate's creation date. example: 1538308800 format: unix_timestamp type: integer domains: description: A list of domains that the certificate covers. items: example: example.com format: domain type: string type: array ecdsa_curve_name: description: 'The ECDSA curve that the certificate''s key uses. * `prime256v1` * `secp384r1` * `null` — The certificate''s key is **not** an ECDSA key.' enum: - prime256v1 - secp384r1 example: prime256v1 type: - string - 'null' ecdsa_public: description: 'The certificate''s key''s ECDSA compressed public point, in hexadecimal format. * null — The certificate''s key is **not** an ECDSA key.' example: null type: - string - 'null' friendly_name: description: The certificate's friendly name. example: TestCert type: string id: description: The certificate's ID. example: example_com_a74f7_9dddf_1446659822_eae1ff43c4ec1991e195877c55755eff type: string is_self_signed: description: 'Whether the certificate is self-signed. * `1` — Self-signed. * `0` — Not self-signed.' enum: - 1 - 0 example: 1 type: integer issuer.commonName: description: The certificate's Common Name. example: example.com type: string issuer.organizationName: description: The certificate's Organization Name. example: Organization type: string key_algorithm: description: 'The certificate''s key''s algorithm. * `rsaEncryption` — RSA. * `id-ecPublicKey` — ECDSA.' enum: - rsaEncryption - id-ecPublicKey example: rsaEncryption type: string modulus: description: 'The certificate''s key''s modulus, in hexadecimal format. * `null` — The certificate''s key is **not** an RSA key.' example: a673c3b17344664b35f8791f562d3aea6bf4d8faa3ae3fc0a519380fd453964a36677c34d48677ecb7f5ed035df026f5f0f8fbfe21745e52daf1f3b9e58c73f0baefdb709320e2202e7d05250b051a59b30ff1fef22d83d7140c1c81cea314a0890ce8d2226799872181c58a74016c7aaa2cff5ac72b575cecde8f304aa572a2ea03d8b173ab76c6e8cdb9dfd0da81e1119cefd4b8b4dbfbe0e46c7f1ee2fe8b5fd5504e58ccbc0d13b4fa41ecc9ebd0dabe1d1fec5c724f748167e7c0553e997f9b77eb36abce70973f06df151748d41b758de3efd7afa6f2464a1547f5ff158469d96e248be464df9eda0e7ce854a89332a2c1278b17c425368a9604f454db type: - string - 'null' modulus_length: description: 'The length, in bits, of the certificate''s key''s modulus. * `null` — The certificate''s key is **not** an RSA key.' example: 2048 type: - integer - 'null' not_after: description: The date that the certificate expires. example: 1569844800 format: unix_timestamp type: integer not_before: description: The certificate's start date. example: 1538308800 format: unix_timestamp type: integer serial: description: The certificate's serial number. example: 01e57e4d92 type: string signature_algorithm: description: The certificate's OID hash algorithm signature. example: sha256WithRSAEncryption type: string subject.commonName: description: The domain that issued the certificate. example: example.com format: domain type: string text: description: The certificate's text. example: REDACTED_CERTIFICATE_EXAMPLE format: pem-certificate type: string validation_type: description: The certificate's validation type, if one exists. example: null type: - string - 'null' type: object errors: description: List of errors if the API failed. example: null items: type: string type: - array - 'null' messages: description: List of messages generated by the API. items: example: Certificate generated type: string type: - array - 'null' metadata: properties: {} status: description: '* `1` — Success. * `0` — Failed. Check the `errors` field for more details.' enum: - 1 - 0 example: 1 type: integer warnings: description: List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API. example: null items: type: string type: - array - 'null' type: object type: object description: HTTP Request was successful. summary: Create self-signed SSL certificate tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "uapi --output=jsonpretty \\\n --user=username \\\n SSL \\\n generate_cert \\\n domains='example.com' \\\n countryName='US' \\\n stateOrProvinceName='TX' \\\n localityName='Houston' \\\n organizationName='Organization' \\\n key_id='example_com_cb497_a394d_1397249671_d1272da8f13a1fd837493a5ad1f0a0f3'\n" - label: URL lang: HTTP source: https://hostname.example.com:2083/cpsess##########/execute/SSL/generate_cert?domains=example.com&countryName=US&stateOrProvinceName=TX&localityName=Houston&organizationName=Organization&key_id=example_com_cb497_a394d_1397249671_d1272da8f13a1fd837493a5ad1f0a0f3 - label: LiveAPI Perl lang: Perl source: "#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_generate_cert.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend//\n# to .../frontend//api_examples/SSL_generate_cert.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n q/SSL/,\n q/generate_cert/,\n {\n 'domains' => 'example.com',\n 'countryName' => 'US',\n 'stateOrProvinceName' => 'TX',\n 'localityName' => 'Houston',\n 'organizationName' => 'Organization',\n 'key_id' => 'example_com_cb497_a394d_1397249671_d1272da8f13a1fd837493a5ad1f0a0f3',\n }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n my $data = $response->{cpanelresult}{result}{data};\n # Do something with the $data\n # So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n # Report errors:\n print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n require JSON;\n my $str = JSON->new->pretty->encode($_[0]);\n return $str;\n}\n" - label: LiveAPI PHP lang: PHP source: " is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_generate_cert.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend//\n// to .../frontend//api_examples/SSL_generate_cert.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n 'SSL',\n 'generate_cert',\n array (\n 'domains' => 'example.com',\n 'countryName' => 'US',\n 'stateOrProvinceName' => 'TX',\n 'localityName' => 'Houston',\n 'organizationName' => 'Organization',\n 'key_id' => 'example_com_cb497_a394d_1397249671_d1272da8f13a1fd837493a5ad1f0a0f3',\n )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n $data = $response['cpanelresult']['result']['data'];\n // Do something with the $data\n // So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n // Report errors:\n print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n return json_encode($data, JSON_PRETTY_PRINT);\n}" x-cpanel-api-version: UAPI x-cpanel-available-version: cPanel 11.42 servers: - description: A server running cPanel. url: https://{host}:{port}/execute variables: host: default: cpanel-server.tld description: The hostname of a server running cPanel. port: default: '2083' description: The cPanel port. /SSL/generate_csr: get: x-readonly: false x-rollback: none description: 'This function generates a certificate signing request (CSR). **Note:** This function **requires** a valid key in the account''s `ssl` directory. You can generate a key with UAPI''s `SSL::generate_key` function. **Important:** When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and WebServer roles, the system **disables** this function.' operationId: SSL-generate_csr parameters: - description: The two-letter country code. in: query name: countryName required: true schema: example: US format: ISO-3166-1 (alpha-2) type: string - description: A comma-separated list of the domains for which to generate the certificate. examples: multiple: summary: Generate a certificate for multiple domains. value: domains=example-1.com,example-1.com,example-2.com single: summary: Generate a certificate for a single domain. value: example.com in: query name: domains required: true schema: type: string - description: The key's ID. in: query name: key_id required: true schema: example: example_com_cb497_a394d_1397249671_d1272da8f13a1fd837493a5ad1f0a0f3 type: string - description: The certificate's city or locality name. in: query name: localityName required: true schema: example: Houston type: string - description: The certificate's organization. in: query name: organizationName required: true schema: example: Organization type: string - description: The certificate's state or locality name. in: query name: stateOrProvinceName required: true schema: example: Texas type: string - description: An email address to associate with the certificate. in: query name: emailAddress required: false schema: example: username@example.com format: email type: string - description: 'A friendly name for the new certificate. This parameter defaults to the domain name for which you generated the certificate.' in: query name: friendly_name required: false schema: example: TestCert type: string - description: The certificate's organizational unit or department name. in: query name: organizationalUnitName required: false schema: default: '' example: Department type: string responses: '200': content: application/json: schema: properties: apiversion: description: The version of the API. example: 3 type: integer func: description: The name of the method called. example: generate_csr type: string module: description: The name of the module called. example: SSL type: string result: properties: data: properties: commonName: description: The name that issued the CSR. example: example.com type: string created: description: The date the CSR was created. example: 1569884400 format: unix_timestamp type: integer domains: description: The domains that the CSR covers. items: example: example.com format: domain type: string type: array ecdsa_curve_name: description: 'The ECDSA curve that the CSR''s key uses. * `prime256v1` * `secp384r1` * `null` — The CSR''s key is **not** an ECDSA key.' enum: - prime256v1 - secp384r1 example: prime256v1 type: - string - 'null' ecdsa_public: description: 'The CSR''s key''s ECDSA compressed public point, in hexadecimal format. * `null` — The CSR''s key is **not** an ECDSA key.' example: null type: - string - 'null' friendly_name: description: The CSR's friendly name. example: TestCSR type: string id: description: The CSR's ID. example: example_com_a74f7_9dddf_1446659822_eae1ff43c4ec1991e195877c55755eff type: string key_algorithm: description: 'The CSR''s key''s algorithm. * `rsaEncryption` — RSA. * `id-ecPublicKey` — ECDSA.' enum: - rsaEncryption - id-ecPublicKey example: rsaEncryption type: string modulus: description: 'The CSR''s key''s modulus, in hexadecimal format. * `null` — The CSR''s key is **not** an RSA key.' example: a673c3b17344664b35f8791f562d3aea6bf4d8faa3ae3fc0a519380fd453964a36677c34d48677ecb7f5ed035df026f5f0f8fbfe21745e52daf1f3b9e58c73f0baefdb709320e2202e7d05250b051a59b30ff1fef22d83d7140c1c81cea314a0890ce8d2226799872181c58a74016c7aaa2cff5ac72b575cecde8f304aa572a2ea03d8b173ab76c6e8cdb9dfd0da81e1119cefd4b8b4dbfbe0e46c7f1ee2fe8b5fd5504e58ccbc0d13b4fa41ecc9ebd0dabe1d1fec5c724f748167e7c0553e997f9b77eb36abce70973f06df151748d41b758de3efd7afa6f2464a1547f5ff158469d96e248be464df9eda0e7ce854a89332a2c1278b17c425368a9604f454db type: - string - 'null' text: description: The CSR's text. example: REDACTED_CERTIFICATE_EXAMPLE format: pem-certificate-request type: string type: object errors: description: List of errors if the API failed. example: null items: type: string type: - array - 'null' messages: description: List of messages generated by the API. example: - Certificate Signing Request generated! items: type: string type: - array - 'null' metadata: properties: {} status: description: '* `1` — Success. * `0` — Failed. Check the `errors` field for more details.' enum: - 1 - 0 example: 1 type: integer warnings: description: List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API. example: null items: type: string type: - array - 'null' type: object type: object description: HTTP Request was successful. summary: Create certificate signing request tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "uapi --output=jsonpretty \\\n --user=username \\\n SSL \\\n generate_csr \\\n domains='example.com' \\\n countryName='US' \\\n stateOrProvinceName='Texas' \\\n localityName='Houston' \\\n organizationName='Organization' \\\n key_id='example_com_cb497_a394d_1397249671_d1272da8f13a1fd837493a5ad1f0a0f3'\n" - label: URL lang: HTTP source: https://hostname.example.com:2083/cpsess##########/execute/SSL/generate_csr?domains=example.com&countryName=US&stateOrProvinceName=Texas&localityName=Houston&organizationName=Organization&key_id=example_com_cb497_a394d_1397249671_d1272da8f13a1fd837493a5ad1f0a0f3 - label: LiveAPI Perl lang: Perl source: "#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_generate_csr.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend//\n# to .../frontend//api_examples/SSL_generate_csr.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n q/SSL/,\n q/generate_csr/,\n {\n 'domains' => 'example.com',\n 'countryName' => 'US',\n 'stateOrProvinceName' => 'Texas',\n 'localityName' => 'Houston',\n 'organizationName' => 'Organization',\n 'key_id' => 'example_com_cb497_a394d_1397249671_d1272da8f13a1fd837493a5ad1f0a0f3',\n }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n my $data = $response->{cpanelresult}{result}{data};\n # Do something with the $data\n # So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n # Report errors:\n print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n require JSON;\n my $str = JSON->new->pretty->encode($_[0]);\n return $str;\n}\n" - label: LiveAPI PHP lang: PHP source: " is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_generate_csr.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend//\n// to .../frontend//api_examples/SSL_generate_csr.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n 'SSL',\n 'generate_csr',\n array (\n 'domains' => 'example.com',\n 'countryName' => 'US',\n 'stateOrProvinceName' => 'Texas',\n 'localityName' => 'Houston',\n 'organizationName' => 'Organization',\n 'key_id' => 'example_com_cb497_a394d_1397249671_d1272da8f13a1fd837493a5ad1f0a0f3',\n )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n $data = $response['cpanelresult']['result']['data'];\n // Do something with the $data\n // So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n // Report errors:\n print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n return json_encode($data, JSON_PRETTY_PRINT);\n}" x-cpanel-api-version: UAPI x-cpanel-available-version: cPanel 11.42 servers: - description: A server running cPanel. url: https://{host}:{port}/execute variables: host: default: cpanel-server.tld description: The hostname of a server running cPanel. port: default: '2083' description: The cPanel port. /SSL/generate_key: get: x-readonly: false x-rollback: none description: 'This function generates a private key. **Important:** * You **cannot** call both the `keytype` and `keysize` parameters in a single call. * When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, **and** Web Server roles, the system **disables** this function.' operationId: SSL-generate_key parameters: - description: 'A friendly name for the new key. This parameter defaults to the key''s type, creation date, and creation time.' in: query name: friendly_name required: false schema: example: TestKey type: string - deprecated: true description: 'The key''s modulus size. **Note:** Use the `keytype` parameter.' in: query name: keysize required: false schema: default: 2048 example: 2048 type: integer - description: 'The key''s type. * `system` — The system''s default value. * `rsa-2048` — 2,408-bit RSA. * `rsa-4096` — 4,096-bit RSA. * `ecdsa-prime256v1` — ECDSA prime256v1 ("P-256"). * `ecdsa-secp384r1` — ECDSA secp384r1 ("P-384"). This parameter defaults to the user''s [default SSL/TLS key type](https://go.cpanel.net/cpaneldocsSSLTLS#default-ssl-tls-key-type). **Note:** If you do **not** use this parameter, the system defaults to the `keysize` parameter''s default value.' in: query name: keytype required: false schema: enum: - system - rsa-2048 - rsa-4096 - ecdsa-prime256v1 - ecdsa-secp384r1 example: rsa-2048 type: string responses: '200': content: application/json: schema: properties: apiversion: description: The version of the API. example: 3 type: integer func: description: The name of the method called. example: generate_key type: string module: description: The name of the module called. example: SSL type: string result: properties: data: properties: created: description: The key's creation date. example: 1601467200 format: unix_timestamp type: integer ecdsa_curve_name: description: 'The ECDSA curve that the key uses. * `prime256v1` * `secp384r1` * `null` — The key is **not** an ECDSA key.' enum: - prime256v1 - secp384r1 example: prime256v1 type: - string - 'null' ecdsa_public: description: 'The key''s ECDSA compressed public point, in hexadecimal format. * `null` — The key is **not** an ECDSA key.' example: null type: - string - 'null' friendly_name: description: The key's friendly name. example: TestKey type: string id: description: The key's ID. example: example_com_a74f7_9dddf_1446659822_eae1ff43c4ec1991e195877c55755eff type: string key_algorithm: description: 'The key''s algorithm. * `rsaEncryption` — RSA. * `id-ecPublicKey` — ECDSA.' enum: - rsaEncryption - id-ecPublicKey example: rsaEncryption type: string modulus: description: 'The key''s modulus, in hexadecimal format. * `null` — The key is **not** an RSA key.' example: a673c3b17344664b35f8791f562d3aea6bf4d8faa3ae3fc0a519380fd453964a36677c34d48677ecb7f5ed035df026f5f0f8fbfe21745e52daf1f3b9e58c73f0baefdb709320e2202e7d05250b051a59b30ff1fef22d83d7140c1c81cea314a0890ce8d2226799872181c58a74016c7aaa2cff5ac72b575cecde8f304aa572a2ea03d8b173ab76c6e8cdb9dfd0da81e1119cefd4b8b4dbfbe0e46c7f1ee2fe8b5fd5504e58ccbc0d13b4fa41ecc9ebd0dabe1d1fec5c724f748167e7c0553e997f9b77eb36abce70973f06df151748d41b758de3efd7afa6f2464a1547f5ff158469d96e248be464df9eda0e7ce854a89332a2c1278b17c425368a9604f454db type: - string - 'null' modulus_length: description: 'The length, in bits, of the key''s modulus. * `null` — The key is **not** an RSA key.' example: 2048 type: - integer - 'null' text: description: The key's contents. example: REDACTED_PRIVATE_KEY_EXAMPLE format: pem-private-key type: string type: object errors: description: List of errors if the API failed. example: null items: type: string type: - array - 'null' messages: description: List of messages generated by the API. example: null items: type: string type: - array - 'null' metadata: properties: {} status: description: '* `1` — Success. * `0` — Failed. Check the errors field for more details.' enum: - 1 - 0 example: 1 type: integer warnings: description: List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API. example: null items: type: string type: - array - 'null' type: object type: object description: HTTP Request was successful. summary: Create private key tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "uapi --output=jsonpretty \\\n --user=username \\\n SSL \\\n generate_key\n" - label: URL lang: HTTP source: https://hostname.example.com:2083/cpsess##########/execute/SSL/generate_key - label: LiveAPI Perl lang: Perl source: "#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_generate_key.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend//\n# to .../frontend//api_examples/SSL_generate_key.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n q/SSL/,\n q/generate_key/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n my $data = $response->{cpanelresult}{result}{data};\n # Do something with the $data\n # So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n # Report errors:\n print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n require JSON;\n my $str = JSON->new->pretty->encode($_[0]);\n return $str;\n}\n" - label: LiveAPI PHP lang: PHP source: " is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_generate_key.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend//\n// to .../frontend//api_examples/SSL_generate_key.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n 'SSL',\n 'generate_key'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n $data = $response['cpanelresult']['result']['data'];\n // Do something with the $data\n // So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n // Report errors:\n print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n return json_encode($data, JSON_PRETTY_PRINT);\n}" x-cpanel-api-version: UAPI x-cpanel-available-version: cPanel 11.42 servers: - description: A server running cPanel. url: https://{host}:{port}/execute variables: host: default: cpanel-server.tld description: The hostname of a server running cPanel. port: default: '2083' description: The cPanel port. /SSL/get_autossl_excluded_domains: get: x-readonly: true description: This function lists the domains with AutoSSL disabled. operationId: SSL-get_autossl_excluded_domains parameters: [] responses: '200': content: application/json: schema: properties: apiversion: description: The version of the API. example: 3 type: integer func: description: The name of the method called. example: get_autossl_excluded_domains type: string module: description: The name of the module called. example: SSL type: string result: properties: data: description: An array of objects that include domain's AutoSSL information. items: properties: excluded_domain: description: A domain that has AutoSSL disabled. example: example.com type: string type: object type: array errors: description: List of errors if the API failed. example: null items: type: string type: - array - 'null' messages: description: List of messages generated by the API. example: null items: type: string type: - array - 'null' metadata: properties: {} status: description: '* `1` - Success. * `0` - Failed. Check the `errors` field for more details.' enum: - 0 - 1 example: 1 type: integer warnings: description: List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API. example: null items: type: string type: - array - 'null' type: object type: object description: HTTP Request was successful. summary: Return AutoSSL disabled domains tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "uapi --output=jsonpretty \\\n --user=username \\\n SSL \\\n get_autossl_excluded_domains\n" - label: URL lang: HTTP source: https://hostname.example.com:2083/cpsess##########/execute/SSL/get_autossl_excluded_domains - label: LiveAPI Perl lang: Perl source: "#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_get_autossl_excluded_domains.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend//\n# to .../frontend//api_examples/SSL_get_autossl_excluded_domains.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n q/SSL/,\n q/get_autossl_excluded_domains/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n my $data = $response->{cpanelresult}{result}{data};\n foreach my $item (@{$data}) {\n # Do something with the $item\n }\n\n # So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n # Report errors:\n print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n require JSON;\n my $str = JSON->new->pretty->encode($_[0]);\n return $str;\n}\n" - label: LiveAPI PHP lang: PHP source: " is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_get_autossl_excluded_domains.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend//\n// to .../frontend//api_examples/SSL_get_autossl_excluded_domains.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n 'SSL',\n 'get_autossl_excluded_domains'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n $data = $response['cpanelresult']['result']['data'];\n foreach ($data as $item) {\n // Do something with the $item\n }\n\n // So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n // Report errors:\n print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n return json_encode($data, JSON_PRETTY_PRINT);\n}" x-cpanel-api-version: UAPI x-cpanel-available-version: cPanel 66 servers: - description: A server running cPanel. url: https://{host}:{port}/execute variables: host: default: cpanel-server.tld description: The hostname of a server running cPanel. port: default: '2083' description: The cPanel port. /SSL/get_autossl_problems: get: x-readonly: true description: 'This function retrieves a list of domains that possess AutoSSL problems. **Important:** When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system **disables** this function.' operationId: SSL-get_autossl_problems parameters: [] responses: '200': content: application/json: schema: properties: apiversion: description: The version of the API. example: 3 type: integer func: description: The name of the method called. example: get_autossl_problems type: string module: description: The name of the module called. example: SSL type: string result: properties: data: items: properties: domain: description: The certificate's hostname. example: example.com format: domain type: string problem: description: text description of the problem. example: example.com contains 400 domains, which exceeds the maximum number (200) of domains allowed for the "Sectigo" AutoSSL provider. This system will include those 200 domains on the certificate that appear to be the website's most important. To allow AutoSSL to secure each domain, divide the 400 domains among separate websites. (The websites can all serve the same content from the same document root.) type: string time: description: When the problem occurred. example: '2018-06-07T05:30:09.000Z' format: ISO-8601 Date Time type: string type: object type: array errors: description: List of errors if the API failed. example: null items: type: string type: - array - 'null' messages: description: List of messages generated by the API. example: null items: type: string type: - array - 'null' metadata: properties: {} status: description: '* `1` - Success. * `0` - Failed. Check the `errors` field for more details.' enum: - 0 - 1 example: 1 type: integer warnings: description: List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API. example: null items: type: string type: - array - 'null' type: object type: object description: HTTP Request was successful. summary: Return domains with AutoSSL problems tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "uapi --output=jsonpretty \\\n --user=username \\\n SSL \\\n get_autossl_problems\n" - label: URL lang: HTTP source: https://hostname.example.com:2083/cpsess##########/execute/SSL/get_autossl_problems - label: LiveAPI Perl lang: Perl source: "#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_get_autossl_problems.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend//\n# to .../frontend//api_examples/SSL_get_autossl_problems.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n q/SSL/,\n q/get_autossl_problems/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n my $data = $response->{cpanelresult}{result}{data};\n foreach my $item (@{$data}) {\n # Do something with the $item\n }\n\n # So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n # Report errors:\n print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n require JSON;\n my $str = JSON->new->pretty->encode($_[0]);\n return $str;\n}\n" - label: LiveAPI PHP lang: PHP source: " is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_get_autossl_problems.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend//\n// to .../frontend//api_examples/SSL_get_autossl_problems.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n 'SSL',\n 'get_autossl_problems'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n $data = $response['cpanelresult']['result']['data'];\n foreach ($data as $item) {\n // Do something with the $item\n }\n\n // So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n // Report errors:\n print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n return json_encode($data, JSON_PRETTY_PRINT);\n}" x-cpanel-api-version: UAPI x-cpanel-available-version: cPanel 68 servers: - description: A server running cPanel. url: https://{host}:{port}/execute variables: host: default: cpanel-server.tld description: The hostname of a server running cPanel. port: default: '2083' description: The cPanel port. /SSL/get_autossl_renewal_status: get: x-readonly: true description: This function returns the AutoSSL renewal status for a domain. It indicates whether AutoSSL is active, the domain is excluded, the domain has DCV problems, and whether the certificate will auto-renew. operationId: SSL-get_autossl_renewal_status parameters: - description: The fully qualified domain name to check. in: query name: domain required: true schema: example: example.com type: string responses: '200': content: application/json: schema: properties: apiversion: description: The version of the API. example: 3 type: integer func: description: The name of the method called. example: get_autossl_renewal_status type: string module: description: The name of the module called. example: SSL type: string result: properties: data: description: An object that contains the AutoSSL renewal status for the domain. properties: has_problems: description: Whether AutoSSL has DCV failures recorded for this domain. Defaults to 1 if the problems database is unreachable. enum: - 0 - 1 example: 0 type: integer is_active: description: Whether an AutoSSL provider is configured on the server. enum: - 0 - 1 example: 1 type: integer is_excluded: description: Whether the domain is on the user's AutoSSL exclusion list. enum: - 0 - 1 example: 0 type: integer will_renew: description: Whether AutoSSL will auto-renew the certificate for this domain. Only true when the server has an active AutoSSL provider, the current certificate was issued by that provider, the domain is not excluded, and there are no recorded DCV problems. enum: - 0 - 1 example: 1 type: integer type: object errors: description: List of errors if the API failed. example: null items: type: string type: - array - 'null' messages: description: List of messages generated by the API. example: null items: type: string type: - array - 'null' metadata: properties: {} status: description: '* `1` - Success. * `0` - Failed. Check the `errors` field for more details.' enum: - 0 - 1 example: 1 type: integer warnings: description: List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running an API. example: null items: type: string type: - array - 'null' type: object type: object description: HTTP Request was successful. summary: Return AutoSSL renewal status for a domain tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "uapi --output=jsonpretty \\\n --user=username \\\n SSL \\\n get_autossl_renewal_status \\\n domain=example.com\n" - label: URL lang: HTTP source: https://hostname.example.com:2083/cpsess##########/execute/SSL/get_autossl_renewal_status?domain=example.com - label: LiveAPI Perl lang: Perl source: "#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_get_autossl_renewal_status.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend//\n# to .../frontend//api_examples/SSL_get_autossl_renewal_status.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n q/SSL/,\n q/get_autossl_renewal_status/,\n {\n 'domain' => 'example.com',\n }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n my $data = $response->{cpanelresult}{result}{data};\n\n # So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n # Report errors:\n print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n require JSON;\n my $str = JSON->new->pretty->encode($_[0]);\n return $str;\n}\n" - label: LiveAPI PHP lang: PHP source: " is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_get_autossl_renewal_status.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend//\n// to .../frontend//api_examples/SSL_get_autossl_renewal_status.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n 'SSL',\n 'get_autossl_renewal_status',\n array(\n 'domain' => 'example.com',\n )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n $data = $response['cpanelresult']['result']['data'];\n\n // So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n // Report errors:\n print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n return json_encode($data, JSON_PRETTY_PRINT);\n}" x-cpanel-api-version: UAPI x-cpanel-available-version: cPanel 134 servers: - description: A server running cPanel. url: https://{host}:{port}/execute variables: host: default: cpanel-server.tld description: The hostname of a server running cPanel. port: default: '2083' description: The cPanel port. /SSL/get_cabundle: get: x-readonly: true description: 'This function retrieves a certificate''s Certificate Authority (CA) bundle and hostname. **Important:** When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system **disables** this function.' operationId: SSL-get_cabundle parameters: - description: The certificate's text. in: query name: cert required: true schema: example: REDACTED_CERTIFICATE_EXAMPLE format: pem-certificate type: string responses: '200': content: application/json: schema: properties: apiversion: description: The version of the API. example: 3 type: integer func: description: The name of the method called. example: get_cabundle type: string module: description: The name of the module called. example: SSL type: string result: properties: data: properties: bundle: description: The CA bundle's tag. example: VeriSign Trial Secure Server CA - G2 type: string cab: description: The CA bundle's contents. example: REDACTED_CERTIFICATE_EXAMPLE format: pem-certificate type: string domain: description: The certificate's hostname. example: example.com format: domain type: string type: object errors: description: List of errors if the API failed. example: null items: type: string type: - array - 'null' messages: description: List of messages generated by the API. example: null items: type: string type: - array - 'null' metadata: properties: {} status: description: '* `1` - Success. * `0` - Failed. Check the `errors` field for more details.' enum: - 0 - 1 example: 1 type: integer warnings: description: List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API. example: null items: type: string type: - array - 'null' type: object type: object description: HTTP Request was successful. summary: Return certificate's CA bundle and hostname tags: - SSL x-codeSamples: - label: CLI lang: Shell source: REDACTED_CERTIFICATE_EXAMPLE - label: URL lang: HTTP source: https://hostname.example.com:2083/cpsess##########/execute/SSL/get_cabundle?cert=-----BEGIN%20CERTIFICATE-----%5cr%5cnMIIDcTCCAlmgAwIBAgIFAU%2bBNVgwDQYJKoZIhvcNAQEFBQAwUTESMBAGA1UEAwwJ%5cr%5cnc2lza28udGxkMQswCQYDVQQGEwJVUzEPMA0GA1UECgwGY1BhbmVsMQswCQYDVQQI%5cr%5cnDAJUWDEQMA4GA1UEBwwHSG91c3RvbjAeFw0xNDEwMDYyMjI2MTlaFw0xNTEwMDYy%5cr%5cnMjI2MTlaMFExEjAQBgNVBAMMCXNpc2tvLnRsZDELMAkGA1UEBhMCVVMxDzANBgNV%5cr%5cnBAoMBmNQYW5lbDELMAkGA1UECAwCVFgxEDAOBgNVBAcMB0hvdXN0b24wggEiMA0G%5cr%5cnCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC9zx6zGiHdmWA0dKtoXmJiWXpZ9E3P%5cr%5cnXx3YHsjFEWW7e5pH0vZ%2bjVMzDmm5nsJ7RXrAkZO1IvpIpVLvoQfiJOWVvkD%2bo9fW%5cr%5cnvoK1tWJS72FSgPju%2b58mA2ieBuc87A790Pzuv1P3NR3zFLAjUR99zkHR1fpri%2fda%5cr%5cnM3PBWO8ET48FWkyU1kOeZaUlF67%2f%2bwrEiNgg%2bt1qhKOCAB61PdNVkLaSGHimksuC%5cr%5cn%2bCzk8Kq9nuS0E0TCnDtjjEyJ455FUcaCfczlTb8xkB%2fF9ORe74yTzD%2bvlk0tFMG6%5cr%5cnPLj%2fajIwWqwO0qmQ8wX3NRxkWgGz5kVO1wrVJarKQ5EYQ3%2fmgvit0v6dAgMBAAGj%5cr%5cnUDBOMB0GA1UdDgQWBBRw%2bwKBo34%2bbgexjAa3EMDsgSCd7zAfBgNVHSMEGDAWgBRw%5cr%5cn%2bwKBo34%2bbgexjAa3EMDsgSCd7zAMBgNVHRMEBTADAQH%2fMA0GCSqGSIb3DQEBBQUA%5cr%5cnA4IBAQCHRXIs53opzKM2rM8Qe8lcw524WK6hqy2EWrZHp78N7rU7%2f6DQ%2fI3hv3Wh%5cr%5cncDDIO04I2%2fXhe88MLBaLoM367Ya%2bvy7CaLr14aLi%2fSfQszMA0ALBvMao%2bFis0iVw%5cr%5cnFYq%2fNLgSXw%2bfgnpFskt8v8iQZ%2b4Kaal8U8e9sVgu8m0RgO7rzym1eRiIKpsKd1rh%5cr%5cn%2fSD7LbSN7M7TRL3QqF7ltw9sQhAAsQcRaBBF21pdWrqhiGZ%2bEioo3hhgwNavH2ag%5cr%5cnqz78ddHwrFpHFwrEeUk1OfpPb76MYIce7xIy%2f4oQNdg6fOq4l%2fFrajBv%2bWkzDVPa%5cr%5cnKm6r7YmwfLN%2fYMZBHXSR58oOGP9W%5cr%5cn-----END%20CERTIFICATE----- - label: LiveAPI Perl lang: Perl source: REDACTED_CERTIFICATE_EXAMPLE - label: LiveAPI PHP lang: PHP source: REDACTED_CERTIFICATE_EXAMPLE x-cpanel-api-version: UAPI x-cpanel-available-version: cPanel 11.42 servers: - description: A server running cPanel. url: https://{host}:{port}/execute variables: host: default: cpanel-server.tld description: The hostname of a server running cPanel. port: default: '2083' description: The cPanel port. /SSL/get_cn_name: get: x-readonly: true description: This function retrieves the most secure domain for a service. operationId: SSL-get_cn_name parameters: - description: A domain name, cPanel username, or email address. example: example.com in: query name: domain required: true schema: anyOf: - description: A valid domain. format: domain type: string - description: A valid email address. format: email type: string - description: A valid cPanel username. format: username type: string - description: 'The service''s name. * `cpanel` * `imap` * `pop3` * `smtp`' in: query name: service required: true schema: enum: - cpanel - imap - pop3 - smtp example: cpanel type: string - description: 'Whether to append `mail` to the `domain` value to find the best match. For example, if you specify the domain `example.com` and call this parameter, the function only searches the `mail.example.com` service domains. * `1` — Append `mail` to the `domain` value during the search. * `0` — Match on the specified `domain` value **only**.' in: query name: add_mail_subdomain required: false schema: default: 0 enum: - 1 - 0 example: 0 type: integer responses: '200': content: application/json: schema: properties: apiversion: description: The version of the API. example: 3 type: integer func: description: The name of the method called. example: get_cn_name type: string module: description: The name of the module called. example: SSL type: string result: properties: data: properties: cert_match_method: description: 'The method that the system used to match the certificate with the mail service. * `none` — No domain matches the certificate. * `exact` — The domain exactly matches the certificate. * `exact-wildcard` — The domain exactly matches the certificate. * `mail-wildcard` — The `mail` subdomain of the domain matches the domain of the wildcard certificate. * `www-wildcard` — The `www` subdomain of the domain matches the domain of the wildcard certificate. * `hostname-wildcard` — The hostname''s domain matches the domain of the wildcard certificate. * `hostname` — The hostname matches the domain of the certificate. * `localdomain_on_cert-mail-wildcard` — A `mail` subdomain of a domain on the server that matches the certificate. * `localdomain_on_cert-www-wildcard` — A `www` subdomain of a domain on the server matches the certificate. * `localdomain_on_cert` — A domain on the server matches the certificate.' enum: - none - exact - exact-wildcard - mail-wildcard - www-wildcard - hostname-wildcard - hostname - localdomain_on_cert-mail-wildcard - localdomain_on_cert-www-wildcard - localdomain_on_cert example: hostname type: string cert_valid_not_after: description: The certificate's expiration date. example: 1394288638 format: unix_timestamp type: integer is_currently_valid: description: "Whether the certificate is currently valid.\n\n* `1` — Valid.\n* `0` — Invalid.\n\n**Note:**\n\nIf the certificate is valid, the following statements are true:\n * The certificate is **not** self-signed (the `ssldomain_matches_cert` value is `1`).\n * The certificate matches the SSL domain (the `ssldomain_matches_cert` value is `1`).\n * The certificate is within its validity period (the `cert_valid_not_after` value is **less** than the current time and date)." enum: - 1 - 0 example: 0 type: integer is_self_signed: description: 'Whether the certificate is self-signed. * `1` — Self-signed. * `0` — Not self-signed. **Note:** If the `cert_match_method` value is `none`, you should ignore this return''s value.' enum: - 1 - 0 example: 1 type: integer is_wild_card: description: 'Whether the certificate is a wildcard certificate. * `1` — Wildcard. * `0` — Not a wildcard.' enum: - 1 - 0 example: 0 type: integer ssldomain: description: The best domain to use to access the service. example: hostname.example.com format: domain type: string ssldomain_matches_cert: description: 'Whether an SSL-protected domain matches the certificate. * `1` — Matches. * `0` — Does **not** match.' enum: - 1 - 0 example: 1 type: integer type: object errors: description: List of errors if the API failed. example: null items: type: string type: - array - 'null' messages: description: List of messages generated by the API. example: null items: type: string type: - array - 'null' metadata: properties: {} status: description: '* `1` — Success. * `0` — Failed. Check the `errors` field for more details.' enum: - 1 - 0 example: 1 type: integer warnings: description: List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API. example: null items: type: string type: - array - 'null' type: object type: object description: HTTP Request was successful. summary: Request best SSL domain for service tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "uapi --output=jsonpretty \\\n --user=username \\\n SSL \\\n get_cn_name \\\n domain='example.com' \\\n service='cpanel'\n" - label: URL lang: HTTP source: https://hostname.example.com:2083/cpsess##########/execute/SSL/get_cn_name?domain=example.com&service=cpanel - label: LiveAPI Perl lang: Perl source: "#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_get_cn_name.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend//\n# to .../frontend//api_examples/SSL_get_cn_name.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n q/SSL/,\n q/get_cn_name/,\n {\n 'domain' => 'example.com',\n 'service' => 'cpanel',\n }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n my $data = $response->{cpanelresult}{result}{data};\n # Do something with the $data\n # So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n # Report errors:\n print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n require JSON;\n my $str = JSON->new->pretty->encode($_[0]);\n return $str;\n}\n" - label: LiveAPI PHP lang: PHP source: " is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_get_cn_name.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend//\n// to .../frontend//api_examples/SSL_get_cn_name.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n 'SSL',\n 'get_cn_name',\n array (\n 'domain' => 'example.com',\n 'service' => 'cpanel',\n )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n $data = $response['cpanelresult']['result']['data'];\n // Do something with the $data\n // So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n // Report errors:\n print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n return json_encode($data, JSON_PRETTY_PRINT);\n}" x-cpanel-api-version: UAPI x-cpanel-available-version: cPanel 11.42 servers: - description: A server running cPanel. url: https://{host}:{port}/execute variables: host: default: cpanel-server.tld description: The hostname of a server running cPanel. port: default: '2083' description: The cPanel port. /SSL/install_ssl: get: x-readonly: false x-rollback: none description: 'This function installs an SSL certificate. **Note:** Due to their inherent complexities, SSL-related functions often present problems for third-party developers. For the additional steps required to successfully call this function, read our Call UAPI''s SSL::install_ssl Function in Custom Code documentation. **Important:** When you disable the *Calendars and Contacts*, *Receive Mail*, *Web Disk*, *Webmail*, and *Web Server* roles, the system **disables** this function.' operationId: SSL-install_ssl parameters: - description: "The certificate to install.\n\n**Note:**\n\n* You **must** URI-encode this value.\n* You can use a Perl command to URI-encode your SSL certificate for this parameter.\nFor example, you can use the following string, where `CERT.FILE` is the SSL certificate file:\n\n ```$(perl -MURI::Escape -ne 'print uri_escape($_);' CERT.FILE)```" in: query name: cert required: true schema: example: '-----BEGIN%20CERTIFICATE-----%0AMIIEEzCCAvugAwIBAgIJALF%2FjFpw6p1bMA0GCSqGSIb3DQEBBQUAMIGfMRYwFAYD%0AVQQDEw10ZXN0c2ltb24uY29tMRYwFAYDVQQLEw1Eb2N1bWVudGF0aW9uMQswCQYD%0AVQQGEwJVUzEoMCYGCSqGSIb3DQEJARYZbGF1cmVuY2Uuc2ltb25AY3BhbmVsLm5l%0AdDEUMBIGA1UEChMLY1BhbmVsIEluYy4xDjAMBgNVBAgTBVRleGFzMRAwDgYDVQQH%0AEwdIb3VzdG9uMB4XDTEzMDUxNzE2MTMwN1oXDTE0MDUxNzE2MTMwN1owgZ8xFjAU%0ABgNVBAMTDXRlc3RzaW1vbi5jb20xFjAUBgNVBAsTDURvY3VtZW50YXRpb24xCzAJ%0ABgNVBAYTAlVTMSgwJgYJKoZIhvcNAQkBFhlsYXVyZW5jZS5zaW1vbkBjcGFuZWwu%0AbmV0MRQwEgYDVQQKEwtjUGFuZWwgSW5jLjEOMAwGA1UECBMFVGV4YXMxEDAOBgNV%0ABAcTB0hvdXN0b24wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDRO0AP%0AN5XtjDqkEyJ6ctfYqUtt9yUXyRuCETFjW6opNLSmZSHeF6L2aZka646lhj02CFyl%0AkzsNSxysN66tY%2BWZcTmvgPisJdQFpFvjroJZgDjYRV0QqokKdRy%2F5BU0%2BtHXoYpj%0A9JOQlbvEWxiGR3R80sL1ma4AfSE6Gv8M%2FPULTadan51eHaikXqjOXdPJQKuWP3g9%0AFnIuf38WRYwzGrre88qsZrpsMrADX5dotHWgqAf7Tap6xfA4CUAgQo9tldariuVi%0ABz%2BsRJ%2FSjgxnhw1HYWGttBuBZFhMpdHpPnTJ7DIFMd%2FFN5gG%2Ftah30SapWpo35Ux%0A3BpJcdUjtazy82K5AgMBAAGjUDBOMB0GA1UdDgQWBBQAlv7%2FtALOYb7zAXbYG2%2B9%0AAMI3xjAfBgNVHSMEGDAWgBQAlv7%2FtALOYb7zAXbYG2%2B9AMI3xjAMBgNVHRMEBTAD%0AAQH%2FMA0GCSqGSIb3DQEBBQUAA4IBAQCxzpe71Hc7Es0dqIN7bhIFYIIgcr6wxM6a%0Aa9d%2BQG%2BQPH0x0KAqV8EgUbZysvyxEF0bPxW3ZAr1Is1wk80PMuU3bToFFVbFFIIr%0AHRNfKLGvxiMXnZA1c6L4N0lowvXHgZxTTUXtDFLXyrcwrLsvUErEV7rbizuxqfPw%0AcaRtXn4uc%2Bt6HYuW7yWesBauCWnJNiKbjN%2FF%2BuCTurN3QMAeWf3ZJtsfkAgk8dyq%0AR%2F83a3kDtSPrpt%2BjX%2BqdjKEpRtQ5Qpm6XT2gCOQPgnfiUtOCH419pp922P%2FAAGc%2B%0AZUhYoWcRWKw%2Fy6gI7Ru%2B%2B9%2B8%2BwkadL9EbKMZxhVwD5qVm4ZlWK2a%5Cr%5Cn%0A-----END%20CERTIFICATE-----' format: pem-certificate type: string - description: The domain name. in: query name: domain required: true schema: example: example.com format: domain type: string - description: "The Certificate Authority (CA) bundle data, if the certificate requires it.\n\n**Note:**\n\n* You **must** URI-encode this value.\n* You can use a Perl command to URI-encode your SSL certificate for this parameter.\nFor example, you can use the following string, where `CABUNDLE.FILE` is the SSL certificate file:\n\n ```$(perl -MURI::Escape -ne 'print uri_escape($_);' CABUNDLE.FILE)```" in: query name: cabundle required: false schema: example: '-----BEGIN%20CERTIFICATE-----%0AMIIB%2BjCCAWMCAgGjMA0GCSqGSIb3DQEBBAUAMEUxCzAJBgNVBAYTAlVTMRgwFgYD%0AVQQKEw9HVEUgQ29ycG9yYXRpb24xHDAaBgNVBAMTE0dURSBDeWJlclRydXN0IFJv%0Ab3QwHhcNOTYwMjIzMjMwMTAwWhcNMDYwMjIzMjM1OTAwWjBFMQswCQYDVQQGEwJV%0AUzEYMBYGA1UEChMPR1RFIENvcnBvcmF0aW9uMRwwGgYDVQQDExNHVEUgQ3liZXJU%0AcnVzdCBSb290MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC45k%2B625h8cXyv%0ARLfTD0bZZOWTwUKOx7pJjTUteueLveUFMVnGsS8KDPufpz%2BiCWaEVh43KRuH6X4M%0AypqfpX%2F1FZSj1aJGgthoTNE3FQZor734sLPwKfWVWgkWYXcKIiXUT0Wqx73llt%2F5%0A1KiOQswkwB6RJ0q1bQaAYznEol44AwIDAQABMA0GCSqGSIb3DQEBBAUAA4GBABKz%0AdcZfHeFhVYAA1IFLezEPI2PnPfMD%2BfQ2qLvZ46WXTeorKeDWanOB5sCJo9Px4KWl%0AIjeaY8JIILTbcuPI9tl8vrGvU9oUtCG41tWW4%2F5ODFlitppK%2BULdjG%2BBqXH%2F9Apy%0AbW1EDp3zdHSo1TRJ6V6e6bR64eVaH4QwnNOfpSXY%0A-----END%20CERTIFICATE-----' format: pem-certificate type: string - description: A map of each domain to its domain control validation (DCV) method. in: query name: domain_dcv_method required: false schema: additionalProperties: enum: - http - dns type: string example: example.com: http type: object - description: "The certificate's key. If you omit it, the system uses the matching key already saved to your account.\n\n**Note:**\n\n* You **must** URI-encode this value.\n* You can use a Perl command to URI-encode your SSL certificate for this parameter.\nFor example, you can use the following string, where `KEY.FILE` is the SSL certificate file:\n\n ```$(perl -MURI::Escape -ne 'print uri_escape($_);' KEY.FILE)```" in: query name: key required: false schema: example: '-----BEGIN%20RSA%20PRIVATE%20KEY-----%0AMIIEpAIBAAKCAQEA4AVM6J4Qg3DIFWr%2FeJ5GRmIATYsJIepKbrDy70sq%2BudcO8R8%0Axxak0oMZ%2F9mUdpjSNK%2FfLVTuCO0kxTfQ9VUWJllX7ThD6Zh9ZvlC%2Fnf%2FOEZLm3Zb%0ABgu8rbC8E9wuDOkKbJLnINgdhtowIydLK2MJ%2B%2Bq62bFV89jkHWTMcKyyqHENo3h%0Ac%2Blkpd9vnp8rZTinaVb7nX26uQqAFZYRo%2BWU0G%2FNPsq40QVSMoqPxyEz4qXo0hvu%0AIlCXmzFZq%2F6fCVPEKPLhQgMmpdBkMz4dVOazREfqXdjMD2%2BQXSNiA1AwWr8l0r4r%0AtzlxEYDJIR41yXp0xMl3KoolxMyvLBqZy32niQIDAQABAoIBAQCmbGmhWmPsMeoC%0At1WJFxQgD4goE0U6k%2BKt7vjbOt14Pk6v%2FB2yjaju1wSGpO59WLS4%2FXrwI2se6IXr%0Amba7u3VUEgWXLriNHoLy7%2FSMNTs%2BZEKhAMG36eNe3tVdT7busTag31r6sEMGGwCs%0AIwpU%2Bazosk0oylWLEX%2Fm%2FuHWEs1eaIEWWWtgHB%2BKZrrP7Rr9RYfVQ144DxmOxS3C%0Aa9%2BmST62WqAVPR6POWGEfZqnZl%2FePWZPcQYbFrhwnnefNoYBl%2FbnLZBo8rbNWxAq%0AOEOuKfkrBzglKG%2F39WKPw8rj4JIVzY0yOuFCW6xCDWRkOrhU8Ol%2F3FvwDa3uJpkp%0AmgPr4TgxAoGBAPGPLmxSuOYR97mDAXxrs037F2GCbqWvI6m7%2FezWe9yn%2BbMpjSIW%0Afsgtq4FsyqzPueEkDdQWi3xh6nu2WI%2F1Tl875opGAqEIJMqss%2Fu11tnva5wzu1cC%0AL6H85A5%2BHMOBvP3sm6CObKcVw92h7kxynVIUJJWhjfeZMN8gBFFpKIVFAoGBAO1p%0AtXBmXLC%2FYKKvtHI3M16%2FZopvM8ZqU2HcAHaw214Refw9JJ%2Fe3%2FxTNfSerVTyCAQO%0A1AdWTzJKBN8jmSYv1Mk1D3RpQPNR7wVzi46KR081AU41uMpqIGVOwHtyVnW%2FZfLr%0Ac1DLIK8Cx8aHfoxffwzoMO5SEQSooeZfOLhsfDN1AoGBAKQTUEINsj%2B75psgbAr6%0AELGgItJ9yPBLVRr%2BcUzEpx9LDWVvjMihpP4NX1gq8EOPWT%2BewLHVmmsjCyV6xw8J%0AXXF8e2xif3in0m3D%2FwCzE7u2T06rKM3B017hKnrZmGoHnrqPU2osM4sOUpshWX6d%0Av1Q4EF1%2BfbK3YCW%2BVpCBsB9NAoGAQo%2BuhNLODee56iKkzpjXWCsFTq6ar3hD5F3P%0A63buKdNwhd2GlSPhXFbf%2B7M5GWW6BZk6rMvv7EOAVice2uvyFm8%2F4%2F1WbmF8R%2BT7%0ALX1rPLO5p%2Fm701QpvP11TabiwqRkqtSEQhSRF0AKTojSW%2FyyHCZFAawUhV%2FZ9EKi%0AHmKb97kCgYAyzmFc2it0HqnsOnRybop603nqMtWGTQO4cxa93HUDpYajuK2K3Dfr%0AxUj6lG3z%2FoKJGGE2JqgZ6LBAhNJtJWJu2ox3pKGE63QjLJnVwb8y1NFYpe%2FcrbLe%0APuBwIR0L7drXxfv7O5btY7h6QI2d1%2FUIAQPAWbxLoTM%2BndQ%2FuPEdfA%3D%3D%0A-----END%20RSA%20PRIVATE%20KEY-----' format: pem-private-key type: string - description: The cPanel Store order item ID associated with the certificate. in: query name: order_item_id required: false schema: example: '67890' type: string - description: 'The cPanel Store certificate ID that this certificate descends from. The short-lived certificate re-issue workflow sets this so the system can supersede the prior certificate after installation; end users do not normally set it.' in: query name: originating_certificate_id required: false schema: example: '12345' type: string - description: The expiration of the parent subscription certificate, as a Unix timestamp. in: query name: parent_cert_expiry required: false schema: example: 1735689600 type: integer - description: 'The virtual host names onto which to install the certificate. To set multiple names, duplicate or increment the parameter name. For example, `vhost_names-1` and `vhost_names-2`.' in: query name: vhost_names required: false schema: items: example: example.com format: domain type: string type: array responses: '200': content: application/json: schema: properties: apiversion: description: The version of the API. example: 3 type: integer func: description: The name of the method called. example: install_ssl type: string module: description: The name of the module called. example: SSL type: string result: properties: data: properties: action: description: The action that the function used to install the certificate. example: update type: string cert_id: description: The certificate ID. example: example_com_bbe7e_16e2d_1369007999_1d87a0cdb540f5aae607b10e9a1a82fb type: string domain: description: The domain that the certificate covers. example: example.com format: domain type: string extra_certificate_domains: description: The domains that require extra certificates for mail and other services. items: example: ssl.example.com format: domain type: string type: array html: description: The results, in HTML format. example: 'The SSL certificate is now installed onto the domain "example.com" using the IP address "192.168.0.1". The existing virtual host was updated with the new certificate. Apache is restarting in the background.' type: string ip: description: The domain's IP address. example: 192.168.0.1 oneOf: - format: ipv4 type: string - format: ipv6 type: string key_id: description: The key ID. example: bbe7e_16e2d_df7539f280eb1ecf6c1096190e41ada7 type: string message: description: The results, in text format. example: 'The SSL certificate is now installed onto the domain "example.com" using the IP address "192.168.0.1". The existing virtual host was updated with the new certificate. Apache is restarting in the background.' type: string statusmsg: description: The results. example: 'The SSL certificate is now installed onto the domain "example.com" using the IP address "192.168.0.1". The existing virtual host was updated with the new certificate. Apache is restarting in the background. The SSL certificate is now installed onto the domain "example.com" using the IP address "192.168.0.1". The existing virtual host was updated with the new certificate. Apache is restarting in the background' type: string user: description: The domain's owner. example: example format: username type: string warning_domains: description: The domains that the certificate does not cover. items: example: warning.com format: domain type: string type: array working_domains: description: The domains that the certificate covers. items: example: example.com format: domain type: string type: array type: object errors: description: List of errors if the API failed. example: null items: type: string type: - array - 'null' messages: description: List of messages generated by the API. example: null items: type: string type: - array - 'null' metadata: properties: transformed: description: Post-processing may have transformed the data. enum: - 1 example: 1 type: integer status: description: '* `1` — Success. * `0` — Failed. Check the `errors` field for more details.' enum: - 0 - 1 example: 1 type: integer warnings: description: List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API. example: null items: type: string type: - array - 'null' type: object type: object description: HTTP Request was successful. summary: Install SSL certificate tags: - SSL x-codeSamples: - label: CLI lang: Shell source: uapi --output=jsonpretty --user=username SSL install_ssl domain='example.com' cert='-----BEGIN%20CERTIFICATE-----%0AMIIEEzCCAvugAwIBAgIJALF%2FjFpw6p1bMA0GCSqGSIb3DQEBBQUAMIGfMRYwFAYD%0AVQQDEw10ZXN0c2ltb24uY29tMRYwFAYDVQQLEw1Eb2N1bWVudGF0aW9uMQswCQYD%0AVQQGEwJVUzEoMCYGCSqGSIb3DQEJARYZbGF1cmVuY2Uuc2ltb25AY3BhbmVsLm5l%0AdDEUMBIGA1UEChMLY1BhbmVsIEluYy4xDjAMBgNVBAgTBVRleGFzMRAwDgYDVQQH%0AEwdIb3VzdG9uMB4XDTEzMDUxNzE2MTMwN1oXDTE0MDUxNzE2MTMwN1owgZ8xFjAU%0ABgNVBAMTDXRlc3RzaW1vbi5jb20xFjAUBgNVBAsTDURvY3VtZW50YXRpb24xCzAJ%0ABgNVBAYTAlVTMSgwJgYJKoZIhvcNAQkBFhlsYXVyZW5jZS5zaW1vbkBjcGFuZWwu%0AbmV0MRQwEgYDVQQKEwtjUGFuZWwgSW5jLjEOMAwGA1UECBMFVGV4YXMxEDAOBgNV%0ABAcTB0hvdXN0b24wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDRO0AP%0AN5XtjDqkEyJ6ctfYqUtt9yUXyRuCETFjW6opNLSmZSHeF6L2aZka646lhj02CFyl%0AkzsNSxysN66tY%2BWZcTmvgPisJdQFpFvjroJZgDjYRV0QqokKdRy%2F5BU0%2BtHXoYpj%0A9JOQlbvEWxiGR3R80sL1ma4AfSE6Gv8M%2FPULTadan51eHaikXqjOXdPJQKuWP3g9%0AFnIuf38WRYwzGrre88qsZrpsMrADX5dotHWgqAf7Tap6xfA4CUAgQo9tldariuVi%0ABz%2BsRJ%2FSjgxnhw1HYWGttBuBZFhMpdHpPnTJ7DIFMd%2FFN5gG%2Ftah30SapWpo35Ux%0A3BpJcdUjtazy82K5AgMBAAGjUDBOMB0GA1UdDgQWBBQAlv7%2FtALOYb7zAXbYG2%2B9%0AAMI3xjAfBgNVHSMEGDAWgBQAlv7%2FtALOYb7zAXbYG2%2B9AMI3xjAMBgNVHRMEBTAD%0AAQH%2FMA0GCSqGSIb3DQEBBQUAA4IBAQCxzpe71Hc7Es0dqIN7bhIFYIIgcr6wxM6a%0Aa9d%2BQG%2BQPH0x0KAqV8EgUbZysvyxEF0bPxW3ZAr1Is1wk80PMuU3bToFFVbFFIIr%0AHRNfKLGvxiMXnZA1c6L4N0lowvXHgZxTTUXtDFLXyrcwrLsvUErEV7rbizuxqfPw%0AcaRtXn4uc%2Bt6HYuW7yWesBauCWnJNiKbjN%2FF%2BuCTurN3QMAeWf3ZJtsfkAgk8dyq%0AR%2F83a3kDtSPrpt%2BjX%2BqdjKEpRtQ5Qpm6XT2gCOQPgnfiUtOCH419pp922P%2FAAGc%2B%0AZUhYoWcRWKw%2Fy6gI7Ru%2B%2B9%2B8%2BwkadL9EbKMZxhVwD5qVm4ZlWK2a%5Cr%5Cn%0A-----END%20CERTIFICATE-----' key='-----BEGIN%20RSA%20PRIVATE%20KEY-----%0AMIIEpAIBAAKCAQEA4AVM6J4Qg3DIFWr%2FeJ5GRmIATYsJIepKbrDy70sq%2BudcO8R8%0Axxak0oMZ%2F9mUdpjSNK%2FfLVTuCO0kxTfQ9VUWJllX7ThD6Zh9ZvlC%2Fnf%2FOEZLm3Zb%0ABgu8rbC8E9wuDOkKbJLnINgdhtowIydLK2MJ%2B%2Bq62bFV89jkHWTMcKyyqHENo3h%0Ac%2Blkpd9vnp8rZTinaVb7nX26uQqAFZYRo%2BWU0G%2FNPsq40QVSMoqPxyEz4qXo0hvu%0AIlCXmzFZq%2F6fCVPEKPLhQgMmpdBkMz4dVOazREfqXdjMD2%2BQXSNiA1AwWr8l0r4r%0AtzlxEYDJIR41yXp0xMl3KoolxMyvLBqZy32niQIDAQABAoIBAQCmbGmhWmPsMeoC%0At1WJFxQgD4goE0U6k%2BKt7vjbOt14Pk6v%2FB2yjaju1wSGpO59WLS4%2FXrwI2se6IXr%0Amba7u3VUEgWXLriNHoLy7%2FSMNTs%2BZEKhAMG36eNe3tVdT7busTag31r6sEMGGwCs%0AIwpU%2Bazosk0oylWLEX%2Fm%2FuHWEs1eaIEWWWtgHB%2BKZrrP7Rr9RYfVQ144DxmOxS3C%0Aa9%2BmST62WqAVPR6POWGEfZqnZl%2FePWZPcQYbFrhwnnefNoYBl%2FbnLZBo8rbNWxAq%0AOEOuKfkrBzglKG%2F39WKPw8rj4JIVzY0yOuFCW6xCDWRkOrhU8Ol%2F3FvwDa3uJpkp%0AmgPr4TgxAoGBAPGPLmxSuOYR97mDAXxrs037F2GCbqWvI6m7%2FezWe9yn%2BbMpjSIW%0Afsgtq4FsyqzPueEkDdQWi3xh6nu2WI%2F1Tl875opGAqEIJMqss%2Fu11tnva5wzu1cC%0AL6H85A5%2BHMOBvP3sm6CObKcVw92h7kxynVIUJJWhjfeZMN8gBFFpKIVFAoGBAO1p%0AtXBmXLC%2FYKKvtHI3M16%2FZopvM8ZqU2HcAHaw214Refw9JJ%2Fe3%2FxTNfSerVTyCAQO%0A1AdWTzJKBN8jmSYv1Mk1D3RpQPNR7wVzi46KR081AU41uMpqIGVOwHtyVnW%2FZfLr%0Ac1DLIK8Cx8aHfoxffwzoMO5SEQSooeZfOLhsfDN1AoGBAKQTUEINsj%2B75psgbAr6%0AELGgItJ9yPBLVRr%2BcUzEpx9LDWVvjMihpP4NX1gq8EOPWT%2BewLHVmmsjCyV6xw8J%0AXXF8e2xif3in0m3D%2FwCzE7u2T06rKM3B017hKnrZmGoHnrqPU2osM4sOUpshWX6d%0Av1Q4EF1%2BfbK3YCW%2BVpCBsB9NAoGAQo%2BuhNLODee56iKkzpjXWCsFTq6ar3hD5F3P%0A63buKdNwhd2GlSPhXFbf%2B7M5GWW6BZk6rMvv7EOAVice2uvyFm8%2F4%2F1WbmF8R%2BT7%0ALX1rPLO5p%2Fm701QpvP11TabiwqRkqtSEQhSRF0AKTojSW%2FyyHCZFAawUhV%2FZ9EKi%0AHmKb97kCgYAyzmFc2it0HqnsOnRybop603nqMtWGTQO4cxa93HUDpYajuK2K3Dfr%0AxUj6lG3z%2FoKJGGE2JqgZ6LBAhNJtJWJu2ox3pKGE63QjLJnVwb8y1NFYpe%2FcrbLe%0APuBwIR0L7drXxfv7O5btY7h6QI2d1%2FUIAQPAWbxLoTM%2BndQ%2FuPEdfA%3D%3D%0A-----END%20RSA%20PRIVATE%20KEY-----' - label: URL lang: HTTP source: https://hostname.example.com:2083/cpsess##########/execute/SSL/install_ssl?domain=example.com&cert=-----BEGIN%20CERTIFICATE-----%0aMIIEEzCCAvugAwIBAgIJALF%2fjFpw6p1bMA0GCSqGSIb3DQEBBQUAMIGfMRYwFAYD%0aVQQDEw10ZXN0c2ltb24uY29tMRYwFAYDVQQLEw1Eb2N1bWVudGF0aW9uMQswCQYD%0aVQQGEwJVUzEoMCYGCSqGSIb3DQEJARYZbGF1cmVuY2Uuc2ltb25AY3BhbmVsLm5l%0adDEUMBIGA1UEChMLY1BhbmVsIEluYy4xDjAMBgNVBAgTBVRleGFzMRAwDgYDVQQH%0aEwdIb3VzdG9uMB4XDTEzMDUxNzE2MTMwN1oXDTE0MDUxNzE2MTMwN1owgZ8xFjAU%0aBgNVBAMTDXRlc3RzaW1vbi5jb20xFjAUBgNVBAsTDURvY3VtZW50YXRpb24xCzAJ%0aBgNVBAYTAlVTMSgwJgYJKoZIhvcNAQkBFhlsYXVyZW5jZS5zaW1vbkBjcGFuZWwu%0abmV0MRQwEgYDVQQKEwtjUGFuZWwgSW5jLjEOMAwGA1UECBMFVGV4YXMxEDAOBgNV%0aBAcTB0hvdXN0b24wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDRO0AP%0aN5XtjDqkEyJ6ctfYqUtt9yUXyRuCETFjW6opNLSmZSHeF6L2aZka646lhj02CFyl%0akzsNSxysN66tY%2bWZcTmvgPisJdQFpFvjroJZgDjYRV0QqokKdRy%2f5BU0%2btHXoYpj%0a9JOQlbvEWxiGR3R80sL1ma4AfSE6Gv8M%2fPULTadan51eHaikXqjOXdPJQKuWP3g9%0aFnIuf38WRYwzGrre88qsZrpsMrADX5dotHWgqAf7Tap6xfA4CUAgQo9tldariuVi%0aBz%2bsRJ%2fSjgxnhw1HYWGttBuBZFhMpdHpPnTJ7DIFMd%2fFN5gG%2ftah30SapWpo35Ux%0a3BpJcdUjtazy82K5AgMBAAGjUDBOMB0GA1UdDgQWBBQAlv7%2ftALOYb7zAXbYG2%2b9%0aAMI3xjAfBgNVHSMEGDAWgBQAlv7%2ftALOYb7zAXbYG2%2b9AMI3xjAMBgNVHRMEBTAD%0aAQH%2fMA0GCSqGSIb3DQEBBQUAA4IBAQCxzpe71Hc7Es0dqIN7bhIFYIIgcr6wxM6a%0aa9d%2bQG%2bQPH0x0KAqV8EgUbZysvyxEF0bPxW3ZAr1Is1wk80PMuU3bToFFVbFFIIr%0aHRNfKLGvxiMXnZA1c6L4N0lowvXHgZxTTUXtDFLXyrcwrLsvUErEV7rbizuxqfPw%0acaRtXn4uc%2bt6HYuW7yWesBauCWnJNiKbjN%2fF%2buCTurN3QMAeWf3ZJtsfkAgk8dyq%0aR%2f83a3kDtSPrpt%2bjX%2bqdjKEpRtQ5Qpm6XT2gCOQPgnfiUtOCH419pp922P%2fAAGc%2b%0aZUhYoWcRWKw%2fy6gI7Ru%2b%2b9%2b8%2bwkadL9EbKMZxhVwD5qVm4ZlWK2a%5cr%5cn%0a-----END%20CERTIFICATE-----&key=-----BEGIN%20RSA%20PRIVATE%20KEY-----%0aMIIEpAIBAAKCAQEA4AVM6J4Qg3DIFWr%2feJ5GRmIATYsJIepKbrDy70sq%2budcO8R8%0axxak0oMZ%2f9mUdpjSNK%2ffLVTuCO0kxTfQ9VUWJllX7ThD6Zh9ZvlC%2fnf%2fOEZLm3Zb%0aBgu8rbC8E9wuDOkKbJLnINgdhtowIydLK2MJ%2b%2bq62bFV89jkHWTMcKyyqHENo3h%0ac%2blkpd9vnp8rZTinaVb7nX26uQqAFZYRo%2bWU0G%2fNPsq40QVSMoqPxyEz4qXo0hvu%0aIlCXmzFZq%2f6fCVPEKPLhQgMmpdBkMz4dVOazREfqXdjMD2%2bQXSNiA1AwWr8l0r4r%0atzlxEYDJIR41yXp0xMl3KoolxMyvLBqZy32niQIDAQABAoIBAQCmbGmhWmPsMeoC%0at1WJFxQgD4goE0U6k%2bKt7vjbOt14Pk6v%2fB2yjaju1wSGpO59WLS4%2fXrwI2se6IXr%0amba7u3VUEgWXLriNHoLy7%2fSMNTs%2bZEKhAMG36eNe3tVdT7busTag31r6sEMGGwCs%0aIwpU%2bazosk0oylWLEX%2fm%2fuHWEs1eaIEWWWtgHB%2bKZrrP7Rr9RYfVQ144DxmOxS3C%0aa9%2bmST62WqAVPR6POWGEfZqnZl%2fePWZPcQYbFrhwnnefNoYBl%2fbnLZBo8rbNWxAq%0aOEOuKfkrBzglKG%2f39WKPw8rj4JIVzY0yOuFCW6xCDWRkOrhU8Ol%2f3FvwDa3uJpkp%0amgPr4TgxAoGBAPGPLmxSuOYR97mDAXxrs037F2GCbqWvI6m7%2fezWe9yn%2bbMpjSIW%0afsgtq4FsyqzPueEkDdQWi3xh6nu2WI%2f1Tl875opGAqEIJMqss%2fu11tnva5wzu1cC%0aL6H85A5%2bHMOBvP3sm6CObKcVw92h7kxynVIUJJWhjfeZMN8gBFFpKIVFAoGBAO1p%0atXBmXLC%2fYKKvtHI3M16%2fZopvM8ZqU2HcAHaw214Refw9JJ%2fe3%2fxTNfSerVTyCAQO%0a1AdWTzJKBN8jmSYv1Mk1D3RpQPNR7wVzi46KR081AU41uMpqIGVOwHtyVnW%2fZfLr%0ac1DLIK8Cx8aHfoxffwzoMO5SEQSooeZfOLhsfDN1AoGBAKQTUEINsj%2b75psgbAr6%0aELGgItJ9yPBLVRr%2bcUzEpx9LDWVvjMihpP4NX1gq8EOPWT%2bewLHVmmsjCyV6xw8J%0aXXF8e2xif3in0m3D%2fwCzE7u2T06rKM3B017hKnrZmGoHnrqPU2osM4sOUpshWX6d%0av1Q4EF1%2bfbK3YCW%2bVpCBsB9NAoGAQo%2buhNLODee56iKkzpjXWCsFTq6ar3hD5F3P%0a63buKdNwhd2GlSPhXFbf%2b7M5GWW6BZk6rMvv7EOAVice2uvyFm8%2f4%2f1WbmF8R%2bT7%0aLX1rPLO5p%2fm701QpvP11TabiwqRkqtSEQhSRF0AKTojSW%2fyyHCZFAawUhV%2fZ9EKi%0aHmKb97kCgYAyzmFc2it0HqnsOnRybop603nqMtWGTQO4cxa93HUDpYajuK2K3Dfr%0axUj6lG3z%2foKJGGE2JqgZ6LBAhNJtJWJu2ox3pKGE63QjLJnVwb8y1NFYpe%2fcrbLe%0aPuBwIR0L7drXxfv7O5btY7h6QI2d1%2fUIAQPAWbxLoTM%2bndQ%2fuPEdfA%3d%3d%0a-----END%20RSA%20PRIVATE%20KEY----- - label: LiveAPI Perl lang: Perl source: REDACTED_PRIVATE_KEY_EXAMPLE - label: LiveAPI PHP lang: PHP source: REDACTED_PRIVATE_KEY_EXAMPLE x-cpanel-api-version: UAPI x-cpanel-available-version: cPanel 11.42 servers: - description: A server running cPanel. url: https://{host}:{port}/execute variables: host: default: cpanel-server.tld description: The hostname of a server running cPanel. port: default: '2083' description: The cPanel port. /SSL/installed_host: get: x-readonly: true description: 'This function retrieves information about a certificate that is installed on a domain''s dedicated IP address. **Important:** * If you do **not** possess a dedicated IP address, this function will **fail**. For non-dedicated IP addresses, use the `SSL::installed_hosts` function. * When you disable the _Calendars and Contacts_, _Receive Mail_, _Web Disk_ , _Webmail_ , **and** _Web Server_ roles, the system **disables** this function.' operationId: SSL-installed_host parameters: - description: 'The domain name. **Note:** The parameter defaults to the account''s main domain.' in: query name: domain required: false schema: example: example.com format: domain type: string - description: 'Verify the certificate. * `1` — Verify the certificate. * `0` — Do **not** verify the certificate.' in: query name: verify_certificate required: false schema: default: 0 enum: - 0 - 1 example: 1 type: integer responses: '200': content: application/json: schema: properties: apiversion: description: The version of the API. example: 3 type: integer func: description: The name of the method called. example: installed_host type: string module: description: The name of the module called. example: SSL type: string result: properties: data: properties: certificate: description: An object containing the certificate information. properties: domains: description: The domains that the certificate covers. items: example: example.com format: domain type: string type: array ecdsa_curve_name: description: 'The ECDSA curve that the certificate''s key uses. * `prime256v1` * `secp384r1` * `null` — The certificate''s key is **not** an ECDSA key.' enum: - prime256v1 - secp384r1 example: prime256v1 type: - string - 'null' ecdsa_public: description: 'The certificate''s key''s ECDSA compressed public point, in hexadecimal format. * `null` — The certificate''s key is **not** an ECDSA key.' example: null type: - string - 'null' id: description: The certificate's ID. example: example_com_c69ce_37ff5_1397169490_169c717cb2c260281df792788accf041 type: string is_self_signed: description: 'Whether the certificate is self-signed. * `1` — Self-signed. * `0` — Not self-signed.' enum: - 0 - 1 example: 1 type: integer issuer.commonName: description: The issuer's Common Name, typically a domain name. example: example.com type: string issuer.organizationName: description: The certificate's organization. example: Organization type: string issuer_text: description: The X.509 information about the issuer that contains CSR information. example: 'commonName example.com countryName US emailAddress username@example.com organizationName Example stateOrProvinceName Texas localityName Houston' type: string key_algorithm: description: "The certificate's key's algorithm.\n\n * `rsaEncryption` — RSA.\n * `id-ecPublicKey` — ECDSA." enum: - rsaEncryption - id-ecPublicKey example: rsaEncryption type: string modulus: description: 'The certificate''s key''s modulus, in hexadecimal format. * `null` — The certificate''s key is **not** an RSA key.' example: a673c3b17344664b35f8791f562d3aea6bf4d8faa3ae3fc0a519380fd453964a36677c34d48677ecb7f5ed035df026f5f0f8fbfe21745e52daf1f3b9e58c73f0baefdb709320e2202e7d05250b051a59b30ff1fef22d83d7140c1c81cea314a0890ce8d2226799872181c58a74016c7aaa2cff5ac72b575cecde8f304aa572a2ea03d8b173ab76c6e8cdb9dfd0da81e1119cefd4b8b4dbfbe0e46c7f1ee2fe8b5fd5504e58ccbc0d13b4fa41ecc9ebd0dabe1d1fec5c724f748167e7c0553e997f9b77eb36abce70973f06df151748d41b758de3efd7afa6f2464a1547f5ff158469d96e248be464df9eda0e7ce854a89332a2c1278b17c425368a9604f454db type: - string - 'null' modulus_length: description: 'The length, in bits, of the certificate''s key''s modulus. * `null` — The certificate''s key is **not** an RSA key.' example: 2048 minimum: 1 type: - integer - 'null' not_after: description: The certificate's expiration time. example: 1397169490 format: unix_timestamp type: integer not_before: description: The certificate's start time. example: 1365633490 format: unix_timestamp type: integer signature_algorithm: description: The signature algorithm of the certificate. example: sha256WithRSAEncryption type: string subject.commonName: description: The certificate's Common Name. example: example.com type: string subject_text: description: The X.509 information about the certificate's subject that contains CSR information. example: 'commonName example.com' type: string validation_type: description: 'The certificate''s validation type. * `ev` — Extended Validation. * `ov` — Organization Validation. * `dv` — Domain Validation. * `null` — The system could not parse and determine the certificate''s validation type.' enum: - ev - ov - dv example: dv type: - string - 'null' verify_error: description: 'Any errors that exist during the certificate verification process. If there are no errors, this will return an empty string. **Note:** You **must** set the `verify_certificate` parameter to `1` for this return to appear.' example: '' type: string type: object host: description: The issuer's hostname. example: example.com format: domain type: string type: object errors: description: List of errors if the API failed. example: null items: type: string type: - array - 'null' messages: description: List of messages generated by the API. example: null items: type: string type: - array - 'null' metadata: properties: {} status: description: '* `1` — Success. * `0` — Failed. Check the `errors` field for more details.' enum: - 0 - 1 example: 1 type: integer warnings: description: List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API. example: null items: type: string type: - array - 'null' type: object type: object description: HTTP Request was successful. summary: Return SSL certificate's info for dedicated IP tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "uapi --output=jsonpretty \\\n --user=username \\\n SSL \\\n installed_host\n" - label: URL lang: HTTP source: https://hostname.example.com:2083/cpsess##########/execute/SSL/installed_host - label: LiveAPI Perl lang: Perl source: "#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_installed_host.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend//\n# to .../frontend//api_examples/SSL_installed_host.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n q/SSL/,\n q/installed_host/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n my $data = $response->{cpanelresult}{result}{data};\n # Do something with the $data\n # So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n # Report errors:\n print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n require JSON;\n my $str = JSON->new->pretty->encode($_[0]);\n return $str;\n}\n" - label: LiveAPI PHP lang: PHP source: " is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_installed_host.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend//\n// to .../frontend//api_examples/SSL_installed_host.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n 'SSL',\n 'installed_host'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n $data = $response['cpanelresult']['result']['data'];\n // Do something with the $data\n // So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n // Report errors:\n print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n return json_encode($data, JSON_PRETTY_PRINT);\n}" x-cpanel-api-version: UAPI x-cpanel-available-version: cPanel 11.42 servers: - description: A server running cPanel. url: https://{host}:{port}/execute variables: host: default: cpanel-server.tld description: The hostname of a server running cPanel. port: default: '2083' description: The cPanel port. /SSL/installed_hosts: get: x-readonly: true description: 'This function retrieves a list of the account''s websites, their domains, and certificate information. **Important:** For a dedicated IP address, use the UAPI `SSL::installed_host` function. **Important:** When you disable the *CalendarContact* , *MailReceive* , *WebDisk* , *Webmail* , and *WebServer* roles, the system **disables** this function.' operationId: SSL-installed_hosts parameters: [] responses: '200': content: application/json: schema: properties: apiversion: description: The version of the API. example: 3 type: integer func: description: The name of the method called. example: installed_hosts type: string module: description: The name of the module called. example: SSL type: string result: properties: data: items: properties: certificate: description: An object that contains information about each certificate. properties: auto_ssl_provider: description: The AutoSSL provider's name. example: cPanel type: string auto_ssl_provider_display_name: description: The AutoSSL provider's display name. example: Sectigo type: string domains: description: The domains that the certificate covers. items: example: example.com format: domain type: string type: array ecdsa_curve_name: description: 'The ECDSA curve that the certificate''s key uses. * `prime256v1` * `secp384r1` * `null` — The certificate''s key is **not** an ECDSA key.' enum: - prime256v1 - secp384r1 example: prime256v1 type: - string - 'null' ecdsa_public: description: 'The certificate''s key''s ECDSA compressed public point, in hexadecimal format. * `null` — The certificate''s key is **not** an ECDSA key.' example: null type: - string - 'null' id: description: The certificate's ID. example: example_com_a74f7_9dddf_1446659822_eae1ff43c4ec1991e195877c55755eff type: string is_autossl: description: 'Whether the AutoSSL service provided the certificate. * `1` - Provided by the AutoSSL service. * `0` - Not provided by the AutoSSL service.' enum: - 0 - 1 example: 1 type: integer is_self_signed: description: 'Whether the certificate is self-signed. * `1` - Self-signed. * `0` - Not self-signed.' enum: - 0 - 1 example: 1 type: integer issuer.commonName: description: The name that issued the certificate. example: example.com format: domain type: string issuer.organizationName: description: The certificate's organization name. example: The Example Organization type: string issuer_text: description: The issuer's X.509 information. example: 'example.com countryName US emailAddress username@example.com organizationName Example stateOrProvinceName Texas localityName Houston' type: string key_algorithm: description: 'The certificate''s key''s algorithm. * `rsaEncryption` — RSA. * `id-ecPublicKey` — ECDSA.' enum: - rsaEncryption - id-ecPublicKey example: rsaEncryption type: string modulus: description: 'The certificate''s key''s modulus, in hexadecimal format. * `null` — The certificate''s key is **not** an RSA key.' example: a673c3b17344664b35f8791f562d3aea6bf4d8faa3ae3fc0a519380fd453964a36677c34d48677ecb7f5ed035df026f5f0f8fbfe21745e52daf1f3b9e58c73f0baefdb709320e2202e7d05250b051a59b30ff1fef22d83d7140c1c81cea314a0890ce8d2226799872181c58a74016c7aaa2cff5ac72b575cecde8f304aa572a2ea03d8b173ab76c6e8cdb9dfd0da81e1119cefd4b8b4dbfbe0e46c7f1ee2fe8b5fd5504e58ccbc0d13b4fa41ecc9ebd0dabe1d1fec5c724f748167e7c0553e997f9b77eb36abce70973f06df151748d41b758de3efd7afa6f2464a1547f5ff158469d96e248be464df9eda0e7ce854a89332a2c1278b17c425368a9604f454db format: hex type: - string - 'null' modulus_length: description: 'The length, in bits, of the certificate''s key''s modulus. * `null` — The certificate''s key is **not** an RSA key.' example: 2048 minimum: 1 type: - integer - 'null' not_after: description: When the certificate expired. example: 1446659822 format: unix_timestamp type: integer not_before: description: When the certificate started. example: 1415123822 format: unix_timestamp type: integer signature_algorithm: description: The signature algorithm of the certificate. example: sha256WithRSAEncryption format: sha256 type: string subject.commonName: description: The certificate's common name. example: example.com format: domain type: string subject_text: description: The subject's X.509 information. example: 'commonName example.com' type: string validation_type: description: 'The certificate''s validation type. **Note:** * `ev` - Extended Validation. * `ov` - Organization Validation. * `dv` - Domain Validation. * null - The system could not parse and determine the certificate''s validation type.' enum: - ev - ov - dv example: dv type: - string - 'null' type: object certificate_text: description: The certificate's text. example: REDACTED_CERTIFICATE_EXAMPLE format: pem-certificate type: string docroot: description: The document root of the domain that the certificate covers. example: /home/username/public_html format: path type: string domains: description: The domains that the certificate covers. items: example: example.com format: domain type: string type: array fqdns: description: 'An array of every valid fully qualified domain name (FQDN) on the virtual host, which includes service subdomains (proxy subdomains).' items: example: www.example.com format: domain type: string type: array ip: description: The host's IP address. example: 192.168.0.1 oneOf: - format: ipv4 type: string - format: ipv6 type: string is_primary_on_ip: description: 'Whether the website is primary on the IP address. * `1` - Primary. * `0` - Not primary.' enum: - 0 - 1 example: 1 type: integer mail_sni_status: description: 'Whether SNI is active on the domain. * `1` - Active. * `0` - Inactive.' enum: - 0 - 1 example: 1 type: integer needs_sni: description: 'Whether the website requires SNI to function. * `1` - Requires SNI. * `0` - Does not require SNI.' enum: - 0 - 1 example: 0 type: integer servername: description: The server's hostname. example: example.com format: domain type: string type: object properties: {} type: array errors: description: List of errors if the API failed. example: null items: type: string type: - array - 'null' messages: description: List of messages generated by the API. example: null items: type: string type: - array - 'null' metadata: properties: transformed: description: Post-processing may have transformed the data. enum: - 1 example: 1 type: integer status: description: '* `1` - Success * `0` - Failed: Check the errors field for more details.' enum: - 0 - 1 example: 1 type: integer warnings: description: List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API. example: null items: type: string type: - array - 'null' type: object type: object description: HTTP Request was successful. summary: Return domains with SSL certificate information tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "uapi --output=jsonpretty \\\n --user=username \\\n SSL \\\n installed_hosts\n" - label: URL lang: HTTP source: https://hostname.example.com:2083/cpsess##########/execute/SSL/installed_hosts - label: LiveAPI Perl lang: Perl source: "#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_installed_hosts.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend//\n# to .../frontend//api_examples/SSL_installed_hosts.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n q/SSL/,\n q/installed_hosts/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n my $data = $response->{cpanelresult}{result}{data};\n foreach my $item (@{$data}) {\n # Do something with the $item\n }\n\n # So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n # Report errors:\n print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n require JSON;\n my $str = JSON->new->pretty->encode($_[0]);\n return $str;\n}\n" - label: LiveAPI PHP lang: PHP source: " is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_installed_hosts.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend//\n// to .../frontend//api_examples/SSL_installed_hosts.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n 'SSL',\n 'installed_hosts'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n $data = $response['cpanelresult']['result']['data'];\n foreach ($data as $item) {\n // Do something with the $item\n }\n\n // So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n // Report errors:\n print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n return json_encode($data, JSON_PRETTY_PRINT);\n}" x-cpanel-api-version: UAPI x-cpanel-available-version: cPanel 11.42 servers: - description: A server running cPanel. url: https://{host}:{port}/execute variables: host: default: cpanel-server.tld description: The hostname of a server running cPanel. port: default: '2083' description: The cPanel port. /SSL/is_autossl_check_in_progress: get: x-readonly: true description: 'This function verifies whether the `autossl_check` task is in progress for the current user. **Important:** When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system **disables** this function.' operationId: SSL-is_autossl_check_in_progress parameters: [] responses: '200': content: application/json: schema: properties: apiversion: description: The version of the API. example: 3 type: integer func: description: The name of the method called. example: is_autossl_check_in_progress type: string module: description: The name of the module called. example: SSL type: string result: properties: data: description: 'Whether the `autossl_check` task is in progress for the current user. * `1` - In progress. * `0` - **Not** currently in progress.' enum: - 0 - 1 example: 1 type: integer errors: description: List of errors if the API failed. example: null items: type: string type: - array - 'null' messages: description: List of messages generated by the API. example: null items: type: string type: - array - 'null' metadata: properties: {} status: description: '* `1` - Success. * `0` - Failed. Check the `errors` field for more details.' enum: - 0 - 1 example: 1 type: integer warnings: description: List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API. example: null items: type: string type: - array - 'null' type: object type: object description: HTTP Request was successful. summary: Return whether AutoSSL check in progress tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "uapi --output=jsonpretty \\\n --user=username \\\n SSL \\\n is_autossl_check_in_progress\n" - label: URL lang: HTTP source: https://hostname.example.com:2083/cpsess##########/execute/SSL/is_autossl_check_in_progress - label: LiveAPI Perl lang: Perl source: "#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_is_autossl_check_in_progress.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend//\n# to .../frontend//api_examples/SSL_is_autossl_check_in_progress.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n q/SSL/,\n q/is_autossl_check_in_progress/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n my $data = $response->{cpanelresult}{result}{data};\n # Do something with the $data\n # So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n # Report errors:\n print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n require JSON;\n my $str = JSON->new->pretty->encode($_[0]);\n return $str;\n}\n" - label: LiveAPI PHP lang: PHP source: " is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_is_autossl_check_in_progress.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend//\n// to .../frontend//api_examples/SSL_is_autossl_check_in_progress.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n 'SSL',\n 'is_autossl_check_in_progress'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n $data = $response['cpanelresult']['result']['data'];\n // Do something with the $data\n // So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n // Report errors:\n print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n return json_encode($data, JSON_PRETTY_PRINT);\n}" x-cpanel-api-version: UAPI x-cpanel-available-version: cPanel 68 servers: - description: A server running cPanel. url: https://{host}:{port}/execute variables: host: default: cpanel-server.tld description: The hostname of a server running cPanel. port: default: '2083' description: The cPanel port. /SSL/is_mail_sni_supported: get: x-readonly: true description: 'This function checks whether the sslinstall feature is enabled. **Warning:** Mail SNI is always enabled. * Mail SNI is **not** compatible with Webmail and will **not** function for any Webmail connection. Webmail connections use the cPanel service SSL certificate. * Functions that enable Mail SNI succeed with a warning that Mail SNI is always enabled. * Functions that disable Mail SNI will fail and make no changes. **Important:** When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system **disables** this function.' operationId: SSL-is_mail_sni_supported parameters: [] responses: '200': content: application/json: schema: properties: apiversion: description: The version of the API. example: 3 type: integer func: description: The name of the method called. example: is_mail_sni_supported type: string module: description: The name of the module called. example: SSL type: string result: properties: data: description: 'Whether the sslinstall feature is enabled. * `1` - Enabled. * `0` - Disabled.' enum: - 0 - 1 example: 1 type: integer errors: description: List of errors if the API failed. example: null items: type: string type: - array - 'null' messages: description: List of messages generated by the API. example: null items: type: string type: - array - 'null' metadata: properties: {} status: description: '* `1` - Success. * `0` - Failed. Check the `errors` field for more details.' enum: - 0 - 1 example: 1 type: integer warnings: description: List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API. example: null items: type: string type: - array - 'null' type: object type: object description: HTTP Request was successful. summary: Return whether mail SNI is enabled tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "uapi --output=jsonpretty \\\n --user=username \\\n SSL \\\n is_mail_sni_supported\n" - label: URL lang: HTTP source: https://hostname.example.com:2083/cpsess##########/execute/SSL/is_mail_sni_supported - label: LiveAPI Perl lang: Perl source: "#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_is_mail_sni_supported.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend//\n# to .../frontend//api_examples/SSL_is_mail_sni_supported.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n q/SSL/,\n q/is_mail_sni_supported/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n my $data = $response->{cpanelresult}{result}{data};\n # Do something with the $data\n # So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n # Report errors:\n print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n require JSON;\n my $str = JSON->new->pretty->encode($_[0]);\n return $str;\n}\n" - label: LiveAPI PHP lang: PHP source: " is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_is_mail_sni_supported.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend//\n// to .../frontend//api_examples/SSL_is_mail_sni_supported.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n 'SSL',\n 'is_mail_sni_supported'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n $data = $response['cpanelresult']['result']['data'];\n // Do something with the $data\n // So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n // Report errors:\n print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n return json_encode($data, JSON_PRETTY_PRINT);\n}" x-cpanel-api-version: UAPI x-cpanel-available-version: cPanel 11.48 servers: - description: A server running cPanel. url: https://{host}:{port}/execute variables: host: default: cpanel-server.tld description: The hostname of a server running cPanel. port: default: '2083' description: The cPanel port. /SSL/is_sni_supported: get: x-readonly: true description: 'This function checks whether the Apache web server supports SNI. **Important:** When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system **disables** this function.' operationId: SSL-is_sni_supported parameters: [] responses: '200': content: application/json: schema: properties: apiversion: description: The version of the API. example: 3 type: integer func: description: The name of the method called. example: is_sni_supported type: string module: description: The name of the module called. example: SSL type: string result: properties: data: description: 'Whether the Apache web server supports SNI. * `1` - Supported. * `0` - **Not** supported.' enum: - 0 - 1 example: 1 type: integer errors: description: List of errors if the API failed. example: null items: type: string type: - array - 'null' messages: description: List of messages generated by the API. example: null items: type: string type: - array - 'null' metadata: properties: {} status: description: '* `1` - Success. * `0` - Failed. Check the `errors` field for more details.' enum: - 0 - 1 example: 1 type: integer warnings: description: List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API. example: null items: type: string type: - array - 'null' type: object type: object description: HTTP Request was successful. summary: Return whether Apache web server supports mail SNI tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "uapi --output=jsonpretty \\\n --user=username \\\n SSL \\\n is_sni_supported\n" - label: URL lang: HTTP source: https://hostname.example.com:2083/cpsess##########/execute/SSL/is_sni_supported - label: LiveAPI Perl lang: Perl source: "#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_is_sni_supported.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend//\n# to .../frontend//api_examples/SSL_is_sni_supported.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n q/SSL/,\n q/is_sni_supported/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n my $data = $response->{cpanelresult}{result}{data};\n # Do something with the $data\n # So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n # Report errors:\n print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n require JSON;\n my $str = JSON->new->pretty->encode($_[0]);\n return $str;\n}\n" - label: LiveAPI PHP lang: PHP source: " is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_is_sni_supported.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend//\n// to .../frontend//api_examples/SSL_is_sni_supported.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n 'SSL',\n 'is_sni_supported'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n $data = $response['cpanelresult']['result']['data'];\n // Do something with the $data\n // So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n // Report errors:\n print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n return json_encode($data, JSON_PRETTY_PRINT);\n}" x-cpanel-api-version: UAPI x-cpanel-available-version: cPanel 11.42 servers: - description: A server running cPanel. url: https://{host}:{port}/execute variables: host: default: cpanel-server.tld description: The hostname of a server running cPanel. port: default: '2083' description: The cPanel port. /SSL/list_certs: get: x-readonly: false x-rollback: none description: 'This function lists an account''s certificates. **Important:** When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system **disables** this function.' operationId: SSL-list_certs parameters: [] responses: '200': content: application/json: schema: properties: apiversion: description: The version of the API. example: 3 type: integer func: description: The name of the method called. example: list_certs type: string module: description: The name of the module called. example: SSL type: string result: properties: data: items: properties: created: description: The date the certificate was created. example: 1569884400 format: unix_timestamp type: integer domain_is_configured: description: 'Whether the certificate is installed on the account. * `1` — Installed. * `0` — Not installed.' enum: - 1 - 0 example: 1 type: integer domains: description: A list of domains that the certificate covers. items: example: example.com type: string type: array ecdsa_curve_name: description: 'The ECDSA curve that the certificate''s key uses. * `prime256v1` * `secp384r1` * `null` — The certificate''s key is **not** an ECDSA key.' enum: - prime256v1 - secp384r1 example: prime256v1 type: - string - 'null' ecdsa_public: description: 'The certificate''s key''s ECDSA compressed public point, in hexadecimal format. * `null` — The certificate''s key is **not** an ECDSA key.' example: null type: - string - 'null' friendly_name: description: The certificate's friendly name. example: TestCert type: string id: description: The certificate's ID. example: example_com_c69ce_37ff5_1397169490_169c717cb2c260281df792788accf041 type: string is_self_signed: description: 'Whether the certificate is self-signed. * `1` — Self-signed. * `0` — Not self-signed.' enum: - 1 - 0 example: 1 type: integer issuer.commonName: description: The issuer's name. example: example.com type: string issuer.organizationName: description: The certificate's organization. example: Organization type: string issuer_text: description: The certificate's issuer information. example: 'countryName US stateOrProvinceName TX localityName Houston organizationName WebPros International, LLC commonName WebPros International, LLC Certification Authority' type: string key_algorithm: description: 'The certificate''s key''s algorithm. * `rsaEncryption` — RSA. * `id-ecPublicKey` — ECDSA.' enum: - rsaEncryption - id-ecPublicKey example: rsaEncryption type: string modulus: description: 'The certificate''s key''s modulus, in hexadecimal format. * `null` — The certificate''s key is **not** an RSA key.' example: a673c3b17344664b35f8791f562d3aea6bf4d8faa3ae3fc0a519380fd453964a36677c34d48677ecb7f5ed035df026f5f0f8fbfe21745e52daf1f3b9e58c73f0baefdb709320e2202e7d05250b051a59b30ff1fef22d83d7140c1c81cea314a0890ce8d2226799872181c58a74016c7aaa2cff5ac72b575cecde8f304aa572a2ea03d8b173ab76c6e8cdb9dfd0da81e1119cefd4b8b4dbfbe0e46c7f1ee2fe8b5fd5504e58ccbc0d13b4fa41ecc9ebd0dabe1d1fec5c724f748167e7c0553e997f9b77eb36abce70973f06df151748d41b758de3efd7afa6f2464a1547f5ff158469d96e248be464df9eda0e7ce854a89332a2c1278b17c425368a9604f454db type: - string - 'null' modulus_length: description: 'The length, in bits, of the certificate''s key''s modulus. * `null` — The certificate''s key is **not** an RSA key.' example: 2048 type: - integer - 'null' not_after: description: The certificate's expiration date. example: 1601467200 format: unix_timestamp type: integer not_before: description: The certificate's start date. example: 1569844800 format: unix_timestamp type: integer serial: description: The certificate's serial number. example: 45462cd0d6537b20cf2f3eb8aec07140 type: string signature_algorithm: description: The OID hash algorithm signature of the certificate. example: sha256WithRSAEncryption type: string subject.commonName: description: The certificate's Common Name (CN). example: example.com type: string subject_text: description: The certificate's subject text information. example: 'commonName www.example.com' type: string validation_type: description: 'The certificate''s validation type. * `ev` — Extended Validation. * `ov` — Organization Validation. * `dv` — Domain Validation. * `null` — The system could not parse and determine the certificate''s validation type.' enum: - ev - ov - dv example: dv type: - string - 'null' type: object type: array errors: description: List of errors if the API failed. example: null items: type: string type: - array - 'null' messages: description: List of messages generated by the API. example: null items: type: string type: - array - 'null' metadata: properties: transformed: description: Post-processing may have transformed the data. enum: - 1 example: 1 type: integer status: description: '* `1` — Success. * `0` — Failed. Check the `errors` field for more details.' enum: - 1 - 0 example: 1 type: integer warnings: description: List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API. example: null items: type: string type: - array - 'null' type: object type: object description: HTTP Request was successful. summary: Return all SSL certificates tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "uapi --output=jsonpretty \\\n --user=username \\\n SSL \\\n list_certs\n" - label: URL lang: HTTP source: https://hostname.example.com:2083/cpsess##########/execute/SSL/list_certs - label: LiveAPI Perl lang: Perl source: "#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_list_certs.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend//\n# to .../frontend//api_examples/SSL_list_certs.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n q/SSL/,\n q/list_certs/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n my $data = $response->{cpanelresult}{result}{data};\n foreach my $item (@{$data}) {\n # Do something with the $item\n }\n\n # So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n # Report errors:\n print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n require JSON;\n my $str = JSON->new->pretty->encode($_[0]);\n return $str;\n}\n" - label: LiveAPI PHP lang: PHP source: " is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_list_certs.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend//\n// to .../frontend//api_examples/SSL_list_certs.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n 'SSL',\n 'list_certs'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n $data = $response['cpanelresult']['result']['data'];\n foreach ($data as $item) {\n // Do something with the $item\n }\n\n // So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n // Report errors:\n print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n return json_encode($data, JSON_PRETTY_PRINT);\n}" x-cpanel-api-version: UAPI x-cpanel-available-version: cPanel 11.42 servers: - description: A server running cPanel. url: https://{host}:{port}/execute variables: host: default: cpanel-server.tld description: The hostname of a server running cPanel. port: default: '2083' description: The cPanel port. /SSL/list_csrs: get: x-readonly: false x-rollback: none description: 'This function lists an account''s certificate signing requests (CSR). **Important:** When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system **disables** this function.' operationId: SSL-list_csrs parameters: [] responses: '200': content: application/json: schema: properties: apiversion: description: The version of the API. example: 3 type: integer func: description: The name of the method called. example: list_csrs type: string module: description: The name of the module called. example: SSL type: string result: properties: data: items: properties: commonName: description: The CSR's Common Name or Distinguished Name. example: example.com type: string created: description: The CSR's creation date. example: 1538265600 format: unix_timestamp type: integer domains: description: A list of the domains that the CSR covers. items: example: example.com format: domain type: string type: array ecdsa_curve_name: description: 'The ECDSA curve that the CSR''s key uses. * `prime256v1` * `secp384r1` * `null` — The CSR''s key is **not** an ECDSA key.' enum: - prime256v1 - secp384r1 example: prime256v1 type: - string - 'null' ecdsa_public: description: 'The CSR''s key''s ECDSA compressed public point, in hexadecimal format. * `null` — The CSR''s key is **not** an ECDSA key.' example: null type: - string - 'null' friendly_name: description: The CSR's friendly name. example: TestCSR type: string id: description: The CSR's ID. example: example_com_c69ce_37ff5_1397169490_169c717cb2c260281df792788accf041 type: string key_algorithm: description: 'The CSR''s key''s algorithm. * `rsaEncryption` — RSA. * `id-ecPublicKey` — ECDSA.' enum: - rsaEncryption - id-ecPublicKey example: rsaEncryption type: string modulus: description: 'The CSR''s key''s modulus, in hexadecimal format. * `null` — The CSR''s key is **not** an RSA key.' example: a673c3b17344664b35f8791f562d3aea6bf4d8faa3ae3fc0a519380fd453964a36677c34d48677ecb7f5ed035df026f5f0f8fbfe21745e52daf1f3b9e58c73f0baefdb709320e2202e7d05250b051a59b30ff1fef22d83d7140c1c81cea314a0890ce8d2226799872181c58a74016c7aaa2cff5ac72b575cecde8f304aa572a2ea03d8b173ab76c6e8cdb9dfd0da81e1119cefd4b8b4dbfbe0e46c7f1ee2fe8b5fd5504e58ccbc0d13b4fa41ecc9ebd0dabe1d1fec5c724f748167e7c0553e997f9b77eb36abce70973f06df151748d41b758de3efd7afa6f2464a1547f5ff158469d96e248be464df9eda0e7ce854a89332a2c1278b17c425368a9604f454db type: - string - 'null' type: object type: array errors: description: List of errors if the API failed. example: null items: type: string type: - array - 'null' messages: description: List of messages generated by the API. example: null items: type: string type: - array - 'null' metadata: properties: transformed: description: Post-processing may have transformed the data. enum: - 1 example: 1 type: integer status: description: '* `1` — Success. * `0` — Failed. Check the `errors` field for more details.' enum: - 1 - 0 example: 1 type: integer warnings: description: List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API. example: null items: type: string type: - array - 'null' type: object type: object description: HTTP Request was successful. summary: Return all certificate signing requests tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "uapi --output=jsonpretty \\\n --user=username \\\n SSL \\\n list_csrs\n" - label: URL lang: HTTP source: https://hostname.example.com:2083/cpsess##########/execute/SSL/list_csrs - label: LiveAPI Perl lang: Perl source: "#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_list_csrs.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend//\n# to .../frontend//api_examples/SSL_list_csrs.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n q/SSL/,\n q/list_csrs/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n my $data = $response->{cpanelresult}{result}{data};\n foreach my $item (@{$data}) {\n # Do something with the $item\n }\n\n # So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n # Report errors:\n print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n require JSON;\n my $str = JSON->new->pretty->encode($_[0]);\n return $str;\n}\n" - label: LiveAPI PHP lang: PHP source: " is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_list_csrs.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend//\n// to .../frontend//api_examples/SSL_list_csrs.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n 'SSL',\n 'list_csrs'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n $data = $response['cpanelresult']['result']['data'];\n foreach ($data as $item) {\n // Do something with the $item\n }\n\n // So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n // Report errors:\n print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n return json_encode($data, JSON_PRETTY_PRINT);\n}" x-cpanel-api-version: UAPI x-cpanel-available-version: cPanel 11.42 servers: - description: A server running cPanel. url: https://{host}:{port}/execute variables: host: default: cpanel-server.tld description: The hostname of a server running cPanel. port: default: '2083' description: The cPanel port. /SSL/list_keys: get: x-readonly: false x-rollback: none description: 'This function lists an account''s private keys. **Important:** When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system **disables** this function.' operationId: SSL-list_keys parameters: [] responses: '200': content: application/json: schema: properties: apiversion: description: The version of the API. example: 3 type: integer func: description: The name of the method called. example: list_keys type: string module: description: The name of the module called. example: SSL type: string result: properties: data: items: properties: created: description: The key's creation date. example: 1569844800 format: unix_timestamp type: integer ecdsa_curve_name: description: 'The ECDSA curve that the key uses. * `prime256v1` * `secp384r1` * `null` — The key is **not** an ECDSA key.' enum: - prime256v1 - secp384r1 example: prime256v1 type: - string - 'null' ecdsa_public: description: 'The key''s ECDSA compressed public point, in hexadecimal format. * `null` — The key is **not** an ECDSA key.' example: null type: - string - 'null' friendly_name: description: The key's friendly name. example: TestKey type: string id: description: The key ID. example: b116e_473f5_ad6b3bd9517fb157830d0e37a03bc596 type: string key_algorithm: description: 'The key''s algorithm. * `rsaEncryption` — RSA. * `id-ecPublicKey` — ECDSA.' enum: - rsaEncryption - id-ecPublicKey example: rsaEncryption type: string modulus: description: 'The key''s modulus, in hexadecimal format. * `null` — The key is **not** an RSA key.' example: a673c3b17344664b35f8791f562d3aea6bf4d8faa3ae3fc0a519380fd453964a36677c34d48677ecb7f5ed035df026f5f0f8fbfe21745e52daf1f3b9e58c73f0baefdb709320e2202e7d05250b051a59b30ff1fef22d83d7140c1c81cea314a0890ce8d2226799872181c58a74016c7aaa2cff5ac72b575cecde8f304aa572a2ea03d8b173ab76c6e8cdb9dfd0da81e1119cefd4b8b4dbfbe0e46c7f1ee2fe8b5fd5504e58ccbc0d13b4fa41ecc9ebd0dabe1d1fec5c724f748167e7c0553e997f9b77eb36abce70973f06df151748d41b758de3efd7afa6f2464a1547f5ff158469d96e248be464df9eda0e7ce854a89332a2c1278b17c425368a9604f454db type: - string - 'null' modulus_length: description: 'The length, in bits, of the key''s modulus. * `null` — The key is **not** an RSA key.' example: 2048 minimum: 1 type: - integer - 'null' type: object type: array errors: description: List of errors if the API failed. example: null items: type: string type: - array - 'null' messages: description: List of messages generated by the API. example: null items: type: string type: - array - 'null' metadata: properties: transformed: description: Post-processing may have transformed the data. enum: - 1 example: 1 type: integer status: description: '* `1` — Success. * `0` — Failed. Check the `errors` field for more details.' enum: - 1 - 0 example: 1 type: integer warnings: description: List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API. example: null items: type: string type: - array - 'null' type: object type: object description: HTTP Request was successful. summary: Return all private keys tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "uapi --output=jsonpretty \\\n --user=username \\\n SSL \\\n list_keys\n" - label: URL lang: HTTP source: https://hostname.example.com:2083/cpsess##########/execute/SSL/list_keys - label: LiveAPI Perl lang: Perl source: "#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_list_keys.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend//\n# to .../frontend//api_examples/SSL_list_keys.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n q/SSL/,\n q/list_keys/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n my $data = $response->{cpanelresult}{result}{data};\n foreach my $item (@{$data}) {\n # Do something with the $item\n }\n\n # So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n # Report errors:\n print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n require JSON;\n my $str = JSON->new->pretty->encode($_[0]);\n return $str;\n}\n" - label: LiveAPI PHP lang: PHP source: " is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_list_keys.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend//\n// to .../frontend//api_examples/SSL_list_keys.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n 'SSL',\n 'list_keys'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n $data = $response['cpanelresult']['result']['data'];\n foreach ($data as $item) {\n // Do something with the $item\n }\n\n // So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n // Report errors:\n print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n return json_encode($data, JSON_PRETTY_PRINT);\n}" x-cpanel-api-version: UAPI x-cpanel-available-version: cPanel 11.42 servers: - description: A server running cPanel. url: https://{host}:{port}/execute variables: host: default: cpanel-server.tld description: The hostname of a server running cPanel. port: default: '2083' description: The cPanel port. /SSL/list_ssl_items: get: x-readonly: false x-rollback: none description: 'This function lists SSL-related items on a domain. **Important:** When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system **disables** this function.' operationId: SSL-list_ssl_items parameters: - description: The domain name or names. examples: multiple: summary: Multiple domains. value: domains=example1.com|example2.com single: summary: A single domain. value: example.com in: query name: domains required: false schema: type: string - description: 'The SSL item type or types. * `key` * `csr` * `crt`' examples: multiple: summary: Multiple item types. value: item=key|csr single: summary: A single item type. value: key in: query name: item required: false schema: default: key type: string responses: '200': content: application/json: schema: properties: apiversion: description: The version of the API. example: 3 type: integer func: description: The name of the method called. example: list_ssl_items type: string module: description: The name of the module called. example: SSL type: string result: properties: data: items: properties: host: description: The hostname. example: example.com format: domain type: string id: description: The certificate's ID. example: example_com_a74f7_9dddf_1446659822_eae1ff43c4ec1991e195877c55755eff type: string type: description: 'The type of SSL item. * `key` * `csr` * `crt`' enum: - key - csr - crt example: key type: string type: object type: array errors: description: List of errors if the API failed. example: null items: type: string type: - array - 'null' messages: description: List of messages generated by the API. example: null items: type: string type: - array - 'null' metadata: properties: transformed: description: Post-processing may have transformed the data. enum: - 1 example: 1 type: integer status: description: '* `1` - Success. * `0` - Failed. Check the `errors` field for more details.' enum: - 0 - 1 example: 1 type: integer warnings: description: List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API. example: null items: type: string type: - array - 'null' type: object type: object description: HTTP Request was successful. summary: Return SSL-related items tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "uapi --output=jsonpretty \\\n --user=username \\\n SSL \\\n list_ssl_items\n" - label: URL lang: HTTP source: https://hostname.example.com:2083/cpsess##########/execute/SSL/list_ssl_items - label: LiveAPI Perl lang: Perl source: "#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_list_ssl_items.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend//\n# to .../frontend//api_examples/SSL_list_ssl_items.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n q/SSL/,\n q/list_ssl_items/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n my $data = $response->{cpanelresult}{result}{data};\n foreach my $item (@{$data}) {\n # Do something with the $item\n }\n\n # So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n # Report errors:\n print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n require JSON;\n my $str = JSON->new->pretty->encode($_[0]);\n return $str;\n}\n" - label: LiveAPI PHP lang: PHP source: " is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_list_ssl_items.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend//\n// to .../frontend//api_examples/SSL_list_ssl_items.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n 'SSL',\n 'list_ssl_items'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n $data = $response['cpanelresult']['result']['data'];\n foreach ($data as $item) {\n // Do something with the $item\n }\n\n // So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n // Report errors:\n print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n return json_encode($data, JSON_PRETTY_PRINT);\n}" x-cpanel-api-version: UAPI x-cpanel-available-version: cPanel 11.42 servers: - description: A server running cPanel. url: https://{host}:{port}/execute variables: host: default: cpanel-server.tld description: The hostname of a server running cPanel. port: default: '2083' description: The cPanel port. /SSL/mail_sni_status: get: x-readonly: true description: 'This function retrieves the status of the domain''s SNI mail services. **Warning:** Mail SNI is **not** compatible with Webmail and will not function for any Webmail connection. Webmail connections use the cPanel service SSL certificate. **Note:** Mail SNI is always enabled. * Functions that enable Mail SNI succeed with a warning that Mail SNI is always enabled. * Functions that disable Mail SNI fail and make no changes.' operationId: SSL-mail_sni_status parameters: - description: The account's domain. in: query name: domain required: true schema: example: example.com format: domain type: string responses: '200': content: application/json: schema: properties: apiversion: description: The version of the API. example: 3 type: integer func: description: The name of the method called. example: mail_sni_status type: string module: description: The name of the module called. example: SSL type: string result: properties: data: properties: enabled: description: 'Whether SNI for mail is enabled. * `1` - SNI is enabled. * `0` - SNI is **not** enabled.' enum: - 0 - 1 example: 1 type: integer type: object errors: description: List of errors if the API failed. example: null items: type: string type: - array - 'null' messages: description: List of messages generated by the API. example: null items: type: string type: - array - 'null' metadata: properties: {} status: description: '* `1` - Success. * `0` - Failed. Check the `errors` field for more details.' enum: - 0 - 1 example: 1 type: integer warnings: description: List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API. example: null items: type: string type: - array - 'null' type: object type: object description: HTTP Request was successful. summary: Return status of domain's SNI mail services tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "uapi --output=jsonpretty \\\n --user=username \\\n SSL \\\n mail_sni_status \\\n domain='example.com'\n" - label: URL lang: HTTP source: https://hostname.example.com:2083/cpsess##########/execute/SSL/mail_sni_status?domain=example.com - label: LiveAPI Perl lang: Perl source: "#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_mail_sni_status.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend//\n# to .../frontend//api_examples/SSL_mail_sni_status.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n q/SSL/,\n q/mail_sni_status/,\n {\n 'domain' => 'example.com',\n }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n my $data = $response->{cpanelresult}{result}{data};\n # Do something with the $data\n # So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n # Report errors:\n print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n require JSON;\n my $str = JSON->new->pretty->encode($_[0]);\n return $str;\n}\n" - label: LiveAPI PHP lang: PHP source: " is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_mail_sni_status.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend//\n// to .../frontend//api_examples/SSL_mail_sni_status.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n 'SSL',\n 'mail_sni_status',\n array (\n 'domain' => 'example.com',\n )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n $data = $response['cpanelresult']['result']['data'];\n // Do something with the $data\n // So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n // Report errors:\n print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n return json_encode($data, JSON_PRETTY_PRINT);\n}" x-cpanel-api-version: UAPI x-cpanel-available-version: cPanel 11.48 servers: - description: A server running cPanel. url: https://{host}:{port}/execute variables: host: default: cpanel-server.tld description: The hostname of a server running cPanel. port: default: '2083' description: The cPanel port. /SSL/rebuild_mail_sni_config: get: x-readonly: false x-rollback: none description: 'This function rebuilds the SNI configuration files. **Note:** * You **must** run this function after you change the SNI status through the UAPI''s `enable_mail_sni` or `disable_mail_sni` functions. * Mail SNI is **always** enabled. * Functions that enable Mail SNI succeed with a warning that Mail SNI is always enabled. Functions that disable Mail SNI fail and make no changes. * Functions that disable Mail SNI will fail and make no changes. **Important:** When you disable the _Calendars and Contacts_, _Receive Mail_, _Web Disk_, _Webmail_, **and** _Web Server_ roles, the system **disables** this function.' operationId: SSL-rebuild_mail_sni_config parameters: - description: 'Whether to reload the Dovecot service after the system rebuilds the configuration files. * `1` - Reload Dovecot. * `0` - Do **not** reload Dovecot.' in: query name: reload_dovecot required: false schema: default: 1 enum: - 0 - 1 example: 1 type: integer responses: '200': content: application/json: schema: properties: apiversion: description: The version of the API. example: 3 type: integer func: description: The name of the method called. example: rebuild_mail_sni_config type: string module: description: The name of the module called. example: SSL type: string result: properties: data: properties: success: description: 'Whether the system rebuilt the configuration files. * `1` - Configuration files rebuilt. * `0` - Configuration files **not** rebuilt.' enum: - 0 - 1 example: 1 type: integer type: object errors: description: List of errors if the API failed. example: null items: type: string type: - array - 'null' messages: description: List of messages generated by the API. example: null items: type: string type: - array - 'null' metadata: properties: {} status: description: '* `1` - Success * `0` - Failed: Check the errors field for more details.' enum: - 0 - 1 example: 1 type: integer warnings: description: List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API. example: null items: type: string type: - array - 'null' type: object type: object description: HTTP Request was successful. summary: Start SNI configuration files rebuild tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "uapi --output=jsonpretty \\\n --user=username \\\n SSL \\\n rebuild_mail_sni_config\n" - label: URL lang: HTTP source: https://hostname.example.com:2083/cpsess##########/execute/SSL/rebuild_mail_sni_config - label: LiveAPI Perl lang: Perl source: "#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_rebuild_mail_sni_config.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend//\n# to .../frontend//api_examples/SSL_rebuild_mail_sni_config.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n q/SSL/,\n q/rebuild_mail_sni_config/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n my $data = $response->{cpanelresult}{result}{data};\n # Do something with the $data\n # So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n # Report errors:\n print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n require JSON;\n my $str = JSON->new->pretty->encode($_[0]);\n return $str;\n}\n" - label: LiveAPI PHP lang: PHP source: " is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_rebuild_mail_sni_config.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend//\n// to .../frontend//api_examples/SSL_rebuild_mail_sni_config.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n 'SSL',\n 'rebuild_mail_sni_config'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n $data = $response['cpanelresult']['result']['data'];\n // Do something with the $data\n // So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n // Report errors:\n print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n return json_encode($data, JSON_PRETTY_PRINT);\n}" x-cpanel-api-version: UAPI x-cpanel-available-version: cPanel 11.48 servers: - description: A server running cPanel. url: https://{host}:{port}/execute variables: host: default: cpanel-server.tld description: The hostname of a server running cPanel. port: default: '2083' description: The cPanel port. /SSL/rebuildssldb: get: x-readonly: false x-rollback: none description: This function rebuilds the account's SSL database. operationId: SSL-rebuildssldb parameters: [] responses: '200': content: application/json: schema: properties: apiversion: description: The version of the API. example: 3 type: integer func: description: The name of the method called. example: rebuildssldb type: string module: description: The name of the module called. example: SSL type: string result: properties: data: {} errors: description: List of errors if the API failed. example: null items: type: string type: - array - 'null' messages: description: List of messages generated by the API. example: null items: type: string type: - array - 'null' metadata: properties: {} status: description: '- 1 - Success. - 0 - Failed. Check the `errors` field for more details.' enum: - 1 - 0 example: 1 type: integer warnings: description: List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API. example: null items: type: string type: - array - 'null' type: object type: object description: HTTP Request was successful. summary: Start SSL database rebuild tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "uapi --output=jsonpretty \\\n --user=username \\\n SSL \\\n rebuildssldb\n" - label: URL lang: HTTP source: https://hostname.example.com:2083/cpsess##########/execute/SSL/rebuildssldb - label: LiveAPI Perl lang: Perl source: "#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_rebuildssldb.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend//\n# to .../frontend//api_examples/SSL_rebuildssldb.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n q/SSL/,\n q/rebuildssldb/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n my $data = $response->{cpanelresult}{result}{data};\n # Do something with the $data\n # So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n # Report errors:\n print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n require JSON;\n my $str = JSON->new->pretty->encode($_[0]);\n return $str;\n}\n" - label: LiveAPI PHP lang: PHP source: " is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_rebuildssldb.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend//\n// to .../frontend//api_examples/SSL_rebuildssldb.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n 'SSL',\n 'rebuildssldb'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n $data = $response['cpanelresult']['result']['data'];\n // Do something with the $data\n // So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n // Report errors:\n print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n return json_encode($data, JSON_PRETTY_PRINT);\n}" x-cpanel-api-version: UAPI x-cpanel-available-version: cPanel 11.42 servers: - description: A server running cPanel. url: https://{host}:{port}/execute variables: host: default: cpanel-server.tld description: The hostname of a server running cPanel. port: default: '2083' description: The cPanel port. /SSL/remove_autossl_excluded_domains: get: x-readonly: false x-rollback: none description: 'This function enables AutoSSL for the domains that you specify. **Important:** When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system **disables** this function.' operationId: SSL-remove_autossl_excluded_domains parameters: - description: Enable AutoSSL for this domain. examples: multiple: summary: Multiple domains. value: domains=example1.com,example2.com single: summary: A single domain. value: example.com in: query name: domains required: true schema: type: string responses: '200': content: application/json: schema: properties: apiversion: description: The version of the API. example: 3 type: integer func: description: The name of the method called. example: remove_autossl_excluded_domains type: string module: description: The name of the module called. example: SSL type: string result: properties: data: default: null type: - object - 'null' errors: description: List of errors if the API failed. example: null items: type: string type: - array - 'null' messages: description: List of messages generated by the API. example: null items: type: string type: - array - 'null' metadata: properties: {} status: description: '* `1` - Success. * `0` - Failed. Check the `errors` field for more details.' enum: - 0 - 1 example: 1 type: integer warnings: description: List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API. example: null items: type: string type: - array - 'null' type: object description: HTTP Request was successful. summary: Enable AutoSSL for specifed domains tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "uapi --output=jsonpretty \\\n --user=username \\\n SSL \\\n remove_autossl_excluded_domains \\\n domains='example.com'\n" - label: URL lang: HTTP source: https://hostname.example.com:2083/cpsess##########/execute/SSL/remove_autossl_excluded_domains?domains=example.com - label: LiveAPI Perl lang: Perl source: "#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_remove_autossl_excluded_domains.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend//\n# to .../frontend//api_examples/SSL_remove_autossl_excluded_domains.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n q/SSL/,\n q/remove_autossl_excluded_domains/,\n {\n 'domains' => 'example.com',\n }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n my $data = $response->{cpanelresult}{result}{data};\n # Do something with the $data\n # So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n # Report errors:\n print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n require JSON;\n my $str = JSON->new->pretty->encode($_[0]);\n return $str;\n}\n" - label: LiveAPI PHP lang: PHP source: " is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_remove_autossl_excluded_domains.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend//\n// to .../frontend//api_examples/SSL_remove_autossl_excluded_domains.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n 'SSL',\n 'remove_autossl_excluded_domains',\n array (\n 'domains' => 'example.com',\n )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n $data = $response['cpanelresult']['result']['data'];\n // Do something with the $data\n // So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n // Report errors:\n print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n return json_encode($data, JSON_PRETTY_PRINT);\n}" x-cpanel-api-version: UAPI x-cpanel-available-version: cPanel 66 servers: - description: A server running cPanel. url: https://{host}:{port}/execute variables: host: default: cpanel-server.tld description: The hostname of a server running cPanel. port: default: '2083' description: The cPanel port. /SSL/set_autossl_excluded_domains: get: x-readonly: false x-rollback: none description: 'This function disables AutoSSL for every domain that you specify. **Warning:** This function **replaces** the list of any domains that you previously excluded. To add domains to the list of excluded domains, use the UAPI function `SSL::add_autossl_excluded_domains`. **Important:** When you disable the the Calendar and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system **disables** this function.' operationId: SSL-set_autossl_excluded_domains parameters: - description: 'A comma-separated list of domains for which to disable AutoSSL. **Note:** If you do not include this parameter, the function will **enable** AutoSSL for every domain on the account.' in: query name: domains required: false schema: example: example.com,example.net type: string responses: '200': content: application/json: schema: properties: apiversion: description: The version of the API. example: 3 type: integer func: description: The name of the method called. example: set_autossl_excluded_domains type: string module: description: The name of the module called. example: SSL type: string result: properties: data: enum: - null type: - object - 'null' errors: description: List of errors if the API failed. example: null items: type: string type: - array - 'null' messages: description: List of messages generated by the API. example: null items: type: string type: - array - 'null' metadata: properties: {} status: description: '- 1 - Success - 0 - Failed: Check the errors field for more details.' enum: - 0 - 1 example: 1 type: integer warnings: description: List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API. example: null items: type: string type: - array - 'null' type: object description: HTTP Request was successful. summary: Disable AutoSSL for specifed domains tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "uapi --output=jsonpretty \\\n --user=username \\\n SSL \\\n set_autossl_excluded_domains\n" - label: URL lang: HTTP source: https://hostname.example.com:2083/cpsess##########/execute/SSL/set_autossl_excluded_domains - label: LiveAPI Perl lang: Perl source: "#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_set_autossl_excluded_domains.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend//\n# to .../frontend//api_examples/SSL_set_autossl_excluded_domains.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n q/SSL/,\n q/set_autossl_excluded_domains/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n my $data = $response->{cpanelresult}{result}{data};\n # Do something with the $data\n # So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n # Report errors:\n print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n require JSON;\n my $str = JSON->new->pretty->encode($_[0]);\n return $str;\n}\n" - label: LiveAPI PHP lang: PHP source: " is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_set_autossl_excluded_domains.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend//\n// to .../frontend//api_examples/SSL_set_autossl_excluded_domains.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n 'SSL',\n 'set_autossl_excluded_domains'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n $data = $response['cpanelresult']['result']['data'];\n // Do something with the $data\n // So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n // Report errors:\n print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n return json_encode($data, JSON_PRETTY_PRINT);\n}" x-cpanel-api-version: UAPI x-cpanel-available-version: cPanel 66 servers: - description: A server running cPanel. url: https://{host}:{port}/execute variables: host: default: cpanel-server.tld description: The hostname of a server running cPanel. port: default: '2083' description: The cPanel port. /SSL/set_cert_friendly_name: get: x-readonly: false x-rollback: none description: 'This function changes a certificate''s friendly name. **Important:** When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system **disables** this function.' operationId: SSL-set_cert_friendly_name parameters: - description: The certificate's friendly name. in: query name: friendly_name required: true schema: example: TestCert type: string - description: The certificate's new friendly name. in: query name: new_friendly_name required: true schema: example: TestCert2 type: string responses: '200': content: application/json: schema: properties: apiversion: description: The version of the API. example: 3 type: integer func: description: The name of the method called. example: set_cert_friendly_name type: string module: description: The name of the module called. example: SSL type: string result: properties: data: default: null type: - object - 'null' errors: description: List of errors if the API failed. example: null items: type: string type: - array - 'null' messages: description: List of messages generated by the API. example: null items: type: string type: - array - 'null' metadata: properties: {} status: description: '- 1 - Success - 0 - Failed: Check the errors field for more details.' enum: - 0 - 1 example: 1 type: integer warnings: description: List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API. example: null items: type: string type: - array - 'null' type: object description: HTTP Request was successful. summary: Update SSL certificate's friendly name tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "uapi --output=jsonpretty \\\n --user=username \\\n SSL \\\n set_cert_friendly_name \\\n friendly_name='TestCert' \\\n new_friendly_name='TestCert2'\n" - label: URL lang: HTTP source: https://hostname.example.com:2083/cpsess##########/execute/SSL/set_cert_friendly_name?friendly_name=TestCert&new_friendly_name=TestCert2 - label: LiveAPI Perl lang: Perl source: "#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_set_cert_friendly_name.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend//\n# to .../frontend//api_examples/SSL_set_cert_friendly_name.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n q/SSL/,\n q/set_cert_friendly_name/,\n {\n 'friendly_name' => 'TestCert',\n 'new_friendly_name' => 'TestCert2',\n }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n my $data = $response->{cpanelresult}{result}{data};\n # Do something with the $data\n # So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n # Report errors:\n print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n require JSON;\n my $str = JSON->new->pretty->encode($_[0]);\n return $str;\n}\n" - label: LiveAPI PHP lang: PHP source: " is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_set_cert_friendly_name.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend//\n// to .../frontend//api_examples/SSL_set_cert_friendly_name.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n 'SSL',\n 'set_cert_friendly_name',\n array (\n 'friendly_name' => 'TestCert',\n 'new_friendly_name' => 'TestCert2',\n )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n $data = $response['cpanelresult']['result']['data'];\n // Do something with the $data\n // So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n // Report errors:\n print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n return json_encode($data, JSON_PRETTY_PRINT);\n}" x-cpanel-api-version: UAPI x-cpanel-available-version: cPanel 11.42 servers: - description: A server running cPanel. url: https://{host}:{port}/execute variables: host: default: cpanel-server.tld description: The hostname of a server running cPanel. port: default: '2083' description: The cPanel port. /SSL/set_csr_friendly_name: get: x-readonly: false x-rollback: none description: 'This function changes a certificate signing request''s (CSR) friendly name. **Important:** * You **must** call either the `friendly_name` or `id` parameter. * When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system **disables** this function.' operationId: SSL-set_csr_friendly_name parameters: - description: The CSR's friendly name. in: query name: friendly_name required: true schema: example: TestCSR type: string - description: 'The CSR''s ID. **Note:** To retrieve a CSR''s ID, use the UAPI `list_csrs` function.' in: query name: id required: true schema: example: example_com_eda9d_543fb_a3009b4b01a592390866ab3a47c0df18 type: string - description: The CSR's new friendly name. in: query name: new_friendly_name required: true schema: example: TestCSR2 type: string responses: '200': content: application/json: schema: properties: apiversion: description: The version of the API. example: 3 type: integer func: description: The name of the method called. example: set_csr_friendly_name type: string module: description: The name of the module called. example: SSL type: string result: properties: data: default: null type: - object - 'null' errors: description: List of errors if the API failed. example: null items: type: string type: - array - 'null' messages: description: List of messages generated by the API. example: null items: type: string type: - array - 'null' metadata: properties: {} status: description: '- 1 - Success - 0 - Failed: Check the errors field for more details.' enum: - 0 - 1 example: 1 type: integer warnings: description: List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API. example: null items: type: string type: - array - 'null' type: object description: HTTP Request was successful. summary: Update certificate signing request's friendly name tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "uapi --output=jsonpretty \\\n --user=username \\\n SSL \\\n set_csr_friendly_name \\\n friendly_name='TestCSR' \\\n id='example_com_eda9d_543fb_a3009b4b01a592390866ab3a47c0df18' \\\n new_friendly_name='TestCSR2'\n" - label: URL lang: HTTP source: https://hostname.example.com:2083/cpsess##########/execute/SSL/set_csr_friendly_name?friendly_name=TestCSR&id=example_com_eda9d_543fb_a3009b4b01a592390866ab3a47c0df18&new_friendly_name=TestCSR2 - label: LiveAPI Perl lang: Perl source: "#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_set_csr_friendly_name.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend//\n# to .../frontend//api_examples/SSL_set_csr_friendly_name.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n q/SSL/,\n q/set_csr_friendly_name/,\n {\n 'friendly_name' => 'TestCSR',\n 'id' => 'example_com_eda9d_543fb_a3009b4b01a592390866ab3a47c0df18',\n 'new_friendly_name' => 'TestCSR2',\n }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n my $data = $response->{cpanelresult}{result}{data};\n # Do something with the $data\n # So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n # Report errors:\n print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n require JSON;\n my $str = JSON->new->pretty->encode($_[0]);\n return $str;\n}\n" - label: LiveAPI PHP lang: PHP source: " is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_set_csr_friendly_name.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend//\n// to .../frontend//api_examples/SSL_set_csr_friendly_name.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n 'SSL',\n 'set_csr_friendly_name',\n array (\n 'friendly_name' => 'TestCSR',\n 'id' => 'example_com_eda9d_543fb_a3009b4b01a592390866ab3a47c0df18',\n 'new_friendly_name' => 'TestCSR2',\n )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n $data = $response['cpanelresult']['result']['data'];\n // Do something with the $data\n // So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n // Report errors:\n print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n return json_encode($data, JSON_PRETTY_PRINT);\n}" x-cpanel-api-version: UAPI x-cpanel-available-version: cPanel 11.42 servers: - description: A server running cPanel. url: https://{host}:{port}/execute variables: host: default: cpanel-server.tld description: The hostname of a server running cPanel. port: default: '2083' description: The cPanel port. /SSL/set_default_key_type: get: x-readonly: false x-rollback: none description: This function sets a user’s preferred SSL/TLS key type. operationId: SSL-set_default_key_type parameters: - description: 'The key type to set. * `system` — Use the system’s `ssl_default_key_type` value. * `rsa-2048` — 2,048-bit RSA. * `rsa-4096` — 4,096-bit RSA. * `ecdsa-prime256v1` — ECDSA prime256v1 (“P-256”). * `ecdsa-secp384r1` — ECDSA secp384r1 (“P-384”).' example: ecdsa-prime256v1 in: query name: type required: true schema: enum: - system - rsa-2048 - rsa-4096 - ecdsa-prime256v1 - ecdsa-secp384r1 type: string responses: '200': content: application/json: schema: properties: apiversion: description: The version of the API. example: 3 type: integer func: description: The name of the method called. example: set_default_key_type type: string module: description: The name of the module called. example: SSL type: string result: properties: errors: description: List of errors if the API failed. example: null items: type: string type: - array - 'null' messages: description: List of messages generated by the API. example: null items: type: string type: - array - 'null' metadata: properties: {} status: description: '* `1` — Success. * `0` — Failed. Check the `errors` field for more details.' enum: - 0 - 1 example: 1 type: integer warnings: description: List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API. example: null items: type: string type: - array - 'null' type: object type: object description: HTTP Request was successful. summary: Update SSL TLS key type tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "uapi --output=jsonpretty \\\n --user=username \\\n SSL \\\n set_default_key_type \\\n type='ecdsa-prime256v1'\n" - label: URL lang: HTTP source: https://hostname.example.com:2083/cpsess##########/execute/SSL/set_default_key_type?type=ecdsa-prime256v1 - label: LiveAPI Perl lang: Perl source: "#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_set_default_key_type.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend//\n# to .../frontend//api_examples/SSL_set_default_key_type.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n q/SSL/,\n q/set_default_key_type/,\n {\n 'type' => 'ecdsa-prime256v1',\n }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n my $data = $response->{cpanelresult}{result}{data};\n # Do something with the $data\n # So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n # Report errors:\n print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n require JSON;\n my $str = JSON->new->pretty->encode($_[0]);\n return $str;\n}\n" - label: LiveAPI PHP lang: PHP source: " is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_set_default_key_type.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend//\n// to .../frontend//api_examples/SSL_set_default_key_type.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n 'SSL',\n 'set_default_key_type',\n array (\n 'type' => 'ecdsa-prime256v1',\n )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n $data = $response['cpanelresult']['result']['data'];\n // Do something with the $data\n // So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n // Report errors:\n print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n return json_encode($data, JSON_PRETTY_PRINT);\n}" x-cpanel-api-version: UAPI x-cpanel-available-version: cPanel 92 servers: - description: A server running cPanel. url: https://{host}:{port}/execute variables: host: default: cpanel-server.tld description: The hostname of a server running cPanel. port: default: '2083' description: The cPanel port. /SSL/set_key_friendly_name: get: x-readonly: false x-rollback: none description: 'This function changes a key''s friendly name. **Important:** * You **must** call either the `friendly_name` or `id` parameter. * When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system **disables** this function.' operationId: SSL-set_key_friendly_name parameters: - description: The key's friendly name. in: query name: friendly_name required: true schema: example: TestKey type: string - description: The key's ID. in: query name: id required: true schema: example: a9b72_63971_2cb6d8897b362cfb1548e047d8428b8d type: string - description: The key's new friendly name. in: query name: new_friendly_name required: true schema: example: TestKey2 type: string responses: '200': content: application/json: schema: properties: apiversion: description: The version of the API. example: 3 type: integer func: description: The name of the method called. example: set_key_friendly_name type: string module: description: The name of the module called. example: SSL type: string result: properties: data: default: null type: - object - 'null' errors: description: List of errors if the API failed. example: null items: type: string type: - array - 'null' messages: description: List of messages generated by the API. example: null items: type: string type: - array - 'null' metadata: properties: {} status: description: '- 1 - Success - 0 - Failed: Check the errors field for more details.' enum: - 0 - 1 example: 1 type: integer warnings: description: List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API. example: null items: type: string type: - array - 'null' type: object description: HTTP Request was successful. summary: Update private key's friendly name tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "uapi --output=jsonpretty \\\n --user=username \\\n SSL \\\n set_key_friendly_name \\\n friendly_name='TestKey' \\\n id='a9b72_63971_2cb6d8897b362cfb1548e047d8428b8d' \\\n new_friendly_name='TestKey2'\n" - label: URL lang: HTTP source: https://hostname.example.com:2083/cpsess##########/execute/SSL/set_key_friendly_name?friendly_name=TestKey&id=a9b72_63971_2cb6d8897b362cfb1548e047d8428b8d&new_friendly_name=TestKey2 - label: LiveAPI Perl lang: Perl source: "#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_set_key_friendly_name.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend//\n# to .../frontend//api_examples/SSL_set_key_friendly_name.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n q/SSL/,\n q/set_key_friendly_name/,\n {\n 'friendly_name' => 'TestKey',\n 'id' => 'a9b72_63971_2cb6d8897b362cfb1548e047d8428b8d',\n 'new_friendly_name' => 'TestKey2',\n }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n my $data = $response->{cpanelresult}{result}{data};\n # Do something with the $data\n # So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n # Report errors:\n print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n require JSON;\n my $str = JSON->new->pretty->encode($_[0]);\n return $str;\n}\n" - label: LiveAPI PHP lang: PHP source: " is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_set_key_friendly_name.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend//\n// to .../frontend//api_examples/SSL_set_key_friendly_name.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n 'SSL',\n 'set_key_friendly_name',\n array (\n 'friendly_name' => 'TestKey',\n 'id' => 'a9b72_63971_2cb6d8897b362cfb1548e047d8428b8d',\n 'new_friendly_name' => 'TestKey2',\n )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n $data = $response['cpanelresult']['result']['data'];\n // Do something with the $data\n // So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n // Report errors:\n print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n return json_encode($data, JSON_PRETTY_PRINT);\n}" x-cpanel-api-version: UAPI x-cpanel-available-version: cPanel 11.42 servers: - description: A server running cPanel. url: https://{host}:{port}/execute variables: host: default: cpanel-server.tld description: The hostname of a server running cPanel. port: default: '2083' description: The cPanel port. /SSL/set_primary_ssl: get: x-readonly: false x-rollback: none description: 'This function sets a new primary SSL website for a dedicated IP address. **Important:** When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system **disables** this function.' operationId: SSL-set_primary_ssl parameters: - description: The primary SSL website's servername. in: query name: servername required: true schema: example: hostname.example.com format: domain type: string responses: '200': content: application/json: schema: properties: apiversion: description: The version of the API. example: 3 type: integer func: description: The name of the method called. example: set_primary_ssl type: string module: description: The name of the module called. example: SSL type: string result: properties: data: default: null type: - object - 'null' errors: description: List of errors if the API failed. example: null items: type: string type: - array - 'null' messages: description: List of messages generated by the API. example: null items: type: string type: - array - 'null' metadata: properties: {} status: description: '- 1 - Success - 0 - Failed: Check the errors field for more details.' enum: - 0 - 1 example: 1 type: integer warnings: description: List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API. example: null items: type: string type: - array - 'null' type: object description: HTTP Request was successful. summary: Update SSL website for dedicated IP address tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "uapi --output=jsonpretty \\\n --user=username \\\n SSL \\\n set_primary_ssl \\\n servername='hostname.example.com'\n" - label: URL lang: HTTP source: https://hostname.example.com:2083/cpsess##########/execute/SSL/set_primary_ssl?servername=hostname.example.com - label: LiveAPI Perl lang: Perl source: "#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_set_primary_ssl.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend//\n# to .../frontend//api_examples/SSL_set_primary_ssl.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n q/SSL/,\n q/set_primary_ssl/,\n {\n 'servername' => 'hostname.example.com',\n }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n my $data = $response->{cpanelresult}{result}{data};\n # Do something with the $data\n # So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n # Report errors:\n print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n require JSON;\n my $str = JSON->new->pretty->encode($_[0]);\n return $str;\n}\n" - label: LiveAPI PHP lang: PHP source: " is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_set_primary_ssl.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend//\n// to .../frontend//api_examples/SSL_set_primary_ssl.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n 'SSL',\n 'set_primary_ssl',\n array (\n 'servername' => 'hostname.example.com',\n )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n $data = $response['cpanelresult']['result']['data'];\n // Do something with the $data\n // So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n // Report errors:\n print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n return json_encode($data, JSON_PRETTY_PRINT);\n}" x-cpanel-api-version: UAPI x-cpanel-available-version: cPanel 11.42 servers: - description: A server running cPanel. url: https://{host}:{port}/execute variables: host: default: cpanel-server.tld description: The hostname of a server running cPanel. port: default: '2083' description: The cPanel port. /SSL/show_cert: get: x-readonly: false x-rollback: none description: 'This function retrieves a certificate. **Note:** When you call this parameter, you **must** include either the `id` or the `friendly_name` parameter. **Important:** When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, **and** Web Server roles, the system **disables** this function.' operationId: SSL-show_cert parameters: - description: The certificate's friendly name. in: query name: friendly_name required: false schema: example: TestCert type: string - description: The certificate's ID. in: query name: id required: false schema: example: example_com_c69ce_37ff5_1397169490_169c717cb2c260281df792788accf041 type: string responses: '200': content: application/json: schema: properties: apiversion: description: The version of the API. example: 3 type: integer func: description: The name of the method called. example: show_cert type: string module: description: The name of the module called. example: SSL type: string result: properties: data: properties: cert: description: The contents of the certificate. example: REDACTED_CERTIFICATE_EXAMPLE format: pem-certificate type: string details: description: An object containing the certificate's details. properties: domains: description: A list of the certificate's domains. items: example: example.com format: domain type: string type: array ecdsa_curve_name: description: 'The ECDSA curve that the certificate''s key uses. * `prime256v1` * `secp384r1` * `null` — The certificate''s key is **not** an ECDSA key.' enum: - prime256v1 - secp384r1 example: prime256v1 type: - string - 'null' ecdsa_public: description: 'The certificate''s key''s ECDSA compressed public point, in hexadecimal format. * `null` — The certificate''s key is **not** an ECDSA key.' example: null type: - string - 'null' friendly_name: description: The certificate's friendly name. example: TestCert type: string id: description: The certificate's ID. example: example_com_c69ce_37ff5_1397169490_169c717cb2c260281df792788accf041 type: string is_self_signed: description: 'Whether the certificate is self-signed. * `1` — Self-signed. * `0` — Not self-signed.' enum: - 1 - 0 example: 1 type: integer issuer: description: A object that contains the issuer's details. properties: commonName: description: The issuer's Common Name or Distinguished Name. example: example.com type: string countryName: description: The certificate's two-letter country code. example: US format: ISO-3166-1 (alpha-2) type: string emailAddress: description: The issuer's email address. example: username@example.com format: email type: string localityName: description: The issuer's locality or city. example: Houston type: string organizationName: description: The issuer's organization name. example: Organization type: string stateOrProvinceName: description: The issuer's state or province name. example: Texas type: string type: object key_algorithm: description: 'The certificate''s key''s algorithm. * `rsaEncryption` — RSA. * `id-ecPublicKey` — ECDSA.' enum: - rsaEncryption - id-ecPublicKey example: rsaEncryption type: string modulus: description: 'The certificate''s key''s modulus, in hexadecimal format. * `null` — The certificate''s key is **not** an RSA key.' example: a673c3b17344664b35f8791f562d3aea6bf4d8faa3ae3fc0a519380fd453964a36677c34d48677ecb7f5ed035df026f5f0f8fbfe21745e52daf1f3b9e58c73f0baefdb709320e2202e7d05250b051a59b30ff1fef22d83d7140c1c81cea314a0890ce8d2226799872181c58a74016c7aaa2cff5ac72b575cecde8f304aa572a2ea03d8b173ab76c6e8cdb9dfd0da81e1119cefd4b8b4dbfbe0e46c7f1ee2fe8b5fd5504e58ccbc0d13b4fa41ecc9ebd0dabe1d1fec5c724f748167e7c0553e997f9b77eb36abce70973f06df151748d41b758de3efd7afa6f2464a1547f5ff158469d96e248be464df9eda0e7ce854a89332a2c1278b17c425368a9604f454db type: - string - 'null' not_after: description: The certificate's expiration date. example: 1601467200 format: unix_timestamp type: integer not_before: description: The certificate's start time. example: 1569844800 format: unix_timestamp type: integer signature_algorithm: description: The certificate's OID hash algorithm signature. example: sha256WithRSAEncryption type: string subject: description: An object containing the certificate's ownership details. properties: commonName: description: The certificate's Common Name or Distinguished Name. example: example.com type: string countryName: description: The certificate's two-letter country code. example: US format: ISO-3166-1 (alpha-2) type: string emailAddress: description: The certificate's email address. example: username@example.com format: email type: string localityName: description: The certificate's locality or city. example: Houston type: string organizationName: description: The certificate's organization name. example: Organization type: string stateOrProvinceName: description: The certificate's state or province name. example: Texas type: string type: object validation_type: description: 'The certificate''s validation type. * `ev` — Extended Validation. * `ov` — Organization Validation. * `dv` — Domain Validation. * `null` — The system could not parse and determine the certificate''s validation type.' enum: - ev - ov - dv example: dv type: - string - 'null' type: object text: description: The parsed information from the OpenSSL command-line tool. example: "Certificate:\n Data:\n Version: 3 (0x2)\n Serial Number:\n d1:e8:74:8c:d0:69:d2:55\n Signature Algorithm: sha1WithRSAEncryption\n Issuer: CN = example.com, C = US, emailAddress = username@example.com, O = Example, ST = Texas, L = Houston\n Validity\n Not Before: Apr 10 22:38:10 2013 GMT\n Not After : Apr 10 22:38:10 2014 GMT\n Subject: CN = example.com, C = US, emailAddress = username@example.com, O = Example, ST = Texas, L = Houston\n Subject Public Key Info:\n Public Key Algorithm: rsaEncryption\n Public-Key: (2048 bit)\n Modulus:\n 00:c6:9c:e3:37:1a:fc:e6:1b:e4:29:4d:8e:ee:ec:\n bd:7a:52:12:ef: 34:71:64:77:e0:79:76:6d:ba:f0:\n 77:fd:f0:92:18:b0:84:c3:f7:12:3a:a9:b9:1d:16:\n 6c:a0:10:6d:f0:55:17:35:27:ff:81:a7:46:e6:d4:\n 36:97:34:01:3a:2f:6d:61:9a: 04:20:e3:fd:06:11:\n 8b:a4:5e:4f:6d:0d:93:8e:3b:cc:cb:19:b3:cb:74:\n 7a:54:82:ae:52:9e:46:31:7a:02:44:0b:7b:26:e8:\n 84:aa:91:2b:25:c1:42:0c:cc:5d:c4:d5: c4:cf:df:\n de:4c:7c:22:99:ab:06:79:99:16:1e:a7:49:5b:9b:\n 89:97:18:3c:1e:4b:c6:c5:b5:b2:9d:7d:be:b9:91:\n c6:08:38:7d:dc:81:18:2b:0c:2c:da:29:f4:aa:a2:\n 72:46:d9:c2:68:31:89:51:ab:32:af:7a:8d:9b:a7:\n d8:b8:b5:37:21:03:91:1d:4e:d8:fc:f1:0e:1f:96:\n 17:d6:90:25:c1:3a:1a:76:4c:9e:2b:7e:b9:9c:f5:\n 86:0a:cf:ea: 2f:eb:bc:33:ee:69:49:b9:c2:e6:a0:\n ef:ee:90:19:4a:2a:64:7e:ef:96:46:7e:7d:e2:35:\n ec:d9:cf:34:42:7a:3d:c1:22:b9:68:a2:b3:02:a3:\n 7f:f5\n Exponent: 65537 (0x10001)\n X509v3 extensions:\n X509v3 Subject Key Identifier:\n 6A:A1:EA:62:FB:B2:C4:AC:04:B0:43:DD:56:BE:8A:8D:FA:16:D3:F4\n X509v3 Authority Key Identifier:\n keyid:6A:A1:EA:62:FB:B2:C4:AC:04:B0:43:DD:56:BE:8A:8D:FA:16:D3:F4\n\n X509v3 Basic Constraints:\n CA:TRUE\n Signature Algorithm: sha1WithRSAEncryption\n 3c:1e:f7:3d:20:1b:a2:bd:5c:d6:0f:2a:9e:f3:b0:83:bf:a9:\n a0:90:9b:96:b1:a6:1e:8b:be:7c:f5:72:58:a0:48:3e:68: 43:\n 06:37:63:0a:cb:9c:23:98:c6:9e:f1:73:e8:4b:71:ac:07:fc:\n d0:5c:e1:55:4f:be:a7:75:5a:57:da:a1:c2:46:63:8f:3a:70:\n 4c:42:3c:03:4c:a0:47:a3:fc: ae:15:03:25:a5:78:63:a2:73:\n cd:47:d5:64:7c:d4:f5:85:f7:03:b8:b4:d8:95:75:6a:78:5c:\n e6:c7:69:02:7b:a4:fc:4d:8c:80:7b:c7:1c:71:04:ba:53:71:\n 7a: ce:00:cb:0e:5e:21:89:02:ba:90:02:8e:b5:79:8e:84:50:\n b0:21:63:b0:ac:19:80:c5:1d:a2:95:68:b7:ee:35:10:fa:db:\n f5:bf:b0:16:b1:34:76:f2:d6:ee:07:3b:6d:b6:0c:1d:b4:e5:\n 53:50:23:b8:c4:bf:fe:d6:77:ec:89:68:a0:d8:dd:f4:f5:fa:\n 7d:f6:c4:72:02:b1:e8:87:f7:e1:16:71:80:2e:e7:94:7b:eb:\n c6:a7:07:36:05:6d:34:b4:25:74:e9:c2:2c:9e:3d:bc:97:8e:\n 84:ce:cc:4f:1f:11:67:ad:30:f6:83:3e:be:bb:88:48:10:65:\n f7:4b:2f:80\n" type: string type: object errors: description: List of errors if the API failed. example: null items: type: string type: - array - 'null' messages: description: List of messages generated by the API. example: null items: type: string type: - array - 'null' metadata: properties: {} status: description: '* `1` — Success. * `0` — Failed. Check the `errors` field for more details.' enum: - 1 - 0 example: 1 type: integer warnings: description: List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API. example: null items: type: string type: - array - 'null' type: object type: object description: HTTP Request was successful. summary: Export SSL certificate tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "uapi --output=jsonpretty \\\n --user=username \\\n SSL \\\n show_cert\n" - label: URL lang: HTTP source: https://hostname.example.com:2083/cpsess##########/execute/SSL/show_cert - label: LiveAPI Perl lang: Perl source: "#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_show_cert.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend//\n# to .../frontend//api_examples/SSL_show_cert.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n q/SSL/,\n q/show_cert/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n my $data = $response->{cpanelresult}{result}{data};\n # Do something with the $data\n # So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n # Report errors:\n print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n require JSON;\n my $str = JSON->new->pretty->encode($_[0]);\n return $str;\n}\n" - label: LiveAPI PHP lang: PHP source: " is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_show_cert.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend//\n// to .../frontend//api_examples/SSL_show_cert.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n 'SSL',\n 'show_cert'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n $data = $response['cpanelresult']['result']['data'];\n // Do something with the $data\n // So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n // Report errors:\n print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n return json_encode($data, JSON_PRETTY_PRINT);\n}" x-cpanel-api-version: UAPI x-cpanel-available-version: cPanel 11.42 servers: - description: A server running cPanel. url: https://{host}:{port}/execute variables: host: default: cpanel-server.tld description: The hostname of a server running cPanel. port: default: '2083' description: The cPanel port. /SSL/show_csr: get: x-readonly: false x-rollback: none description: 'This function retrieves a certificate signing request (CSR). **Important:** When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system **disables** this function. **Note:** When you call this function, you **must** include either the `id` or the `friendly_name` parameter.' operationId: SSL-show_csr parameters: - description: The CSR's friendly name. in: query name: friendly_name required: false schema: example: TestCSR type: string - description: The CSR's ID. in: query name: id required: false schema: example: example_com_e095f_0ab2f_ebcbe4a571276f48562241411556647f type: string responses: '200': content: application/json: schema: properties: apiversion: description: The version of the API. example: 3 type: integer func: description: The name of the method called. example: show_csr type: string module: description: The name of the module called. example: SSL type: string result: properties: data: properties: csr: description: The CSR's text. example: REDACTED_CERTIFICATE_EXAMPLE type: string details: description: An object contaning the CSR's contents. properties: commonName: description: The CSR's Common Name or Distinguished Name. example: example.com type: string countryName: description: 'The CSR''s [ISO-3166](https://en.wikipedia.org/wiki/ISO_3166) country code.' example: US type: string created: description: The CSR's creation date. example: 1538265600 format: unix_timestamp type: integer domains: description: A list of the domains that the CSR covers. items: example: example.com type: string type: array emailAddress: description: The CSR's email address. example: username@example.com format: email type: string friendly_name: description: The CSR's friendly name. example: TestCSR type: string id: description: The CSR's ID. example: example_com_c69ce_37ff5_1397169490_169c717cb2c260281df792788accf041 type: string key_algorithm: description: The key algorithm that encrypts the CSR. example: rsaEncryption type: string localityName: description: The certificate's locality or city. example: Houston type: string modulus: description: The CSR's modulus. example: a74f7636fa6ac93ee6836a83a995b55deb5019ea36d7ba3dafb00e38d693acdb0c81b2ff777d6b433a420fae523f127f352a68bcc8b8f2d6ee7b70395bafabd8237ada8164fdddf8376b30375c35d4d4cbcce7d33d08069c17b409176a3689f1ebc97c0b08fe6ae44c19a92ac6d68448e7f1d13f3b360affd4222a51b4f35342de99b5a1fb5548e438f2d824664562a448002eed7fce24dedc7dc3e1ed179973d1dae959b33716eeb410d172708954e00632cbf60a0e26419860c8c0bc285d6bfe4b479de0dd189772a5dae676bd2a92acccc1369821be8cffddd8a7e6ecc061f8a32a9ae0661e4e946ed8e3827b277138d3a76116567cbd129cbd869ef9dddf type: - string - 'null' organizationName: description: The CSR's organization name. example: Organization type: string organizationalUnitName: description: The CSR's organizational unit name. example: Department type: string stateOrProvinceName: description: The CSR's state or province name. example: Texas type: string type: object text: description: The parsed information from the OpenSSL command-line tool. example: "Certificate Request:\n Data:\n Version: 0 (0x0)\n Subject: CN = example.com, C = US, emailAddress = username@example.com, O = Example, ST = Texas, L = Houston\n Subject Public Key Info:\n Public Key Algorithm: rsaEncryption\n Public-Key: (2048 bit)\n Modulus:\n 00:bf:44:22:cb:13:2b:7f:41:9f:48:85:d6:2c:77:\n 03:cf:84:db:90:5c:5a:ed:e5:9c:cb:d6:9d:4b:fc:\n 67:58:b7:db:71:dd:eb:8e:5a:77:6f:03:5d:96:85:\n 60:dc:91:45:59:85:ff:9e:57:76:a5:b5:cd:dc:48:\n 25:89:3f:8f:17:c1:c2:1e:4d:ec:f0:08:1a:a9:cc:\n 2d:45:34:be:82:77:a5:e4:bb:0b:82:bc:82:51:c3:\n ac:1b:ed:c3:a4:b3:e6:14:4f:ba:9e:39:af:08:ae:\n 3c:2c:15:bd:dc:03:17:93:01:95:4f:c0:2a:0f:3b:\n 46:5f:5e:6f:96:d5:b2:dd:53:22:a9:91:e4:36:8e:\n f2:60:5b:ca:b3:72:e6:be:53:8b:9e:b6:72:26:04:\n 85:37:f4:89:c1:78:91:7d:46:96:71:c4:be:39:f3:\n cc:1d:79:bc:33:61:5c:5f:76:52:4a:7d:d0:60:31:\n 79:96:44:6e:6a:77:72:70:1f:3f:08:24:e6:d1:50:\n c0:6a:86:98:df:56:8b:ae:2f:c1:97:bc:ed:4c:70:\n a1:a6:b2:7e:25:97:8f:95:73:a1:84:71:43:da:33:\n 48:d5:44:17:e1:28:1e:37:93:63:fa:ec:45:17:39:\n e5:ff:62:90:6b:b2:eb:11:5b:32:b2:ce:51:0b:8a:\n 3e:95\n Exponent: 65537 (0x10001)\n Attributes:\n a0:00\n Signature Algorithm: sha1WithRSAEncryption\n 41:bd:99:89:7a:1b:c2:71:90:f7:5a:17:05:c9:77:c8:f0:0e:\n 62:0f:85:0d:fb:16:02:74:34:5f:7a:93:3e:50:8e:cf:f4:6f:\n ee:ab:7b:c9:ef:7c:76:59:dd:85:fd:7d:4e:ac:95:9d:b7:ae:\n 8a:89:fc:1f:5b:ee:ee:6b:cd:9b:4e:2d:2a:fb:1b:32:8f:8f:\n 56:70:d1:42:c1:72:ed:04:4b:27:5a:ee:5a:e1:2b:6e:53:59:\n aa:14:25:87:7f:2b:c3:7a:f5:b2:6c:71:2a:93:62:40:ca:87:\n b4:fe:34:a1:95:77:1e:98:f1:71:5e:14:97:61:73:07:8d:bc:\n 3e:e1:f8:47:f7:00:8b:06:a5:1c:84:a3:88:9a:7b:37:74:5d:\n 34:a6:ae:22:ab:a3:b8:9f:d7:ab:60:9a:70:81:15:13:0f:d9:\n ff:ab:7a:2b:fd:cb:96:04:ad:00:6b:e4:74:4e:59:57:a5:9e:\n 84:c7:74:d8:62:08:37:b3:ee:cc:74:b2:b6:26:e8:c0:37:32:\n 19:dc:1c:ff:97:4a:cc:1c:36:c3:a7:2d:ca:77:53:c4:1d:1c:\n 3c:36:5b:f8:90:46:01:48:49:61:9b:ef:bb:b3:a8:94:0b:3f:\n 50:51:93:29:9f:aa:9a:ab:ae:3d:3c:72:8a:0b:bc:2f:3f:19:\n d7:5d:70:14\n" type: string type: object errors: description: List of errors if the API failed. example: null items: type: string type: - array - 'null' messages: description: List of messages generated by the API. example: null items: type: string type: - array - 'null' metadata: properties: {} status: description: '* `1` — Success. * `0` — Failed. Check the `errors` field for more details.' enum: - 1 - 0 example: 1 type: integer warnings: description: List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API. example: null items: type: string type: - array - 'null' type: object type: object description: HTTP Request was successful. summary: Export certificate signing request tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "uapi --output=jsonpretty \\\n --user=username \\\n SSL \\\n show_csr\n" - label: URL lang: HTTP source: https://hostname.example.com:2083/cpsess##########/execute/SSL/show_csr - label: LiveAPI Perl lang: Perl source: "#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_show_csr.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend//\n# to .../frontend//api_examples/SSL_show_csr.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n q/SSL/,\n q/show_csr/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n my $data = $response->{cpanelresult}{result}{data};\n # Do something with the $data\n # So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n # Report errors:\n print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n require JSON;\n my $str = JSON->new->pretty->encode($_[0]);\n return $str;\n}\n" - label: LiveAPI PHP lang: PHP source: " is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_show_csr.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend//\n// to .../frontend//api_examples/SSL_show_csr.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n 'SSL',\n 'show_csr'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n $data = $response['cpanelresult']['result']['data'];\n // Do something with the $data\n // So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n // Report errors:\n print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n return json_encode($data, JSON_PRETTY_PRINT);\n}" x-cpanel-api-version: UAPI x-cpanel-available-version: cPanel 11.42 servers: - description: A server running cPanel. url: https://{host}:{port}/execute variables: host: default: cpanel-server.tld description: The hostname of a server running cPanel. port: default: '2083' description: The cPanel port. /SSL/show_key: get: x-readonly: false x-rollback: none description: 'This function retrieves a private key. **Important:** When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, **and** Web Server roles, the system **disables** this function.' operationId: SSL-show_key parameters: - description: 'The key''s friendly name. **Note:** You **must** use either the `id` or the `friendly_name` parameter.' in: query name: friendly_name required: false schema: example: TestKey type: string - description: 'The key''s ID. **Note:** You **must** use either the `id` or the `friendly_name` parameter.' in: query name: id required: false schema: example: example_com_c69ce_37ff5_1397169490_169c717cb2c260281df792788accf041 type: string responses: '200': content: application/json: schema: properties: apiversion: description: The version of the API. example: 3 type: integer func: description: The name of the method called. example: show_key type: string module: description: The name of the module called. example: SSL type: string result: properties: data: properties: details: description: An object of the key's details. properties: created: description: The key's creation date. example: 1365633415 format: unix_timestamp type: integer ecdsa_curve_name: description: 'The ECDSA curve that the key uses. * `prime256v1` * `secp384r1` * `null` — The key is **not** an ECDSA key.' enum: - prime256v1 - secp384r1 example: prime256v1 type: - string - 'null' ecdsa_public: description: 'The key''s ECDSA compressed public point, in hexadecimal format. * `null` — The key is **not** an ECDSA key.' example: null type: - string - 'null' friendly_name: description: The key's friendly name. example: TestKey type: string id: description: The key's ID. example: example_com_c69ce_37ff5_1397169490_169c717cb2c260281df792788accf041 type: string key: description: The key's contents. example: REDACTED_PRIVATE_KEY_EXAMPLE format: pem-private-key type: string key_algorithm: description: 'The key''s algorithm. * `rsaEncryption` — RSA. * `id-ecPublicKey` — ECDSA.' enum: - rsaEncryption - id-ecPublicKey example: rsaEncryption type: string modulus: description: 'The key''s modulus, in hexadecimal format. * `null` — The key is **not** an RSA key.' example: a673c3b17344664b35f8791f562d3aea6bf4d8faa3ae3fc0a519380fd453964a36677c34d48677ecb7f5ed035df026f5f0f8fbfe21745e52daf1f3b9e58c73f0baefdb709320e2202e7d05250b051a59b30ff1fef22d83d7140c1c81cea314a0890ce8d2226799872181c58a74016c7aaa2cff5ac72b575cecde8f304aa572a2ea03d8b173ab76c6e8cdb9dfd0da81e1119cefd4b8b4dbfbe0e46c7f1ee2fe8b5fd5504e58ccbc0d13b4fa41ecc9ebd0dabe1d1fec5c724f748167e7c0553e997f9b77eb36abce70973f06df151748d41b758de3efd7afa6f2464a1547f5ff158469d96e248be464df9eda0e7ce854a89332a2c1278b17c425368a9604f454db type: - string - 'null' modulus_length: description: 'The length, in bits, of the key''s modulus. * `null` — The key is **not** an RSA key.' example: 2048 type: - integer - 'null' type: object text: description: The raw information from the [OpenSSL](https://www.openssl.org/) command-line tool. example: "Private-Key: (2048 bit)\nmodulus:\n 00:b1:16:ee:3e:de:ff:41:3c:f2:cb:b5:c5:0a:3d:\n c8:0d:64:bc:02:9f:e1:90:c9:7f:da:e8:03:e6:2c:\n 47:9f:e4:ff:5e:0d:95:64:5d:32:c2:b7:c9:01:ae:\n 30:e5:17:da:82:78:f4:15:b9:46:40:eb:8b:99:5c:\n cc:4b:e4:2a:e4:ee:0e:28:29:01:79:ee:d4:90:bc:\n 5d:9e:ab:b0:46:7c:de:4f:df:b2:d7:d1:76:89:88:\n ad:f3:6c:36:f3:a0:07:8c:90:88:19:52:0a:68:a1:\n 4d:c0:26:9e:8d:53:70:91:83:87:f4:8a:d9:b5:0f:\n a7:ed:31:f3:8f:34:d2:ca:e7:d1:31:ea:42:17:5d:\n 4d:48:7d:b3:73:07:72:40:9a:58:55:c8:b3:b6:ff:\n c2:b5:f6:ba:64:bd:3e:06:62:42:cd:44:0b:d2:f1:\n 76:5e:bb:20:55:47:d4:10:86:2d:ec:6b:e7:d2:0e:\n 5d:99:48:ca:4d:66:35:e1:1a:db:1b:96:0a:41:64:\n aa:c4:1b:1f:9d:90:e3:2e:aa:70:61:f7:77:b6:7b:\n f7:44:22:d8:73:0b:53:84:63:c3:f4:a4:19:e2:07:\n f6:0b:42:8a:3d:70:cb:92:24:80:44:e7:36:5d:01:\n a2:e0:e5:cd:50:e1:f7:7c:5a:9a:b5:da:c4:0f:c4:\n 73:f5\npublicExponent: 65537 (0x10001)\nprivateExponent:\n 5b:c3:ae:21:16:1c:df:09:5e:27:01:41:e1:54:b2:\n 5d:7e:5d:8e:5e:9a:dc:14:0e:14:b9:35:8c:08:55:\n f5:1d:0c:d7:07:e2:e9:e7:01:6e:b5:1d:8b:a9:5f:\n dc:d6:c7:7b:e4:81:56:e0:72:ef:21:1f:6d:91:10:\n ac:22:c7:b7:69:44:1c:bb:62:f0:74:39:e1:e6:39:\n fd:06:aa:89:5c:1b:36:f8:8c:0c:19:96:7b:1e:40:\n 45:6b:45:ee:68:76:80:f8:44:0e:1a:dd:19:ea:bc:\n 07:5d:fb:ba:f0:09:dc:dd:73:8d:dc:85:83:b5:61:\n 27:20:43:3d:69:f9:f0:f9:e1:73:76:29:5a:b0:05:\n 23:65:47:e8:39:f0:21:be:17:84:73:0a:08:15:4e:\n 7b:e2:14:6a:72:c7:d3:13:ff:98:ee:96:c9:40:a3:\n d3:0d:6c:90:48:25:7c:79:74:bf:be:fa:18:62:4d:\n c9:95:d4:d9:1a:47:59:4b:98:9a:2f:95:94:f4:4e:\n 78:cc:39:ef:9f:f7:6e:eb:db:cb:e5:95:ef:8f:ee:\n 5b:bf:c7:2a:29:e5:76:16:28:53:04:8e:ef:3f:66:\n 6f:34:a1:21:09:d6:da:ac:dd:ad:8c:2e:72:78:87:\n 01:45:f2:fa:3b:b9:23:2d:cf:5f:66:dc:c7:1c:0b:\n e1\nprime1:\n 00:e9:14:c4:18:92:16:8e:ad:fd:cf:17:f0:8c:f7:\n 55:e0:58:3d:e3:cd:bd:4d:4e:00:64:ee:f0:cf:a5:\n b0:14:19:85:ea:03:a8:be:18:78:34:3b:04:8c:b8:\n be:9a:ee:fc:0a:3e:6f:d2:8f:8f:fd:31:2d:02:97:\n 6e:bb:18:5b:9c:6a:85:6e:25:95:a4:40:4e:0b:91:\n a1:c3:85:bd:84:0c:d5:72:34:13:12:d9:20:56:52:\n 06:53:aa:06:2d:d0:61:2b:0b:d9:94:c6:d7:62:0f:\n c9:7d:17:cc:81:39:b3:59:e5:ce:77:d5:8a:82:ab:\n 2d:37:8a:51:49:3a:aa:c7:37\nprime2:\n 00:c2:80:b7:b4:85:25:37:30:b4:45:f3:3a:69:cf:\n c3:86:43:89:db:d4:09:6b:72:54:a6:89:b4:a7:43:\n 3c:dd:da:c6:46:89:93:0a:05:9a:8c:d6:05:5c:6a:\n 4d:34:1e:84:5b:14:28:b7:ef:d2:be:a5:10:9c:5f:\n e7:35:fb:15:e2:9e:4a:60:0a:73:01:f0:55:6c:75:\n 25:8a:9b:b0:32:d3:28:41:11:e2:85:2d:f6:35:76:\n 6c:68:14:ba:02:98:44:82:e1:c6:ca:f7:07:78:ca:\n ff:1a:60:3a:e1:88:91:55:a1:ae:11:46:29:4b:f0:\n 0f:e0:de:8a:0d:26:91:5c:33\nexponent1:\n 1d:2a:ad:13:4a:0c:aa:94:19:43:b6:02:33:11:ac:\n 5c:63:8e:73:18:46:cd:0a:aa:bf:f6:aa:89:c1:79:\n 14:3a:d1:68:24:47:14:6a:a9:78:17:be:8d:01:7d:\n 50:94:01:54:22:d6:09:6a:4f:a1:66:6a:f4:7d:10:\n ad:36:f2:17:d3:b8:98:bc:f9:49:d1:86:32:aa:69:\n ac:b6:ea:ad:40:91:e1:35:a5:01:61:cc:4b:20:fe:\n 8b:af:a6:10:4b:98:2d:33:d1:69:6d:ac:7c:27:ef:\n 95:c8:c9:9d:8e:23:e4:66:fe:7c:3e:6b:93:c8:69:\n e3:1e:5a:e7:a8:00:c0:e7\nexponent2:\n 6d:2e:3b:f0:c5:5c:a2:a2:60:4f:73:bd:32:70:41:\n dd:38:44:46:75:bb:e3:e8:85:c4:06:40:b6:33:74:\n 13:45:1f:4f:b1:22:2c:da:00:6b:56:28:24:3c:37:\n a2:2e:0f:35:e1:17:0a:49:41:0f:6b:30:eb:d6:99:\n bf:1f:76:a5:83:1d:54:d4:08:c2:e9:d9:c9:cb:e8:\n 8a:e9:e1:fa:65:b5:8e:f1:2f:2a:7b:26:5d:d4:5f:\n fd:fc:c4:7d:78:63:dc:e4:47:e6:de:cb:fe:ee:54:\n 4c:c5:ff:c7:62:15:d2:ef:b2:fa:57:5c:0f:18:6e:\n 91:57:da:3e:8f:8b:c1:29\ncoefficient:\n 00:bd:71:a9:3c:18:7b:0c:93:ab:d5:bf:f3:be:ea:\n 35:45:86:ce:60:0f:67:b3:2d:ba:5f:cf:9f:b6:1a:\n 13:27:cb:da:e7:ad:f3:c7:c2:06:7c:9e:00:d5:6c:\n 07:74:71:2c:35:39:c9:4b:24:cc:11:fd:60:c2:a2:\n 0b:28:b9:8b:4d:48:c6:0d:f0:39:34:dc:e2:c9:3a:\n b8:c6:64:0a:17:df:c4:f1:3d:fb:18:0b:af:ed:27:\n 3f:98:3b:e1:24:72:fc:5d:af:2c:e3:b6:07:3e:e1:\n 2f:fe:db:44:b0:8b:c3:e5:72:82:e5:a4:4a:3a:37:\n 8f:c4:9f:db:e9:1c:33:6a:f3\n" type: string type: object errors: description: List of errors if the API failed. example: null items: type: string type: - array - 'null' messages: description: List of messages generated by the API. example: null items: type: string type: - array - 'null' metadata: properties: {} status: description: '- 1 - Success. - 0 - Failed. Check the `errors` field for more details.' enum: - 1 - 0 example: 1 type: integer warnings: description: List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API. example: null items: type: string type: - array - 'null' type: object type: object description: HTTP Request was successful. summary: Export private key tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "uapi --output=jsonpretty \\\n --user=username \\\n SSL \\\n show_key\n" - label: URL lang: HTTP source: https://hostname.example.com:2083/cpsess##########/execute/SSL/show_key - label: LiveAPI Perl lang: Perl source: "#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_show_key.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend//\n# to .../frontend//api_examples/SSL_show_key.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n q/SSL/,\n q/show_key/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n my $data = $response->{cpanelresult}{result}{data};\n # Do something with the $data\n # So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n # Report errors:\n print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n require JSON;\n my $str = JSON->new->pretty->encode($_[0]);\n return $str;\n}\n" - label: LiveAPI PHP lang: PHP source: " is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_show_key.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend//\n// to .../frontend//api_examples/SSL_show_key.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n 'SSL',\n 'show_key'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n $data = $response['cpanelresult']['result']['data'];\n // Do something with the $data\n // So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n // Report errors:\n print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n return json_encode($data, JSON_PRETTY_PRINT);\n}" x-cpanel-api-version: UAPI x-cpanel-available-version: cPanel 11.42 servers: - description: A server running cPanel. url: https://{host}:{port}/execute variables: host: default: cpanel-server.tld description: The hostname of a server running cPanel. port: default: '2083' description: The cPanel port. /SSL/start_autossl_check: get: x-readonly: false x-rollback: none description: 'This function initiates an AutoSSL check for the user. **Important:** When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system **disables** this function.' operationId: SSL-start_autossl_check parameters: [] responses: '200': content: application/json: schema: properties: apiversion: description: The version of the API. example: 3 type: integer func: description: The name of the method called. example: start_autossl_check type: string module: description: The name of the module called. example: SSL type: string result: properties: data: default: null type: - object - 'null' errors: description: List of errors if the API failed. example: null items: type: string type: - array - 'null' messages: description: List of messages generated by the API. example: null items: type: string type: - array - 'null' metadata: properties: {} status: description: '- 1 - Success. - 0 - Failed. Check the `errors` field for more details.' enum: - 1 - 0 example: 1 type: integer warnings: description: List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API. example: null items: type: string type: - array - 'null' type: object description: HTTP Request was successful. summary: Start AutoSSL for current user tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "uapi --output=jsonpretty \\\n --user=username \\\n SSL \\\n start_autossl_check\n" - label: URL lang: HTTP source: https://hostname.example.com:2083/cpsess##########/execute/SSL/start_autossl_check - label: LiveAPI Perl lang: Perl source: "#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_start_autossl_check.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend//\n# to .../frontend//api_examples/SSL_start_autossl_check.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n q/SSL/,\n q/start_autossl_check/\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n my $data = $response->{cpanelresult}{result}{data};\n # Do something with the $data\n # So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n # Report errors:\n print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n require JSON;\n my $str = JSON->new->pretty->encode($_[0]);\n return $str;\n}\n" - label: LiveAPI PHP lang: PHP source: " is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_start_autossl_check.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend//\n// to .../frontend//api_examples/SSL_start_autossl_check.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n 'SSL',\n 'start_autossl_check'\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n $data = $response['cpanelresult']['result']['data'];\n // Do something with the $data\n // So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n // Report errors:\n print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n return json_encode($data, JSON_PRETTY_PRINT);\n}" x-cpanel-api-version: UAPI x-cpanel-available-version: cPanel 68 servers: - description: A server running cPanel. url: https://{host}:{port}/execute variables: host: default: cpanel-server.tld description: The hostname of a server running cPanel. port: default: '2083' description: The cPanel port. /SSL/toggle_ssl_redirect_for_domains: get: x-readonly: false x-rollback: none description: 'This function enables or disables secure redirects (HTTPS) for the cPanel account''s domains that you specify. **Important:** To call this function, one of the following conditions **must** exist: * AutoSSL **must** exist on the domains for which you enable secure redirects. * A valid SSL certificate **must** exist for each domain for which you wish to enable secure redirects. * You **must** own the domains for which you wish to enable secure redirects.' operationId: SSL-toggle_ssl_redirect_for_domains parameters: - description: 'A comma-separated list of the cPanel account''s domains for which to enable or disable secure redirects. **Important:** To enable or disable redirects for addon domains, you **must** pass the addon domain **and** its subdomain.' in: query name: domains required: true schema: example: main.example,addon.example,addon.main.example type: string - description: 'Whether to enable or disable redirects for the specified domains. * `1` — Enable. * `0` — Disable.' in: query name: state required: true schema: enum: - 0 - 1 example: 1 type: integer responses: '200': content: application/json: schema: properties: apiversion: description: The version of the API. example: 3 type: integer func: description: The name of the method called. example: toggle_ssl_redirect_for_domains type: string module: description: The name of the module called. example: SSL type: string result: properties: data: description: The domains for which the function enabled or disabled secure redirects. example: - main.example - addon.example - addon.main.example items: type: string type: array errors: description: List of errors if the API failed. example: null items: type: string type: - array - 'null' messages: description: List of messages generated by the API. example: null items: type: string type: - array - 'null' metadata: properties: {} status: description: '- `1` - Success - `0` - Failed: Check the errors field for more details.' enum: - 0 - 1 example: 1 type: integer warnings: description: List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API. example: null items: type: string type: - array - 'null' type: object type: object description: HTTP Request was successful. summary: Enable or disable secure redirects tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "uapi --output=jsonpretty \\\n --user=username \\\n SSL \\\n toggle_ssl_redirect_for_domains \\\n domains='main.example,addon.example,addon.main.example' \\\n state='1'\n" - label: URL lang: HTTP source: https://hostname.example.com:2083/cpsess##########/execute/SSL/toggle_ssl_redirect_for_domains?domains=main.example%2caddon.example%2caddon.main.example&state=1 - label: LiveAPI Perl lang: Perl source: "#--------------------------------------------------------------------------------------\n# Instructions:\n#--------------------------------------------------------------------------------------\n# is the theme assigned to cPanel account.\n# 1) cd /usr/local/cpanel/base/frontend/\n# 2) mkdir api_examples\n# 3) cd api_examples\n# 4) create a file SSL_toggle_ssl_redirect_for_domains.live.pl and put this code into that file.\n# 5) In your browser login to a cPanel account.\n# 6) Manually change the url from: .../frontend//\n# to .../frontend//api_examples/SSL_toggle_ssl_redirect_for_domains.live.pl\n#--------------------------------------------------------------------------------------\n\nuse strict;\n\nuse Cpanel::LiveAPI ();\n\nmy $cpanel = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.\n\n# Print the header\nprint \"Content-type: text/plain\\r\\n\\r\\n\";\n\n# Call the API\nmy $response = $cpanel->uapi(\n q/SSL/,\n q/toggle_ssl_redirect_for_domains/,\n {\n 'domains' => 'main.example,addon.example,addon.main.example',\n 'state' => '1',\n }\n);\n\n# Handle the response\nif ($response->{cpanelresult}{result}{status}) {\n my $data = $response->{cpanelresult}{result}{data};\n foreach my $item (@{$data}) {\n # Do something with the $item\n }\n\n # So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n # Report errors:\n print to_json($response->{cpanelresult}{result}{errors});\n}\n\n# Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n#--------------------------------------------------------------------------------------\n# Helper function to convert a perl object to html printable json\n#--------------------------------------------------------------------------------------\nsub to_json {\n require JSON;\n my $str = JSON->new->pretty->encode($_[0]);\n return $str;\n}\n" - label: LiveAPI PHP lang: PHP source: " is the theme assigned to cPanel account.\n// 1) cd /usr/local/cpanel/base/frontend/\n// 2) mkdir api_examples\n// 3) cd api_examples\n// 4) create a file SSL_toggle_ssl_redirect_for_domains.live.php and put this code into that file.\n// 5) In your browser login to a cPanel account.\n// 6) Manually change the url from: .../frontend//\n// to .../frontend//api_examples/SSL_toggle_ssl_redirect_for_domains.live.php\n//--------------------------------------------------------------------------------------\n\n// Instantiate the CPANEL object.\nrequire_once \"/usr/local/cpanel/php/cpanel.php\";\n\n// Print the header\nheader('Content-Type: text/plain');\n\n// Connect to cPanel - only do this once.\n$cpanel = new CPANEL();\n\n// Call the API\n$response = $cpanel->uapi(\n 'SSL',\n 'toggle_ssl_redirect_for_domains',\n array (\n 'domains' => 'main.example,addon.example,addon.main.example',\n 'state' => '1',\n )\n);\n\n// Handle the response\nif ($response['cpanelresult']['result']['status']) {\n $data = $response['cpanelresult']['result']['data'];\n foreach ($data as $item) {\n // Do something with the $item\n }\n\n // So you can see the data shape we print it here.\n print to_json($data);\n}\nelse {\n // Report errors:\n print to_json($response['cpanelresult']['result']['errors']);\n}\n\n// Disconnect from cPanel - only do this once.\n$cpanel->end();\n\n//--------------------------------------------------------------------------------------\n// Helper function to convert a PHP value to html printable json\n//--------------------------------------------------------------------------------------\nfunction to_json($data) {\n return json_encode($data, JSON_PRETTY_PRINT);\n}" x-cpanel-api-version: UAPI x-cpanel-available-version: cPanel 80 servers: - description: A server running cPanel. url: https://{host}:{port}/execute variables: host: default: cpanel-server.tld description: The hostname of a server running cPanel. port: default: '2083' description: The cPanel port. /SSL/upload_cert: post: x-readonly: false x-rollback: none description: 'This function uploads a certificate. **Important:** * Due to the limited field length of HTTP GET method calls, you **must** use the HTTP POST method. For this reason, you **cannot** use a cPanel or Webmail session URL to call this function. * When you disable the Calendar and Contacts, Receive Mail, Web Disk, Webmail, and Web Server roles, the system **disables** this function.' operationId: SSL-upload_cert parameters: - description: The certificate's contents. in: query name: crt required: true schema: example: REDACTED_CERTIFICATE_EXAMPLE format: pem-certificate type: string - description: The certificate's friendly name. in: query name: friendly_name required: false schema: example: TestCert type: string requestBody: content: multipart/form-data: schema: properties: crt: description: The certificate file. format: pem-certificate type: string friendly_name: description: The certificate's friendly name. type: string type: object description: The certificate's contents. responses: '200': content: application/json: schema: properties: apiversion: description: The version of the API. example: 3 type: integer func: description: The name of the method called. example: upload_cert type: string module: description: The name of the module called. example: SSL type: string result: properties: data: items: properties: created: description: The certificate's creation date. example: 1569844800 format: unix_timestamp type: integer domains: description: A list of the certificate's domains. items: example: example.com format: domain type: string type: array ecdsa_curve_name: description: 'The ECDSA curve that the certificate''s key uses. * `prime256v1` * `secp384r1` * `null` — The certificate''s key is **not** an ECDSA key.' enum: - prime256v1 - secp384r1 example: prime256v1 type: - string - 'null' ecdsa_public: description: 'The certificate''s key''s ECDSA compressed public point, in hexadecimal format. * `null` — The certificate''s key is **not** an ECDSA key.' example: null type: - string - 'null' friendly_name: description: The certificate's friendly name. example: TestCert type: string id: description: The certificate's ID. example: example_com_c69ce_37ff5_1397169490_169c717cb2c260281df792788accf041 type: string is_self_signed: description: 'Whether the certificate is self-signed. * `1` — Self-signed. * `0` — Not self-signed.' enum: - 1 - 0 example: 1 type: integer issuer.commonName: description: The issuer's Common Name or Distinguished Name. example: VeriSign Trial Secure Server CA - G2 type: string issuer.organizationName: description: The issuer's Organization Name. example: VeriSign, Inc. type: string key_algorithm: description: 'The certificate''s key''s algorithm. * `rsaEncryption` — RSA. * `id-ecPublicKey` — ECDSA.' enum: - rsaEncryption - id-ecPublicKey example: rsaEncryption type: string modulus: description: 'The certificate''s key''s modulus, in hexadecimal format. * `null` — The certificate''s key is **not** an RSA key.' example: a673c3b17344664b35f8791f562d3aea6bf4d8faa3ae3fc0a519380fd453964a36677c34d48677ecb7f5ed035df026f5f0f8fbfe21745e52daf1f3b9e58c73f0baefdb709320e2202e7d05250b051a59b30ff1fef22d83d7140c1c81cea314a0890ce8d2226799872181c58a74016c7aaa2cff5ac72b575cecde8f304aa572a2ea03d8b173ab76c6e8cdb9dfd0da81e1119cefd4b8b4dbfbe0e46c7f1ee2fe8b5fd5504e58ccbc0d13b4fa41ecc9ebd0dabe1d1fec5c724f748167e7c0553e997f9b77eb36abce70973f06df151748d41b758de3efd7afa6f2464a1547f5ff158469d96e248be464df9eda0e7ce854a89332a2c1278b17c425368a9604f454db type: - string - 'null' modulus_length: description: 'The length, in bits, of the certificate''s key''s modulus. * `null` — The certificate''s key is **not** an RSA key.' example: 2048 minimum: 1 type: - integer - 'null' not_after: description: The certificate's expiration date. example: 1601467200 format: unix_timestamp type: integer not_before: description: The certificate's start date. example: 1569844800 format: unix_timestamp type: integer signature_algorithm: description: The certificiate's OID hash algorithm signature. example: sha256WithRSAEncryption type: string subject.commonName: description: The issuer's Common Name or Distinguished Name. example: example.com type: string validation_type: description: 'The certificate''s validation type. * `ev` — Extended Validation. * `ov` — Organization Validation. * `dv` — Domain Validation. * `null` — The system could not parse and determine the certificate''s validation type.' enum: - ev - ov - dv example: dv type: - string - 'null' type: object type: array errors: description: List of errors if the API failed. example: null items: type: string type: - array - 'null' messages: description: List of messages generated by the API. example: null items: type: string type: - array - 'null' metadata: properties: transformed: description: Post-processing may have transformed the data. enum: - 1 example: 1 type: integer status: description: '* `1` — Success. * `0` — Failed. Check the `errors` field for more details.' enum: - 1 - 0 example: 1 type: integer warnings: description: List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API. example: null items: type: string type: - array - 'null' type: object type: object description: HTTP Request was successful. summary: Import SSL certificate tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "uapi --input=json --output=jsonpretty \\\n --user=username \\\n SSL \\\n upload_cert\n" - label: HTTP Request (Wire Format) lang: HTTP source: 'POST /cpsess##########/execute/SSL/upload_cert HTTP/1.1 Host: example.com:2083 Cookie: ################################### Content-Type: application/json Content-Length: 0 ' x-cpanel-api-version: UAPI x-cpanel-available-version: cPanel 11.42 servers: - description: A server running cPanel. url: https://{host}:{port}/execute variables: host: default: cpanel-server.tld description: The hostname of a server running cPanel. port: default: '2083' description: The cPanel port. /SSL/upload_key: post: x-readonly: false x-rollback: none description: 'This function uploads a private key. **Note:** Due to the limited field length of HTTP GET method calls, you **must** use the HTTP POST method. For this reason, you **cannot** use a cPanel or Webmail session URL to call this function. **Important:** When you disable the Calendars and Contacts, Receive Mail, Web Disk, Webmail, **and** Web Server roles, the system **disables** this function.' operationId: SSL-upload_key parameters: - description: The key's contents. in: query name: key required: true schema: example: REDACTED_PRIVATE_KEY_EXAMPLE format: pem-private-key type: string - description: The key's friendly name. in: query name: friendly_name required: false schema: example: TestKey type: string requestBody: content: multipart/form-data: schema: properties: crt: description: The key's contents. format: pem-private-key type: string friendly_name: description: The key's friendly name. type: string type: object description: The certificate's contents. responses: '200': content: application/json: schema: properties: apiversion: description: The version of the API. example: 3 type: integer func: description: The name of the method called. example: upload_key type: string module: description: The name of the module called. example: SSL type: string result: properties: data: items: properties: created: description: The key's creation date. example: 1569844800 format: unix_timestamp type: integer ecdsa_curve_name: description: 'The ECDSA curve that the key uses. * `prime256v1` * `secp384r1` * `null` — The key is **not** an ECDSA key.' enum: - prime256v1 - secp384r1 example: prime256v1 type: - string - 'null' ecdsa_public: description: 'The key’s ECDSA compressed public point, in hexadecimal format. * `null` — The key is **not** an ECDSA key.' example: null type: - string - 'null' friendly_name: description: The key's friendly name. example: TestKey type: string id: description: The key's ID. example: bbe7e_16e2d_df7539f280eb1ecf6c1096190e41ada7 type: string key_algorithm: description: 'The key’s algorithm. * `rsaEncryption` — RSA. * `id-ecPublicKey` — ECDSA.' enum: - rsaEncryption - id-ecPublicKey example: rsaEncryption type: string modulus: description: 'The key''s modulus, in hexadecimal format. * `null` — The key is **not** an RSA key.' example: a673c3b17344664b35f8791f562d3aea6bf4d8faa3ae3fc0a519380fd453964a36677c34d48677ecb7f5ed035df026f5f0f8fbfe21745e52daf1f3b9e58c73f0baefdb709320e2202e7d05250b051a59b30ff1fef22d83d7140c1c81cea314a0890ce8d2226799872181c58a74016c7aaa2cff5ac72b575cecde8f304aa572a2ea03d8b173ab76c6e8cdb9dfd0da81e1119cefd4b8b4dbfbe0e46c7f1ee2fe8b5fd5504e58ccbc0d13b4fa41ecc9ebd0dabe1d1fec5c724f748167e7c0553e997f9b77eb36abce70973f06df151748d41b758de3efd7afa6f2464a1547f5ff158469d96e248be464df9eda0e7ce854a89332a2c1278b17c425368a9604f454db type: - string - 'null' modulus_length: description: 'The length, in bits, of the key''s modulus. * `null` — The key is **not** an RSA key.' example: 2048 minimum: 1 type: - integer - 'null' type: object type: array errors: description: List of errors if the API failed. example: null items: type: string type: - array - 'null' messages: description: List of messages generated by the API. example: null items: type: string type: - array - 'null' metadata: properties: transformed: description: Post-processing may have transformed the data. enum: - 1 example: 1 type: integer status: description: '* `1` — Success. * `0` — Failed. Check the `errors` field for more details.' enum: - 1 - 0 example: 1 type: integer warnings: description: List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API. example: null items: type: string type: - array - 'null' type: object type: object description: HTTP Request was successful. summary: Import private key tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "uapi --input=json --output=jsonpretty \\\n --user=username \\\n SSL \\\n upload_key\n" - label: HTTP Request (Wire Format) lang: HTTP source: 'POST /cpsess##########/execute/SSL/upload_key HTTP/1.1 Host: example.com:2083 Cookie: ################################### Content-Type: application/json Content-Length: 0 ' x-cpanel-api-version: UAPI x-cpanel-available-version: cPanel 11.42 servers: - description: A server running cPanel. url: https://{host}:{port}/execute variables: host: default: cpanel-server.tld description: The hostname of a server running cPanel. port: default: '2083' description: The cPanel port. /add_autossl_user_excluded_domains: get: description: This function disables AutoSSL for an account's specified domains. operationId: SSL-add_autossl_user_excluded_domains parameters: - description: 'Disable AutoSSL for this domain. **Note:** To disable AutoSSL for multiple domains, increment the parameter name. For example, `domain=example.com`, `domain-1=example1.com`, and `domain-2=example.com`.' examples: multiple: description: Disable AutoSSL for multiple domains. value: - example.com - example1.com - example2.com single: description: Disable AutoSSL for a single domain. value: - example.com explode: true in: query name: domain required: true schema: items: format: domain type: string type: array style: form - description: The cPanel user's account. in: query name: username required: true schema: example: example format: username type: string responses: '200': content: application/json: schema: properties: metadata: properties: command: description: The method name called. example: add_autossl_user_excluded_domains type: string reason: description: The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds. example: OK type: string result: description: '* `1` — Success. * `0` — Failed. Check the `reason` field for more details.' enum: - 0 - 1 example: 1 type: integer version: description: The version of the API function. example: 1 type: integer type: object description: HTTP Request was successful. summary: Disable AutoSSL for domain tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n add_autossl_user_excluded_domains \\\n username='example' \\\n domain='example.com'\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/add_autossl_user_excluded_domains?api.version=1&username=example&domain=example.com x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '66' servers: - description: A server running WHM. url: https://{host}:{port}/json-api variables: host: default: whm-server.tld description: The hostname of a server running WHM. port: default: '2087' description: The WHM port. /delete_ssl_vhost: get: description: This function deletes the SSL virtual host. operationId: SSL-delete_ssl_vhost parameters: - description: The hostname whose SSL virtual host you'd like to delete. in: query name: host required: true schema: example: example.com type: string responses: '200': content: application/json: schema: properties: data: properties: output: description: Shows the status of the deletion. example: - Deleting the SSL host for example.com - Done. items: type: string type: array removed_vhost_data: description: The virtual host data that the script removed. items: properties: ip_port: description: The IP address where the virtual host data resided and its port number. example: - 192.0.2.0 - '443' items: type: string type: array is_ssl: description: 'Whether the virtual host was SSL. * `1` — The host was SSL. - `0` — The host was **not** SSL.' enum: - 0 - 1 example: 1 type: integer primary_on_ip_port: description: The domain name that the removed virtual host used. example: example.net format: domain type: string servername: description: The name of the deleted domain. example: example.com format: domain type: string vhost_entry: description: The output text. example: ' ServerName example.com ServerAlias [...] ' type: string type: object type: array type: object metadata: properties: command: description: The method name called. example: delete_ssl_vhost type: string reason: description: The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds. example: OK type: string result: description: '* `1` — Success. * `0` — Failed. Check the `reason` field for more details.' enum: - 0 - 1 example: 1 type: integer version: description: The version of the API function. example: 1 type: integer type: object description: HTTP Request was successful. summary: Delete SSL vhost tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n delete_ssl_vhost \\\n host='example.com'\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/delete_ssl_vhost?api.version=1&host=example.com x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '82' servers: - description: A server running WHM. url: https://{host}:{port}/json-api variables: host: default: whm-server.tld description: The hostname of a server running WHM. port: default: '2087' description: The WHM port. /disable_autossl: get: description: This function disables the AutoSSL feature. operationId: SSL-disable_autossl parameters: [] responses: '200': content: application/json: schema: properties: metadata: properties: command: description: The method name called. example: disable_autossl type: string reason: description: The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds. example: OK type: string result: description: '* `1` - Success. * `0` - Failed. Check the reason field for more details.' enum: - 0 - 1 example: 1 type: integer version: description: The version of the API function. example: 1 type: integer type: object description: HTTP Request was successful. summary: Disable AutoSSL tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n disable_autossl\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/disable_autossl?api.version=1 x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '58' servers: - description: A server running WHM. url: https://{host}:{port}/json-api variables: host: default: whm-server.tld description: The hostname of a server running WHM. port: default: '2087' description: The WHM port. /enqueue_deferred_ssl_installations: get: description: 'This function adds SSL certificates to the installation queue. This allows you to defer and batch SSL certificate installation. **Important:** You **must** enter the same quantity of `username`, `cab`, `crt`, `key`, and `vhost_name` parameters. For example, to add three certificates to the installation queue, enter the `username` parameter three times, then enter three `cab`, `crt`, `key`, and `vhost_name` parameters.' operationId: SSL-enqueue_deferred_ssl_installations parameters: - description: 'The Certificate Authority (CA) bundle''s contents. **Note:** * We recommend that you enter an empty string. An empty string tells the server to download the CA bundle automatically. * To add multiple certificates to the installation queue, duplicate or increment the parameter name. For example, `cab-1`, `cab-2`, and `cab-3`.' examples: multiple: summary: Enqueue multiple CA bundles. value: cab-1=-----BEGIN%20CERTIFICATE-----%0AMIIB+jCCAWMCAgGjMA0GCSqGSIb3DQEBBAUAMEUxCzAJBgNVBAYTAlVTMRgwFgYD%0AVQQKEw9HVEUgQ29ycG9yYXRpb24xHDAaBgNVBAMTE0dURSBDeWJlclRydXN0IFJv%0Ab3QwHhcNOTYwMjIzMjMwMTAwWhcNMDYwMjIzMjM1OTAwWjBFMQswCQYDVQQGEwJV%0AUzEYMBYGA1UEChMPR1RFIENvcnBvcmF0aW9uMRwwGgYDVQQDExNHVEUgQ3liZXJU%0AcnVzdCBSb290MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC45k+625h8cXyv%0ARLfTD0bZZOWTwUKOx7pJjTUteueLveUFMVnGsS8KDPufpz+iCWaEVh43KRuH6X4M%0AypqfpX/1FZSj1aJGgthoTNE3FQZor734sLPwKfWVWgkWYXcKIiXUT0Wqx73llt/5%0A1KiOQswkwB6RJ0q1bQaAYznEol44AwIDAQABMA0GCSqGSIb3DQEBBAUAA4GBABKz%0AdcZfHeFhVYAA1IFLezEPI2PnPfMD+fQ2qLvZ46WXTeorKeDWanOB5sCJo9Px4KWl%0AIjeaY8JIILTbcuPI9tl8vrGvU9oUtCG41tWW4/5ODFlitppK+ULdjG+BqXH/9Apy%0AbW1EDp3zdHSo1TRJ8V8e6bR64eVaH4QwnNOfpSXY%0A-----END%20CERTIFICATE----- cab-2=-----BEGIN%20CERTIFICATE-----%0AMIIB+jCCAWMCAgGjMA0GCSqGSIb3DQEBBAUAMEUxCzAJBgNVBAYTAlVTMRgwFgYD%0AVQQKEw9HVEUgQ29ycG9yYXRpb24xHDAaBgNVBAMTE0dURSBDeWJlclRydXN0IFJv%0Ab3QwHhcNOTYwMjIzMjMwMTAwWhcNMDYwMjIzMjM1OTAwWjBFMQswCQYDVQQGEwJV%0AUzEYMBYGA1UEChMPR1RFIENvcnBvcmF0aW9uMRwwGgYDVQQDExNHVEUgQ3liZXJU%0AcnVzdCBSb290MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC45k+625h8cXyv%0ARLfTD0bZZOWTwUKOx7pJjTUteueLveUFMVnGsS8KDPufpz+iCWaEVh43KRuH6X4M%0AypqfpX/1FZSj1aJGgthoTNE3FQZor734sLPwKfWVWgkWYXcKIiXUT0Wqx73llt/5%0A1KiOQswkwB6RJ0q1bQaAYznEol44AwIDAQABMA0GCSqGSIb3DQEBBAUAA4GBABKz%0AdcZfHeFhVYAA1IFLezEPI2PnPfMD+fQ2qLvZ46WXTeorKeDWanOB5sCJo9Px4KWl%0AIjeaY8JIILTbcuPI9tl8vrGvU9oUtCG41tWW4/5ODFlitppK+ULdjG+BqXH/9Apy%0AbW1EDp3zdHSo1TRJ7V7e6bR64eVaH4QwnNOfpSXY%0A-----END%20CERTIFICATE----- cab-3=-----BEGIN%20CERTIFICATE-----%0AMIIB+jCCAWMCAgGjMA0GCSqGSIb3DQEBBAUAMEUxCzAJBgNVBAYTAlVTMRgwFgYD%0AVQQKEw9HVEUgQ29ycG9yYXRpb24xHDAaBgNVBAMTE0dURSBDeWJlclRydXN0IFJv%0Ab3QwHhcNOTYwMjIzMjMwMTAwWhcNMDYwMjIzMjM1OTAwWjBFMQswCQYDVQQGEwJV%0AUzEYMBYGA1UEChMPR1RFIENvcnBvcmF0aW9uMRwwGgYDVQQDExNHVEUgQ3liZXJU%0AcnVzdCBSb290MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC45k+625h8cXyv%0ARLfTD0bZZOWTwUKOx7pJjTUteueLveUFMVnGsS8KDPufpz+iCWaEVh43KRuH6X4M%0AypqfpX/1FZSj1aJGgthoTNE3FQZor734sLPwKfWVWgkWYXcKIiXUT0Wqx73llt/5%0A1KiOQswkwB6RJ0q1bQaAYznEol44AwIDAQABMA0GCSqGSIb3DQEBBAUAA4GBABKz%0AdcZfHeFhVYAA1IFLezEPI2PnPfMD+fQ2qLvZ46WXTeorKeDWanOB5sCJo9Px4KWl%0AIjeaY8JIILTbcuPI9tl8vrGvU9oUtCG41tWW4/5ODFlitppK+ULdjG+BqXH/9Apy%0AbW1EDp3zdHSo1TRJ6V6e6bR64eVaH4QwnNOfpSXY%0A-----END%20CERTIFICATE----- multiple-alternative: summary: Enqueue multiple CA bundles. value: cab=-----BEGIN%20CERTIFICATE-----%0AMIIB+jCCAWMCAgGjMA0GCSqGSIb3DQEBBAUAMEUxCzAJBgNVBAYTAlVTMRgwFgYD%0AVQQKEw9HVEUgQ29ycG9yYXRpb24xHDAaBgNVBAMTE0dURSBDeWJlclRydXN0IFJv%0Ab3QwHhcNOTYwMjIzMjMwMTAwWhcNMDYwMjIzMjM1OTAwWjBFMQswCQYDVQQGEwJV%0AUzEYMBYGA1UEChMPR1RFIENvcnBvcmF0aW9uMRwwGgYDVQQDExNHVEUgQ3liZXJU%0AcnVzdCBSb290MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC45k+625h8cXyv%0ARLfTD0bZZOWTwUKOx7pJjTUteueLveUFMVnGsS8KDPufpz+iCWaEVh43KRuH6X4M%0AypqfpX/1FZSj1aJGgthoTNE3FQZor734sLPwKfWVWgkWYXcKIiXUT0Wqx73llt/5%0A1KiOQswkwB6RJ0q1bQaAYznEol44AwIDAQABMA0GCSqGSIb3DQEBBAUAA4GBABKz%0AdcZfHeFhVYAA1IFLezEPI2PnPfMD+fQ2qLvZ46WXTeorKeDWanOB5sCJo9Px4KWl%0AIjeaY8JIILTbcuPI9tl8vrGvU9oUtCG41tWW4/5ODFlitppK+ULdjG+BqXH/9Apy%0AbW1EDp3zdHSo1TRJ8V8e6bR64eVaH4QwnNOfpSXY%0A-----END%20CERTIFICATE----- cab=-----BEGIN%20CERTIFICATE-----%0AMIIB+jCCAWMCAgGjMA0GCSqGSIb3DQEBBAUAMEUxCzAJBgNVBAYTAlVTMRgwFgYD%0AVQQKEw9HVEUgQ29ycG9yYXRpb24xHDAaBgNVBAMTE0dURSBDeWJlclRydXN0IFJv%0Ab3QwHhcNOTYwMjIzMjMwMTAwWhcNMDYwMjIzMjM1OTAwWjBFMQswCQYDVQQGEwJV%0AUzEYMBYGA1UEChMPR1RFIENvcnBvcmF0aW9uMRwwGgYDVQQDExNHVEUgQ3liZXJU%0AcnVzdCBSb290MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC45k+625h8cXyv%0ARLfTD0bZZOWTwUKOx7pJjTUteueLveUFMVnGsS8KDPufpz+iCWaEVh43KRuH6X4M%0AypqfpX/1FZSj1aJGgthoTNE3FQZor734sLPwKfWVWgkWYXcKIiXUT0Wqx73llt/5%0A1KiOQswkwB6RJ0q1bQaAYznEol44AwIDAQABMA0GCSqGSIb3DQEBBAUAA4GBABKz%0AdcZfHeFhVYAA1IFLezEPI2PnPfMD+fQ2qLvZ46WXTeorKeDWanOB5sCJo9Px4KWl%0AIjeaY8JIILTbcuPI9tl8vrGvU9oUtCG41tWW4/5ODFlitppK+ULdjG+BqXH/9Apy%0AbW1EDp3zdHSo1TRJ7V7e6bR64eVaH4QwnNOfpSXY%0A-----END%20CERTIFICATE----- cab=-----BEGIN%20CERTIFICATE-----%0AMIIB+jCCAWMCAgGjMA0GCSqGSIb3DQEBBAUAMEUxCzAJBgNVBAYTAlVTMRgwFgYD%0AVQQKEw9HVEUgQ29ycG9yYXRpb24xHDAaBgNVBAMTE0dURSBDeWJlclRydXN0IFJv%0Ab3QwHhcNOTYwMjIzMjMwMTAwWhcNMDYwMjIzMjM1OTAwWjBFMQswCQYDVQQGEwJV%0AUzEYMBYGA1UEChMPR1RFIENvcnBvcmF0aW9uMRwwGgYDVQQDExNHVEUgQ3liZXJU%0AcnVzdCBSb290MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC45k+625h8cXyv%0ARLfTD0bZZOWTwUKOx7pJjTUteueLveUFMVnGsS8KDPufpz+iCWaEVh43KRuH6X4M%0AypqfpX/1FZSj1aJGgthoTNE3FQZor734sLPwKfWVWgkWYXcKIiXUT0Wqx73llt/5%0A1KiOQswkwB6RJ0q1bQaAYznEol44AwIDAQABMA0GCSqGSIb3DQEBBAUAA4GBABKz%0AdcZfHeFhVYAA1IFLezEPI2PnPfMD+fQ2qLvZ46WXTeorKeDWanOB5sCJo9Px4KWl%0AIjeaY8JIILTbcuPI9tl8vrGvU9oUtCG41tWW4/5ODFlitppK+ULdjG+BqXH/9Apy%0AbW1EDp3zdHSo1TRJ6V6e6bR64eVaH4QwnNOfpSXY%0A-----END%20CERTIFICATE----- single: summary: Enqueue a single CA bundle. value: '-----BEGIN%20CERTIFICATE-----%0AMIIB+jCCAWMCAgGjMA0GCSqGSIb3DQEBBAUAMEUxCzAJBgNVBAYTAlVTMRgwFgYD%0AVQQKEw9HVEUgQ29ycG9yYXRpb24xHDAaBgNVBAMTE0dURSBDeWJlclRydXN0IFJv%0Ab3QwHhcNOTYwMjIzMjMwMTAwWhcNMDYwMjIzMjM1OTAwWjBFMQswCQYDVQQGEwJV%0AUzEYMBYGA1UEChMPR1RFIENvcnBvcmF0aW9uMRwwGgYDVQQDExNHVEUgQ3liZXJU%0AcnVzdCBSb290MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC45k+625h8cXyv%0ARLfTD0bZZOWTwUKOx7pJjTUteueLveUFMVnGsS8KDPufpz+iCWaEVh43KRuH6X4M%0AypqfpX/1FZSj1aJGgthoTNE3FQZor734sLPwKfWVWgkWYXcKIiXUT0Wqx73llt/5%0A1KiOQswkwB6RJ0q1bQaAYznEol44AwIDAQABMA0GCSqGSIb3DQEBBAUAA4GBABKz%0AdcZfHeFhVYAA1IFLezEPI2PnPfMD+fQ2qLvZ46WXTeorKeDWanOB5sCJo9Px4KWl%0AIjeaY8JIILTbcuPI9tl8vrGvU9oUtCG41tWW4/5ODFlitppK+ULdjG+BqXH/9Apy%0AbW1EDp3zdHSo1TRJ6V6e6bR64eVaH4QwnNOfpSXY%0A-----END%20CERTIFICATE-----' in: query name: cab required: true schema: type: string - description: "The certificate's contents.\n\n**Note:**\n\n To add multiple certificates to the installation queue, duplicate or increment the\n parameter name. For example, `crt-1`, `crt-2`, and `crt-3`." examples: multiple: summary: Enqueue the contents of multiple certificates. value: crt-1=-----BEGIN%20CERTIFICATE-----%0AMIIDNTCCAh2gAwIBAgIFAY0o0kwwDQYJKoZIhvcNAQELBQAwFjEUMBIGA1UEAwwL%0AZG9tYWluLnRlc3QwHhcNMTcxMDMxMTUyMjU1WhcNMTgxMDMxMTUyMjU1WjAWMRQw%0AEgYDVQQDDAtkb21haW4udGVzdDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoC%0AggEBALer6vzwFt%2BO6ooHcXpq%2Bi%2FOVVQEY3oWxrqH6mB%2FPssVSxwcf6bLjoO4so%2Fn%0Adrymhb9mqfkOqYVHwnQ%2Fh2uM%2BIw1NKKDfwOljWcgCS24NykbfQUlW%2FSNDTovdDGl%0AT1Aner090Qse%2B19ta8KS%2F3Akz37bkgqMkPO%2FiEOHlF%2FLbLvjfighkoGco51wc6d7%0AHCQwPWR%2BUenbQWzUwR4%2F4Pqw%2FYrxDAv8O%2FEnNfOGwnCnlnFq4a390VGriqMAngzI%0AlRMVDu4qJGW3dFNStVUm71%2B16ba%2FeIVBQGN2rbgie6Rb6VuHdsqSreea0tSLRxdd%0AFd7A0QMQRvtnqoUv6RZBhefr2t0CAwEAAaOBiTCBhjAdBgNVHQ4EFgQUeitnD4U4%0AMXtmLX53dTAZPENjovwwHwYDVR0jBBgwFoAUeitnD4U4MXtmLX53dTAZPENjovww%0ACQYDVR0TBAIwADA5BgNVHREEMjAwggtkb21haW4udGVzdIIQbWFpbC5kb21haW4u%0AdGVzdIIPd3d3LmRvbWFpbi50ZXN0MA0GCSqGSIb3DQEBCwUAA4IBAQAeD4Fc%2FBwM%0AfJEvlPO30%2FOp2JJxG92tbgsoY9CKTYoZy0IMHhwOrt%2FB36joYDrOhtiO6XsRw4Zm%0AAPT8ey9p61kUc6XWs5oU9aifKeAKzWCZV9wQphbY%2F0rQp1YPsVN9tBgiag754HPo%0AbNDhWOZSZDKnh82DikTD6iciTxeblrvcbFC4Z76JH31dvqmNMEAgZvPCpq86Ued5%0A52gKM0u2%2BrK%2FzIYjh%2FhooqN%2BTY%2BJQ667JzLzPNenzAYFsoIQgVj6%2FZoFqJA4nbxC%0Azv%2Fspqc0OQ2W9m5egRPDhngKt%2Bi9804N7FeilBL%2FcpEgUHhgzMBi1T9n%2CFCrc6bO%0AjNjvnEQRbqZY%0A-----END%20CERTIFICATE----- crt-2=-----BEGIN%20CERTIFICATE-----%0AMIIDNTCCAh2gAwIBAgIFAY0o0kwwDQYJKoZIhvcNAQELBQAwFjEUMBIGA1UEAwwL%0AZG9tYWluLnRlc3QwHhcNMTcxMDMxMTUyMjU1WhcNMTgxMDMxMTUyMjU1WjAWMRQw%0AEgYDVQQDDAtkb21haW4udGVzdDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoC%0AggEBALer6vzwFt%2BO6ooHcXpq%2Bi%2FOVVQEY3oWxrqH6mB%2FPssVSxwcf6bLjoO4so%2Fn%0Adrymhb9mqfkOqYVHwnQ%2Fh2uM%2BIw1NKKDfwOljWcgCS24NykbfQUlW%2FSNDTovdDGl%0AT1Aner090Qse%2B19ta8KS%2F3Akz37bkgqMkPO%2FiEOHlF%2FLbLvjfighkoGco51wc6d7%0AHCQwPWR%2BUenbQWzUwR4%2F4Pqw%2FYrxDAv8O%2FEnNfOGwnCnlnFq4a390VGriqMAngzI%0AlRMVDu4qJGW3dFNStVUm71%2B16ba%2FeIVBQGN2rbgie6Rb6VuHdsqSreea0tSLRxdd%0AFd7A0QMQRvtnqoUv6RZBhefr2t0CAwEAAaOBiTCBhjAdBgNVHQ4EFgQUeitnD4U4%0AMXtmLX53dTAZPENjovwwHwYDVR0jBBgwFoAUeitnD4U4MXtmLX53dTAZPENjovww%0ACQYDVR0TBAIwADA5BgNVHREEMjAwggtkb21haW4udGVzdIIQbWFpbC5kb21haW4u%0AdGVzdIIPd3d3LmRvbWFpbi50ZXN0MA0GCSqGSIb3DQEBCwUAA4IBAQAeD4Fc%2FBwM%0AfJEvlPO30%2FOp2JJxG92tbgsoY9CKTYoZy0IMHhwOrt%2FB36joYDrOhtiO6XsRw4Zm%0AAPT8ey9p61kUc6XWs5oU9aifKeAKzWCZV9wQphbY%2F0rQp1YPsVN9tBgiag754HPo%0AbNDhWOZSZDKnh82DikTD6iciTxeblrvcbFC4Z76JH31dvqmNMEAgZvPCpq86Ued5%0A52gKM0u2%2BrK%2FzIYjh%2FhooqN%2BTY%2BJQ667JzLzPNenzAYFsoIQgVj6%2FZoFqJA4nbxC%0Azv%2Fspqc0OQ2W9m5egRPDhngKt%2Bi9804N7FeilBL%2FcpEgUHhgzMBi1T9n%2AZArc6bO%0AjNjvnEQRbqZY%0A-----END%20CERTIFICATE----- crt-3=-----BEGIN%20CERTIFICATE-----%0AMIIDNTCCAh2gAwIBAgIFAY0o0kwwDQYJKoZIhvcNAQELBQAwFjEUMBIGA1UEAwwL%0AZG9tYWluLnRlc3QwHhcNMTcxMDMxMTUyMjU1WhcNMTgxMDMxMTUyMjU1WjAWMRQw%0AEgYDVQQDDAtkb21haW4udGVzdDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoC%0AggEBALer6vzwFt%2BO6ooHcXpq%2Bi%2FOVVQEY3oWxrqH6mB%2FPssVSxwcf6bLjoO4so%2Fn%0Adrymhb9mqfkOqYVHwnQ%2Fh2uM%2BIw1NKKDfwOljWcgCS24NykbfQUlW%2FSNDTovdDGl%0AT1Aner090Qse%2B19ta8KS%2F3Akz37bkgqMkPO%2FiEOHlF%2FLbLvjfighkoGco51wc6d7%0AHCQwPWR%2BUenbQWzUwR4%2F4Pqw%2FYrxDAv8O%2FEnNfOGwnCnlnFq4a390VGriqMAngzI%0AlRMVDu4qJGW3dFNStVUm71%2B16ba%2FeIVBQGN2rbgie6Rb6VuHdsqSreea0tSLRxdd%0AFd7A0QMQRvtnqoUv6RZBhefr2t0CAwEAAaOBiTCBhjAdBgNVHQ4EFgQUeitnD4U4%0AMXtmLX53dTAZPENjovwwHwYDVR0jBBgwFoAUeitnD4U4MXtmLX53dTAZPENjovww%0ACQYDVR0TBAIwADA5BgNVHREEMjAwggtkb21haW4udGVzdIIQbWFpbC5kb21haW4u%0AdGVzdIIPd3d3LmRvbWFpbi50ZXN0MA0GCSqGSIb3DQEBCwUAA4IBAQAeD4Fc%2FBwM%0AfJEvlPO30%2FOp2JJxG92tbgsoY9CKTYoZy0IMHhwOrt%2FB36joYDrOhtiO6XsRw4Zm%0AAPT8ey9p61kUc6XWs5oU9aifKeAKzWCZV9wQphbY%2F0rQp1YPsVN9tBgiag754HPo%0AbNDhWOZSZDKnh82DikTD6iciTxeblrvcbFC4Z76JH31dvqmNMEAgZvPCpq86Ued5%0A52gKM0u2%2BrK%2FzIYjh%2FhooqN%2BTY%2BJQ667JzLzPNenzAYFsoIQgVj6%2FZoFqJA4nbxC%0Azv%2Fspqc0OQ2W9m5egRPDhngKt%2Bi9804N7FeilBL%2FcpEgUHhgzMBi1T9n%2BYBrc6bO%0AjNjvnEQRbqZY%0A-----END%20CERTIFICATE----- multiple-alternative: summary: Enqueue the contents of multiple certificates. value: crt=-----BEGIN%20CERTIFICATE-----%0AMIIDNTCCAh2gAwIBAgIFAY0o0kwwDQYJKoZIhvcNAQELBQAwFjEUMBIGA1UEAwwL%0AZG9tYWluLnRlc3QwHhcNMTcxMDMxMTUyMjU1WhcNMTgxMDMxMTUyMjU1WjAWMRQw%0AEgYDVQQDDAtkb21haW4udGVzdDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoC%0AggEBALer6vzwFt%2BO6ooHcXpq%2Bi%2FOVVQEY3oWxrqH6mB%2FPssVSxwcf6bLjoO4so%2Fn%0Adrymhb9mqfkOqYVHwnQ%2Fh2uM%2BIw1NKKDfwOljWcgCS24NykbfQUlW%2FSNDTovdDGl%0AT1Aner090Qse%2B19ta8KS%2F3Akz37bkgqMkPO%2FiEOHlF%2FLbLvjfighkoGco51wc6d7%0AHCQwPWR%2BUenbQWzUwR4%2F4Pqw%2FYrxDAv8O%2FEnNfOGwnCnlnFq4a390VGriqMAngzI%0AlRMVDu4qJGW3dFNStVUm71%2B16ba%2FeIVBQGN2rbgie6Rb6VuHdsqSreea0tSLRxdd%0AFd7A0QMQRvtnqoUv6RZBhefr2t0CAwEAAaOBiTCBhjAdBgNVHQ4EFgQUeitnD4U4%0AMXtmLX53dTAZPENjovwwHwYDVR0jBBgwFoAUeitnD4U4MXtmLX53dTAZPENjovww%0ACQYDVR0TBAIwADA5BgNVHREEMjAwggtkb21haW4udGVzdIIQbWFpbC5kb21haW4u%0AdGVzdIIPd3d3LmRvbWFpbi50ZXN0MA0GCSqGSIb3DQEBCwUAA4IBAQAeD4Fc%2FBwM%0AfJEvlPO30%2FOp2JJxG92tbgsoY9CKTYoZy0IMHhwOrt%2FB36joYDrOhtiO6XsRw4Zm%0AAPT8ey9p61kUc6XWs5oU9aifKeAKzWCZV9wQphbY%2F0rQp1YPsVN9tBgiag754HPo%0AbNDhWOZSZDKnh82DikTD6iciTxeblrvcbFC4Z76JH31dvqmNMEAgZvPCpq86Ued5%0A52gKM0u2%2BrK%2FzIYjh%2FhooqN%2BTY%2BJQ667JzLzPNenzAYFsoIQgVj6%2FZoFqJA4nbxC%0Azv%2Fspqc0OQ2W9m5egRPDhngKt%2Bi9804N7FeilBL%2FcpEgUHhgzMBi1T9n%2CFCrc6bO%0AjNjvnEQRbqZY%0A-----END%20CERTIFICATE----- crt=-----BEGIN%20CERTIFICATE-----%0AMIIDNTCCAh2gAwIBAgIFAY0o0kwwDQYJKoZIhvcNAQELBQAwFjEUMBIGA1UEAwwL%0AZG9tYWluLnRlc3QwHhcNMTcxMDMxMTUyMjU1WhcNMTgxMDMxMTUyMjU1WjAWMRQw%0AEgYDVQQDDAtkb21haW4udGVzdDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoC%0AggEBALer6vzwFt%2BO6ooHcXpq%2Bi%2FOVVQEY3oWxrqH6mB%2FPssVSxwcf6bLjoO4so%2Fn%0Adrymhb9mqfkOqYVHwnQ%2Fh2uM%2BIw1NKKDfwOljWcgCS24NykbfQUlW%2FSNDTovdDGl%0AT1Aner090Qse%2B19ta8KS%2F3Akz37bkgqMkPO%2FiEOHlF%2FLbLvjfighkoGco51wc6d7%0AHCQwPWR%2BUenbQWzUwR4%2F4Pqw%2FYrxDAv8O%2FEnNfOGwnCnlnFq4a390VGriqMAngzI%0AlRMVDu4qJGW3dFNStVUm71%2B16ba%2FeIVBQGN2rbgie6Rb6VuHdsqSreea0tSLRxdd%0AFd7A0QMQRvtnqoUv6RZBhefr2t0CAwEAAaOBiTCBhjAdBgNVHQ4EFgQUeitnD4U4%0AMXtmLX53dTAZPENjovwwHwYDVR0jBBgwFoAUeitnD4U4MXtmLX53dTAZPENjovww%0ACQYDVR0TBAIwADA5BgNVHREEMjAwggtkb21haW4udGVzdIIQbWFpbC5kb21haW4u%0AdGVzdIIPd3d3LmRvbWFpbi50ZXN0MA0GCSqGSIb3DQEBCwUAA4IBAQAeD4Fc%2FBwM%0AfJEvlPO30%2FOp2JJxG92tbgsoY9CKTYoZy0IMHhwOrt%2FB36joYDrOhtiO6XsRw4Zm%0AAPT8ey9p61kUc6XWs5oU9aifKeAKzWCZV9wQphbY%2F0rQp1YPsVN9tBgiag754HPo%0AbNDhWOZSZDKnh82DikTD6iciTxeblrvcbFC4Z76JH31dvqmNMEAgZvPCpq86Ued5%0A52gKM0u2%2BrK%2FzIYjh%2FhooqN%2BTY%2BJQ667JzLzPNenzAYFsoIQgVj6%2FZoFqJA4nbxC%0Azv%2Fspqc0OQ2W9m5egRPDhngKt%2Bi9804N7FeilBL%2FcpEgUHhgzMBi1T9n%2AZArc6bO%0AjNjvnEQRbqZY%0A-----END%20CERTIFICATE----- crt=-----BEGIN%20CERTIFICATE-----%0AMIIDNTCCAh2gAwIBAgIFAY0o0kwwDQYJKoZIhvcNAQELBQAwFjEUMBIGA1UEAwwL%0AZG9tYWluLnRlc3QwHhcNMTcxMDMxMTUyMjU1WhcNMTgxMDMxMTUyMjU1WjAWMRQw%0AEgYDVQQDDAtkb21haW4udGVzdDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoC%0AggEBALer6vzwFt%2BO6ooHcXpq%2Bi%2FOVVQEY3oWxrqH6mB%2FPssVSxwcf6bLjoO4so%2Fn%0Adrymhb9mqfkOqYVHwnQ%2Fh2uM%2BIw1NKKDfwOljWcgCS24NykbfQUlW%2FSNDTovdDGl%0AT1Aner090Qse%2B19ta8KS%2F3Akz37bkgqMkPO%2FiEOHlF%2FLbLvjfighkoGco51wc6d7%0AHCQwPWR%2BUenbQWzUwR4%2F4Pqw%2FYrxDAv8O%2FEnNfOGwnCnlnFq4a390VGriqMAngzI%0AlRMVDu4qJGW3dFNStVUm71%2B16ba%2FeIVBQGN2rbgie6Rb6VuHdsqSreea0tSLRxdd%0AFd7A0QMQRvtnqoUv6RZBhefr2t0CAwEAAaOBiTCBhjAdBgNVHQ4EFgQUeitnD4U4%0AMXtmLX53dTAZPENjovwwHwYDVR0jBBgwFoAUeitnD4U4MXtmLX53dTAZPENjovww%0ACQYDVR0TBAIwADA5BgNVHREEMjAwggtkb21haW4udGVzdIIQbWFpbC5kb21haW4u%0AdGVzdIIPd3d3LmRvbWFpbi50ZXN0MA0GCSqGSIb3DQEBCwUAA4IBAQAeD4Fc%2FBwM%0AfJEvlPO30%2FOp2JJxG92tbgsoY9CKTYoZy0IMHhwOrt%2FB36joYDrOhtiO6XsRw4Zm%0AAPT8ey9p61kUc6XWs5oU9aifKeAKzWCZV9wQphbY%2F0rQp1YPsVN9tBgiag754HPo%0AbNDhWOZSZDKnh82DikTD6iciTxeblrvcbFC4Z76JH31dvqmNMEAgZvPCpq86Ued5%0A52gKM0u2%2BrK%2FzIYjh%2FhooqN%2BTY%2BJQ667JzLzPNenzAYFsoIQgVj6%2FZoFqJA4nbxC%0Azv%2Fspqc0OQ2W9m5egRPDhngKt%2Bi9804N7FeilBL%2FcpEgUHhgzMBi1T9n%2BYBrc6bO%0AjNjvnEQRbqZY%0A-----END%20CERTIFICATE----- single: summary: Enqueue a single certificate's contents. value: '-----BEGIN%20CERTIFICATE-----%0AMIIDNTCCAh2gAwIBAgIFAY0o0kwwDQYJKoZIhvcNAQELBQAwFjEUMBIGA1UEAwwL%0AZG9tYWluLnRlc3QwHhcNMTcxMDMxMTUyMjU1WhcNMTgxMDMxMTUyMjU1WjAWMRQw%0AEgYDVQQDDAtkb21haW4udGVzdDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoC%0AggEBALer6vzwFt%2BO6ooHcXpq%2Bi%2FOVVQEY3oWxrqH6mB%2FPssVSxwcf6bLjoO4so%2Fn%0Adrymhb9mqfkOqYVHwnQ%2Fh2uM%2BIw1NKKDfwOljWcgCS24NykbfQUlW%2FSNDTovdDGl%0AT1Aner090Qse%2B19ta8KS%2F3Akz37bkgqMkPO%2FiEOHlF%2FLbLvjfighkoGco51wc6d7%0AHCQwPWR%2BUenbQWzUwR4%2F4Pqw%2FYrxDAv8O%2FEnNfOGwnCnlnFq4a390VGriqMAngzI%0AlRMVDu4qJGW3dFNStVUm71%2B16ba%2FeIVBQGN2rbgie6Rb6VuHdsqSreea0tSLRxdd%0AFd7A0QMQRvtnqoUv6RZBhefr2t0CAwEAAaOBiTCBhjAdBgNVHQ4EFgQUeitnD4U4%0AMXtmLX53dTAZPENjovwwHwYDVR0jBBgwFoAUeitnD4U4MXtmLX53dTAZPENjovww%0ACQYDVR0TBAIwADA5BgNVHREEMjAwggtkb21haW4udGVzdIIQbWFpbC5kb21haW4u%0AdGVzdIIPd3d3LmRvbWFpbi50ZXN0MA0GCSqGSIb3DQEBCwUAA4IBAQAeD4Fc%2FBwM%0AfJEvlPO30%2FOp2JJxG92tbgsoY9CKTYoZy0IMHhwOrt%2FB36joYDrOhtiO6XsRw4Zm%0AAPT8ey9p61kUc6XWs5oU9aifKeAKzWCZV9wQphbY%2F0rQp1YPsVN9tBgiag754HPo%0AbNDhWOZSZDKnh82DikTD6iciTxeblrvcbFC4Z76JH31dvqmNMEAgZvPCpq86Ued5%0A52gKM0u2%2BrK%2FzIYjh%2FhooqN%2BTY%2BJQ667JzLzPNenzAYFsoIQgVj6%2FZoFqJA4nbxC%0Azv%2Fspqc0OQ2W9m5egRPDhngKt%2Bi9804N7FeilBL%2FcpEgUHhgzMBi1T9n%2BYBrc6bO%0AjNjvnEQRbqZY%0A-----END%20CERTIFICATE-----' in: query name: crt required: true schema: type: string - description: 'The private key''s text. **Note:** To add multiple certificates to the installation queue, duplicate or increment the parameter name. For example, `key-1`, `key-2`, and `key-2`.' examples: multiple: summary: Enqueue the private key text of multiple certificates. value: key-1=-----BEGIN%20RSA%20PRIVATE%20KEY-----%0AMIIEowIBAAKCAQEAt6vq%2FPAW347qigdxemr6L85VVARjehbGuofqYH8%2ByxVLHBx%2F%0ApsuOg7iyj%2Bd2vKaFv2ap%2BQ6phUfCdD%2BHa4z4jDU0ooN%2FA6WNZyAJLbg3KRt9BSVb%0A9I0NOi90MaVPUCd6vT3RCx77X21rwpL%2FcCTPftuSCoyQ87%2BIQ4eUX8tsu%2BN%2BKCGS%0AgZyjnXBzp3scJDA9ZH5R6dtBbNTBHj%2Fg%2BrD9ivEMC%2Fw78Sc184bCcKeWcWrhrf3R%0AUauKowCeDMiVExUO7iokZbd0U1K1VSbvX7Xptr94hUFAY3atuCJ7pFvpW4d2ypKt%0A55rS1ItHF10V3sDRAxBG%2B2eqhS%2FpFkGF5%2Bva3QIDAQABAoIBAAONBE79iUOrLKec%0AezolpU6VS5sDNrUeiZsDk6ln7Fvavof9mQ4tc0TipjkX%2FXiqM32%2By1xwRyC3gW%2Fj%0A5odSw19ai%2Fj0V9lHMxOiT%2BsdW5uk12bpEP0KWQ4d6r4m9wCSstHDxy3S3IM8x0%2BM%0ArfmKDKTkM8%2BWZhsAQe8kSN8NPL3pIJnG%2Ftuc8lwFoZOEot6%2BAeGYdxxEdFbvVyEm%0Aa8%2FAhOQ5Z07T36bxuPtyRjwdnFH7hnmzpcWF5Iz8Jp8SrQ2XX2rKSQpa1Ic%2B6TMA%0AF7kJsOFiw%2B8aX6zTTVLsvQTHWEsnNWHKtbuNBoQcq2HyifrUxr550kZVMnyNC3ic%0A6EH%2FCxUCgYEA5qSo6zf6yJ5tdwm%2FNnrKwvFksapd%2Bi9%2BnAqQHHTFPtlzKHkZ7d5x%0AdklyzAMaoHVoeggtQynUcxcYKjy3i9Nj29P8wN6DhcxJY4Ohdk%2FsAILTcu8QyPzN%0A%2FcYVHWykmFuS55uEa2Mlv6j%2FTBraRJUYfiEl2ZvR77L5gke4GAsCKxcCgYEAy91D%0AlmTy4ka991Ungy%2BVcNTSw9z50l%2Fzu4GxmAlj1fsuX%2F27nbfpsOFjbvlm4xLfW3qM%0A%2BWkrvKXUuxeIbGcBnVlHFWgc6%2BKt5vNoOzUVsm5i90R%2Fg3vhB5cdvuVoTKf2EU4n%0ANVTSaM%2F6zpzBEHSKtTsbx0FiPjS04bk%2Bsi0REisCgYAwy3s1MEWtNd9AxN4gP4Aw%0AF%2FPOppV1PaESkCWG76lfL4%2FuaxhyO5JTjRxtTubONaih0KMKx4m7w5IINYo7WcCR%0AnFqnzyuSHfMUy59YMXZjcUoc0bkCXIGUA9kpvXdhCFafC0bLlVFCKBXC2xd8VPK2%0AlHq2fAHBLWMeDeBDreiKhwKBgHrcweP8uOioK8rI9kQ4xD649MD4B1PDYjfqRObV%0AGecXN27Ak3bNJTjlzTBPfLNzZ0tRg2649JP%2F%2BUI8P4rdVXrIGHANTAjZl2bt4S51%0Aorrjjh9pl9PdL9SMPXAUABTa0RDC4hxhH2HtnkEw9aX%2BJq5sjiQ7AoNs7mpvYxqs%0A0HH7AoGBALhKD8FxNGYLK8oCO27NBdL%2F%2BypxgH5EnwVr%2B3fF49tfC5xpV9Odfu1Z%0ANGNFbjK47PVCLaGKzQUvU7jSAbKt3pDR0IcfiF%2BM6rc86CmZf%2BvAPTN3%2BJwG%2BcIE%0AcKuYkroIzFWDu9NYiioUI7%2Fa9XdmTvfrT3LMNmup0FoRmlRHD%2FM8%0A-----END%20RSA%20PRIVATE%20KEY----- key-2=-----BEGIN%20RSA%20PRIVATE%20KEY-----%0AMIIEowIBAAKCAQEAt6vq%2FPAW347qigdxemr6L85VVARjehbGuofqYH8%2ByxVLHBx%2F%0ApsuOg7iyj%2Bd2vKaFv2ap%2BQ6phUfCdD%2BHa4z4jDU0ooN%2FA6WNZyAJLbg3KRt9BSVb%0A9I0NOi90MaVPUCd6vT3RCx77X21rwpL%2FcCTPftuSCoyQ87%2BIQ4eUX8tsu%2BN%2BKCGS%0AgZyjnXBzp3scJDA9ZH5R6dtBbNTBHj%2Fg%2BrD9ivEMC%2Fw78Sc184bCcKeWcWrhrf3R%0AUauKowCeDMiVExUO7iokZbd0U1K1VSbvX7Xptr94hUFAY3atuCJ7pFvpW4d2ypKt%0A55rS1ItHF10V3sDRAxBG%2B2eqhS%2FpFkGF5%2Bva3QIDAQABAoIBAAONBE79iUOrLKec%0AezolpU6VS5sDNrUeiZsDk6ln7Fvavof9mQ4tc0TipjkX%2FXiqM32%2By1xwRyC3gW%2Fj%0A5odSw19ai%2Fj0V9lHMxOiT%2BsdW5uk12bpEP0KWQ4d6r4m9wCSstHDxy3S3IM8x0%2BM%0ArfmKDKTkM8%2BWZhsAQe8kSN8NPL3pIJnG%2Ftuc8lwFoZOEot6%2BAeGYdxxEdFbvVyEm%0Aa8%2FAhOQ5Z07T36bxuPtyRjwdnFH7hnmzpcWF5Iz8Jp8SrQ2XX2rKSQpa1Ic%2B6TMA%0AF7kJsOFiw%2B8aX6zTTVLsvQTHWEsnNWHKtbuNBoQcq2HyifrUxr550kZVMnyNC3ic%0A6EH%2FCxUCgYEA5qSo6zf6yJ5tdwm%2FNnrKwvFksapd%2Bi9%2BnAqQHHTFPtlzKHkZ7d5x%0AdklyzAMaoHVoeggtQynUcxcYKjy3i9Nj29P8wN6DhcxJY4Ohdk%2FsAILTcu8QyPzN%0A%2FcYVHWykmFuS55uEa2Mlv6j%2FTBraRJUYfiEl2ZvR77L5gke4GAsCKxcCgYEAy91D%0AlmTy4ka991Ungy%2BVcNTSw9z50l%2Fzu4GxmAlj1fsuX%2F27nbfpsOFjbvlm4xLfW3qM%0A%2BWkrvKXUuxeIbGcBnVlHFWgc6%2BKt5vNoOzUVsm5i90R%2Fg3vhB5cdvuVoTKf2EU4n%0ANVTSaM%2F6zpzBEHSKtTsbx0FiPjS04bk%2Bsi0REisCgYAwy3s1MEWtNd9AxN4gP4Aw%0AF%2FPOppV1PaESkCWG76lfL4%2FuaxhyO5JTjRxtTubONaih0KMKx4m7w5IINYo7WcCR%0AnFqnzyuSHfMUy59YMXZjcUoc0bkCXIGUA9kpvXdhCFafC0bLlVFCKBXC2xd8VPK2%0AlHq2fAHBLWMeDeBDreiKhwKBgHrcweP8uOioK8rI9kQ4xD649MD4B1PDYjfqRObV%0AGecXN27Ak3bNJTjlzTBPfLNzZ0tRg2649JP%2F%2BUI8P4rdVXrIGHANTAjZl2bt4S51%0Aorrjjh9pl9PdL9SMPXAUABTa0RDC4hxhH2HtnkEw9aX%2BJq5sjiQ7AoNs7mpvYxqs%0A0HH7AoGBALhKD8FxNGYLK8oCO27NBdL%2F%2BypxgH5EnwVr%2B3fF49tfC5xpV9Odfu1Z%0ANGNFbjK47PVCLaGKzQUvU7jSAbKt3pDR0IcfiF%2BM6rc86CmZf%2BvAPTN3%2BJwG%2BcIE%0AcKuYkroIzFWDu9NYiioUI7%2Fa9XdmTvfrT3TUVmup0FoRmlRHD%2FM8%0A-----END%20RSA%20PRIVATE%20KEY----- key-3=-----BEGIN%20RSA%20PRIVATE%20KEY-----%0AMIIEowIBAAKCAQEAt6vq%2FPAW347qigdxemr6L85VVARjehbGuofqYH8%2ByxVLHBx%2F%0ApsuOg7iyj%2Bd2vKaFv2ap%2BQ6phUfCdD%2BHa4z4jDU0ooN%2FA6WNZyAJLbg3KRt9BSVb%0A9I0NOi90MaVPUCd6vT3RCx77X21rwpL%2FcCTPftuSCoyQ87%2BIQ4eUX8tsu%2BN%2BKCGS%0AgZyjnXBzp3scJDA9ZH5R6dtBbNTBHj%2Fg%2BrD9ivEMC%2Fw78Sc184bCcKeWcWrhrf3R%0AUauKowCeDMiVExUO7iokZbd0U1K1VSbvX7Xptr94hUFAY3atuCJ7pFvpW4d2ypKt%0A55rS1ItHF10V3sDRAxBG%2B2eqhS%2FpFkGF5%2Bva3QIDAQABAoIBAAONBE79iUOrLKec%0AezolpU6VS5sDNrUeiZsDk6ln7Fvavof9mQ4tc0TipjkX%2FXiqM32%2By1xwRyC3gW%2Fj%0A5odSw19ai%2Fj0V9lHMxOiT%2BsdW5uk12bpEP0KWQ4d6r4m9wCSstHDxy3S3IM8x0%2BM%0ArfmKDKTkM8%2BWZhsAQe8kSN8NPL3pIJnG%2Ftuc8lwFoZOEot6%2BAeGYdxxEdFbvVyEm%0Aa8%2FAhOQ5Z07T36bxuPtyRjwdnFH7hnmzpcWF5Iz8Jp8SrQ2XX2rKSQpa1Ic%2B6TMA%0AF7kJsOFiw%2B8aX6zTTVLsvQTHWEsnNWHKtbuNBoQcq2HyifrUxr550kZVMnyNC3ic%0A6EH%2FCxUCgYEA5qSo6zf6yJ5tdwm%2FNnrKwvFksapd%2Bi9%2BnAqQHHTFPtlzKHkZ7d5x%0AdklyzAMaoHVoeggtQynUcxcYKjy3i9Nj29P8wN6DhcxJY4Ohdk%2FsAILTcu8QyPzN%0A%2FcYVHWykmFuS55uEa2Mlv6j%2FTBraRJUYfiEl2ZvR77L5gke4GAsCKxcCgYEAy91D%0AlmTy4ka991Ungy%2BVcNTSw9z50l%2Fzu4GxmAlj1fsuX%2F27nbfpsOFjbvlm4xLfW3qM%0A%2BWkrvKXUuxeIbGcBnVlHFWgc6%2BKt5vNoOzUVsm5i90R%2Fg3vhB5cdvuVoTKf2EU4n%0ANVTSaM%2F6zpzBEHSKtTsbx0FiPjS04bk%2Bsi0REisCgYAwy3s1MEWtNd9AxN4gP4Aw%0AF%2FPOppV1PaESkCWG76lfL4%2FuaxhyO5JTjRxtTubONaih0KMKx4m7w5IINYo7WcCR%0AnFqnzyuSHfMUy59YMXZjcUoc0bkCXIGUA9kpvXdhCFafC0bLlVFCKBXC2xd8VPK2%0AlHq2fAHBLWMeDeBDreiKhwKBgHrcweP8uOioK8rI9kQ4xD649MD4B1PDYjfqRObV%0AGecXN27Ak3bNJTjlzTBPfLNzZ0tRg2649JP%2F%2BUI8P4rdVXrIGHANTAjZl2bt4S51%0Aorrjjh9pl9PdL9SMPXAUABTa0RDC4hxhH2HtnkEw9aX%2BJq5sjiQ7AoNs7mpvYxqs%0A0HH7AoGBALhKD8FxNGYLK8oCO27NBdL%2F%2BypxgH5EnwVr%2B3fF49tfC5xpV9Odfu1Z%0ANGNFbjK47PVCLaGKzQUvU7jSAbKt3pDR0IcfiF%2BM6rc86CmZf%2BvAPTN3%2BJwG%2BcIE%0AcKuYkroIzFWDu9NYiioUI7%2Fa9XdmTvfrT3RSHmup0FoRmlRHD%2FM8%0A-----END%20RSA%20PRIVATE%20KEY----- multiple-alternative: summary: Enqueue the private key text of multiple certificates. value: key=-----BEGIN%20RSA%20PRIVATE%20KEY-----%0AMIIEowIBAAKCAQEAt6vq%2FPAW347qigdxemr6L85VVARjehbGuofqYH8%2ByxVLHBx%2F%0ApsuOg7iyj%2Bd2vKaFv2ap%2BQ6phUfCdD%2BHa4z4jDU0ooN%2FA6WNZyAJLbg3KRt9BSVb%0A9I0NOi90MaVPUCd6vT3RCx77X21rwpL%2FcCTPftuSCoyQ87%2BIQ4eUX8tsu%2BN%2BKCGS%0AgZyjnXBzp3scJDA9ZH5R6dtBbNTBHj%2Fg%2BrD9ivEMC%2Fw78Sc184bCcKeWcWrhrf3R%0AUauKowCeDMiVExUO7iokZbd0U1K1VSbvX7Xptr94hUFAY3atuCJ7pFvpW4d2ypKt%0A55rS1ItHF10V3sDRAxBG%2B2eqhS%2FpFkGF5%2Bva3QIDAQABAoIBAAONBE79iUOrLKec%0AezolpU6VS5sDNrUeiZsDk6ln7Fvavof9mQ4tc0TipjkX%2FXiqM32%2By1xwRyC3gW%2Fj%0A5odSw19ai%2Fj0V9lHMxOiT%2BsdW5uk12bpEP0KWQ4d6r4m9wCSstHDxy3S3IM8x0%2BM%0ArfmKDKTkM8%2BWZhsAQe8kSN8NPL3pIJnG%2Ftuc8lwFoZOEot6%2BAeGYdxxEdFbvVyEm%0Aa8%2FAhOQ5Z07T36bxuPtyRjwdnFH7hnmzpcWF5Iz8Jp8SrQ2XX2rKSQpa1Ic%2B6TMA%0AF7kJsOFiw%2B8aX6zTTVLsvQTHWEsnNWHKtbuNBoQcq2HyifrUxr550kZVMnyNC3ic%0A6EH%2FCxUCgYEA5qSo6zf6yJ5tdwm%2FNnrKwvFksapd%2Bi9%2BnAqQHHTFPtlzKHkZ7d5x%0AdklyzAMaoHVoeggtQynUcxcYKjy3i9Nj29P8wN6DhcxJY4Ohdk%2FsAILTcu8QyPzN%0A%2FcYVHWykmFuS55uEa2Mlv6j%2FTBraRJUYfiEl2ZvR77L5gke4GAsCKxcCgYEAy91D%0AlmTy4ka991Ungy%2BVcNTSw9z50l%2Fzu4GxmAlj1fsuX%2F27nbfpsOFjbvlm4xLfW3qM%0A%2BWkrvKXUuxeIbGcBnVlHFWgc6%2BKt5vNoOzUVsm5i90R%2Fg3vhB5cdvuVoTKf2EU4n%0ANVTSaM%2F6zpzBEHSKtTsbx0FiPjS04bk%2Bsi0REisCgYAwy3s1MEWtNd9AxN4gP4Aw%0AF%2FPOppV1PaESkCWG76lfL4%2FuaxhyO5JTjRxtTubONaih0KMKx4m7w5IINYo7WcCR%0AnFqnzyuSHfMUy59YMXZjcUoc0bkCXIGUA9kpvXdhCFafC0bLlVFCKBXC2xd8VPK2%0AlHq2fAHBLWMeDeBDreiKhwKBgHrcweP8uOioK8rI9kQ4xD649MD4B1PDYjfqRObV%0AGecXN27Ak3bNJTjlzTBPfLNzZ0tRg2649JP%2F%2BUI8P4rdVXrIGHANTAjZl2bt4S51%0Aorrjjh9pl9PdL9SMPXAUABTa0RDC4hxhH2HtnkEw9aX%2BJq5sjiQ7AoNs7mpvYxqs%0A0HH7AoGBALhKD8FxNGYLK8oCO27NBdL%2F%2BypxgH5EnwVr%2B3fF49tfC5xpV9Odfu1Z%0ANGNFbjK47PVCLaGKzQUvU7jSAbKt3pDR0IcfiF%2BM6rc86CmZf%2BvAPTN3%2BJwG%2BcIE%0AcKuYkroIzFWDu9NYiioUI7%2Fa9XdmTvfrT3LMNmup0FoRmlRHD%2FM8%0A-----END%20RSA%20PRIVATE%20KEY----- key=-----BEGIN%20RSA%20PRIVATE%20KEY-----%0AMIIEowIBAAKCAQEAt6vq%2FPAW347qigdxemr6L85VVARjehbGuofqYH8%2ByxVLHBx%2F%0ApsuOg7iyj%2Bd2vKaFv2ap%2BQ6phUfCdD%2BHa4z4jDU0ooN%2FA6WNZyAJLbg3KRt9BSVb%0A9I0NOi90MaVPUCd6vT3RCx77X21rwpL%2FcCTPftuSCoyQ87%2BIQ4eUX8tsu%2BN%2BKCGS%0AgZyjnXBzp3scJDA9ZH5R6dtBbNTBHj%2Fg%2BrD9ivEMC%2Fw78Sc184bCcKeWcWrhrf3R%0AUauKowCeDMiVExUO7iokZbd0U1K1VSbvX7Xptr94hUFAY3atuCJ7pFvpW4d2ypKt%0A55rS1ItHF10V3sDRAxBG%2B2eqhS%2FpFkGF5%2Bva3QIDAQABAoIBAAONBE79iUOrLKec%0AezolpU6VS5sDNrUeiZsDk6ln7Fvavof9mQ4tc0TipjkX%2FXiqM32%2By1xwRyC3gW%2Fj%0A5odSw19ai%2Fj0V9lHMxOiT%2BsdW5uk12bpEP0KWQ4d6r4m9wCSstHDxy3S3IM8x0%2BM%0ArfmKDKTkM8%2BWZhsAQe8kSN8NPL3pIJnG%2Ftuc8lwFoZOEot6%2BAeGYdxxEdFbvVyEm%0Aa8%2FAhOQ5Z07T36bxuPtyRjwdnFH7hnmzpcWF5Iz8Jp8SrQ2XX2rKSQpa1Ic%2B6TMA%0AF7kJsOFiw%2B8aX6zTTVLsvQTHWEsnNWHKtbuNBoQcq2HyifrUxr550kZVMnyNC3ic%0A6EH%2FCxUCgYEA5qSo6zf6yJ5tdwm%2FNnrKwvFksapd%2Bi9%2BnAqQHHTFPtlzKHkZ7d5x%0AdklyzAMaoHVoeggtQynUcxcYKjy3i9Nj29P8wN6DhcxJY4Ohdk%2FsAILTcu8QyPzN%0A%2FcYVHWykmFuS55uEa2Mlv6j%2FTBraRJUYfiEl2ZvR77L5gke4GAsCKxcCgYEAy91D%0AlmTy4ka991Ungy%2BVcNTSw9z50l%2Fzu4GxmAlj1fsuX%2F27nbfpsOFjbvlm4xLfW3qM%0A%2BWkrvKXUuxeIbGcBnVlHFWgc6%2BKt5vNoOzUVsm5i90R%2Fg3vhB5cdvuVoTKf2EU4n%0ANVTSaM%2F6zpzBEHSKtTsbx0FiPjS04bk%2Bsi0REisCgYAwy3s1MEWtNd9AxN4gP4Aw%0AF%2FPOppV1PaESkCWG76lfL4%2FuaxhyO5JTjRxtTubONaih0KMKx4m7w5IINYo7WcCR%0AnFqnzyuSHfMUy59YMXZjcUoc0bkCXIGUA9kpvXdhCFafC0bLlVFCKBXC2xd8VPK2%0AlHq2fAHBLWMeDeBDreiKhwKBgHrcweP8uOioK8rI9kQ4xD649MD4B1PDYjfqRObV%0AGecXN27Ak3bNJTjlzTBPfLNzZ0tRg2649JP%2F%2BUI8P4rdVXrIGHANTAjZl2bt4S51%0Aorrjjh9pl9PdL9SMPXAUABTa0RDC4hxhH2HtnkEw9aX%2BJq5sjiQ7AoNs7mpvYxqs%0A0HH7AoGBALhKD8FxNGYLK8oCO27NBdL%2F%2BypxgH5EnwVr%2B3fF49tfC5xpV9Odfu1Z%0ANGNFbjK47PVCLaGKzQUvU7jSAbKt3pDR0IcfiF%2BM6rc86CmZf%2BvAPTN3%2BJwG%2BcIE%0AcKuYkroIzFWDu9NYiioUI7%2Fa9XdmTvfrT3TUVmup0FoRmlRHD%2FM8%0A-----END%20RSA%20PRIVATE%20KEY----- key=-----BEGIN%20RSA%20PRIVATE%20KEY-----%0AMIIEowIBAAKCAQEAt6vq%2FPAW347qigdxemr6L85VVARjehbGuofqYH8%2ByxVLHBx%2F%0ApsuOg7iyj%2Bd2vKaFv2ap%2BQ6phUfCdD%2BHa4z4jDU0ooN%2FA6WNZyAJLbg3KRt9BSVb%0A9I0NOi90MaVPUCd6vT3RCx77X21rwpL%2FcCTPftuSCoyQ87%2BIQ4eUX8tsu%2BN%2BKCGS%0AgZyjnXBzp3scJDA9ZH5R6dtBbNTBHj%2Fg%2BrD9ivEMC%2Fw78Sc184bCcKeWcWrhrf3R%0AUauKowCeDMiVExUO7iokZbd0U1K1VSbvX7Xptr94hUFAY3atuCJ7pFvpW4d2ypKt%0A55rS1ItHF10V3sDRAxBG%2B2eqhS%2FpFkGF5%2Bva3QIDAQABAoIBAAONBE79iUOrLKec%0AezolpU6VS5sDNrUeiZsDk6ln7Fvavof9mQ4tc0TipjkX%2FXiqM32%2By1xwRyC3gW%2Fj%0A5odSw19ai%2Fj0V9lHMxOiT%2BsdW5uk12bpEP0KWQ4d6r4m9wCSstHDxy3S3IM8x0%2BM%0ArfmKDKTkM8%2BWZhsAQe8kSN8NPL3pIJnG%2Ftuc8lwFoZOEot6%2BAeGYdxxEdFbvVyEm%0Aa8%2FAhOQ5Z07T36bxuPtyRjwdnFH7hnmzpcWF5Iz8Jp8SrQ2XX2rKSQpa1Ic%2B6TMA%0AF7kJsOFiw%2B8aX6zTTVLsvQTHWEsnNWHKtbuNBoQcq2HyifrUxr550kZVMnyNC3ic%0A6EH%2FCxUCgYEA5qSo6zf6yJ5tdwm%2FNnrKwvFksapd%2Bi9%2BnAqQHHTFPtlzKHkZ7d5x%0AdklyzAMaoHVoeggtQynUcxcYKjy3i9Nj29P8wN6DhcxJY4Ohdk%2FsAILTcu8QyPzN%0A%2FcYVHWykmFuS55uEa2Mlv6j%2FTBraRJUYfiEl2ZvR77L5gke4GAsCKxcCgYEAy91D%0AlmTy4ka991Ungy%2BVcNTSw9z50l%2Fzu4GxmAlj1fsuX%2F27nbfpsOFjbvlm4xLfW3qM%0A%2BWkrvKXUuxeIbGcBnVlHFWgc6%2BKt5vNoOzUVsm5i90R%2Fg3vhB5cdvuVoTKf2EU4n%0ANVTSaM%2F6zpzBEHSKtTsbx0FiPjS04bk%2Bsi0REisCgYAwy3s1MEWtNd9AxN4gP4Aw%0AF%2FPOppV1PaESkCWG76lfL4%2FuaxhyO5JTjRxtTubONaih0KMKx4m7w5IINYo7WcCR%0AnFqnzyuSHfMUy59YMXZjcUoc0bkCXIGUA9kpvXdhCFafC0bLlVFCKBXC2xd8VPK2%0AlHq2fAHBLWMeDeBDreiKhwKBgHrcweP8uOioK8rI9kQ4xD649MD4B1PDYjfqRObV%0AGecXN27Ak3bNJTjlzTBPfLNzZ0tRg2649JP%2F%2BUI8P4rdVXrIGHANTAjZl2bt4S51%0Aorrjjh9pl9PdL9SMPXAUABTa0RDC4hxhH2HtnkEw9aX%2BJq5sjiQ7AoNs7mpvYxqs%0A0HH7AoGBALhKD8FxNGYLK8oCO27NBdL%2F%2BypxgH5EnwVr%2B3fF49tfC5xpV9Odfu1Z%0ANGNFbjK47PVCLaGKzQUvU7jSAbKt3pDR0IcfiF%2BM6rc86CmZf%2BvAPTN3%2BJwG%2BcIE%0AcKuYkroIzFWDu9NYiioUI7%2Fa9XdmTvfrT3RSHmup0FoRmlRHD%2FM8%0A-----END%20RSA%20PRIVATE%20KEY----- single: summary: Enqueue a single certificate's private key text. value: '-----BEGIN%20RSA%20PRIVATE%20KEY-----%0AMIIEowIBAAKCAQEAt6vq%2FPAW347qigdxemr6L85VVARjehbGuofqYH8%2ByxVLHBx%2F%0ApsuOg7iyj%2Bd2vKaFv2ap%2BQ6phUfCdD%2BHa4z4jDU0ooN%2FA6WNZyAJLbg3KRt9BSVb%0A9I0NOi90MaVPUCd6vT3RCx77X21rwpL%2FcCTPftuSCoyQ87%2BIQ4eUX8tsu%2BN%2BKCGS%0AgZyjnXBzp3scJDA9ZH5R6dtBbNTBHj%2Fg%2BrD9ivEMC%2Fw78Sc184bCcKeWcWrhrf3R%0AUauKowCeDMiVExUO7iokZbd0U1K1VSbvX7Xptr94hUFAY3atuCJ7pFvpW4d2ypKt%0A55rS1ItHF10V3sDRAxBG%2B2eqhS%2FpFkGF5%2Bva3QIDAQABAoIBAAONBE79iUOrLKec%0AezolpU6VS5sDNrUeiZsDk6ln7Fvavof9mQ4tc0TipjkX%2FXiqM32%2By1xwRyC3gW%2Fj%0A5odSw19ai%2Fj0V9lHMxOiT%2BsdW5uk12bpEP0KWQ4d6r4m9wCSstHDxy3S3IM8x0%2BM%0ArfmKDKTkM8%2BWZhsAQe8kSN8NPL3pIJnG%2Ftuc8lwFoZOEot6%2BAeGYdxxEdFbvVyEm%0Aa8%2FAhOQ5Z07T36bxuPtyRjwdnFH7hnmzpcWF5Iz8Jp8SrQ2XX2rKSQpa1Ic%2B6TMA%0AF7kJsOFiw%2B8aX6zTTVLsvQTHWEsnNWHKtbuNBoQcq2HyifrUxr550kZVMnyNC3ic%0A6EH%2FCxUCgYEA5qSo6zf6yJ5tdwm%2FNnrKwvFksapd%2Bi9%2BnAqQHHTFPtlzKHkZ7d5x%0AdklyzAMaoHVoeggtQynUcxcYKjy3i9Nj29P8wN6DhcxJY4Ohdk%2FsAILTcu8QyPzN%0A%2FcYVHWykmFuS55uEa2Mlv6j%2FTBraRJUYfiEl2ZvR77L5gke4GAsCKxcCgYEAy91D%0AlmTy4ka991Ungy%2BVcNTSw9z50l%2Fzu4GxmAlj1fsuX%2F27nbfpsOFjbvlm4xLfW3qM%0A%2BWkrvKXUuxeIbGcBnVlHFWgc6%2BKt5vNoOzUVsm5i90R%2Fg3vhB5cdvuVoTKf2EU4n%0ANVTSaM%2F6zpzBEHSKtTsbx0FiPjS04bk%2Bsi0REisCgYAwy3s1MEWtNd9AxN4gP4Aw%0AF%2FPOppV1PaESkCWG76lfL4%2FuaxhyO5JTjRxtTubONaih0KMKx4m7w5IINYo7WcCR%0AnFqnzyuSHfMUy59YMXZjcUoc0bkCXIGUA9kpvXdhCFafC0bLlVFCKBXC2xd8VPK2%0AlHq2fAHBLWMeDeBDreiKhwKBgHrcweP8uOioK8rI9kQ4xD649MD4B1PDYjfqRObV%0AGecXN27Ak3bNJTjlzTBPfLNzZ0tRg2649JP%2F%2BUI8P4rdVXrIGHANTAjZl2bt4S51%0Aorrjjh9pl9PdL9SMPXAUABTa0RDC4hxhH2HtnkEw9aX%2BJq5sjiQ7AoNs7mpvYxqs%0A0HH7AoGBALhKD8FxNGYLK8oCO27NBdL%2F%2BypxgH5EnwVr%2B3fF49tfC5xpV9Odfu1Z%0ANGNFbjK47PVCLaGKzQUvU7jSAbKt3pDR0IcfiF%2BM6rc86CmZf%2BvAPTN3%2BJwG%2BcIE%0AcKuYkroIzFWDu9NYiioUI7%2Fa9XdmTvfrT3RSHmup0FoRmlRHD%2FM8%0A-----END%20RSA%20PRIVATE%20KEY-----' in: query name: key required: true schema: type: string - description: 'The cPanel account username for which to enqueue the SSL certificate installations. **Note:** To add multiple certificates to the installation queue, duplicate or increment the parameter name. For example, `username-1`, `username-2`, and `username-3`.' examples: multiple: summary: Enqueue multiple SSL certificate installations. value: username-1=username1 username-2=username2 username-3=username3 multiple-alternative: summary: Enqueue multiple SSL certificate installations. value: username=username1 username=username2 username=username3 single: summary: Enqueue a single SSL certificate installation. value: username in: query name: username required: true schema: type: string - description: "The name of the web virtual host (vhost) for which to install the certificate.\n\n**Note:**\n\n To add multiple certificates to the installation queue, duplicate or increment the\n parameter name. For example, `vhost_name-1`, `vhost_name-2`, and `vhost_name-3`." examples: multiple: summary: Install the certificate for multiple vhosts. value: vhost_name-1=host1.example.com vhost_name-2=host2.example.com vhost_name-3=host3.example.com multiple-alternative: summary: Install the certificate for multiple vhosts. value: vhost_name=host1.example.com vhost_name=host2.example.com vhost_name=host3.example.com single: summary: Install the certificate for a single vhost. value: host.example.com in: query name: vhost_name required: true schema: format: domain type: string responses: '200': content: application/json: schema: properties: data: type: object metadata: properties: command: description: The method name called. example: enqueue_deferred_ssl_installations type: string reason: description: The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds. example: OK type: string result: description: '* `1` — Success. * `0` — Failed. Check the `reason` field for more details.' enum: - 1 - 0 example: 1 type: integer version: description: The version of the API function. example: 1 type: integer type: object description: HTTP Request was successful. summary: Add SSL certificate to installation queue tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n enqueue_deferred_ssl_installations \\\n username='username' \\\n cab='-----BEGIN%20CERTIFICATE-----%0AMIIB+jCCAWMCAgGjMA0GCSqGSIb3DQEBBAUAMEUxCzAJBgNVBAYTAlVTMRgwFgYD%0AVQQKEw9HVEUgQ29ycG9yYXRpb24xHDAaBgNVBAMTE0dURSBDeWJlclRydXN0IFJv%0Ab3QwHhcNOTYwMjIzMjMwMTAwWhcNMDYwMjIzMjM1OTAwWjBFMQswCQYDVQQGEwJV%0AUzEYMBYGA1UEChMPR1RFIENvcnBvcmF0aW9uMRwwGgYDVQQDExNHVEUgQ3liZXJU%0AcnVzdCBSb290MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC45k+625h8cXyv%0ARLfTD0bZZOWTwUKOx7pJjTUteueLveUFMVnGsS8KDPufpz+iCWaEVh43KRuH6X4M%0AypqfpX/1FZSj1aJGgthoTNE3FQZor734sLPwKfWVWgkWYXcKIiXUT0Wqx73llt/5%0A1KiOQswkwB6RJ0q1bQaAYznEol44AwIDAQABMA0GCSqGSIb3DQEBBAUAA4GBABKz%0AdcZfHeFhVYAA1IFLezEPI2PnPfMD+fQ2qLvZ46WXTeorKeDWanOB5sCJo9Px4KWl%0AIjeaY8JIILTbcuPI9tl8vrGvU9oUtCG41tWW4/5ODFlitppK+ULdjG+BqXH/9Apy%0AbW1EDp3zdHSo1TRJ6V6e6bR64eVaH4QwnNOfpSXY%0A-----END%20CERTIFICATE-----' \\\n crt='-----BEGIN%20CERTIFICATE-----%0AMIIDNTCCAh2gAwIBAgIFAY0o0kwwDQYJKoZIhvcNAQELBQAwFjEUMBIGA1UEAwwL%0AZG9tYWluLnRlc3QwHhcNMTcxMDMxMTUyMjU1WhcNMTgxMDMxMTUyMjU1WjAWMRQw%0AEgYDVQQDDAtkb21haW4udGVzdDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoC%0AggEBALer6vzwFt%2BO6ooHcXpq%2Bi%2FOVVQEY3oWxrqH6mB%2FPssVSxwcf6bLjoO4so%2Fn%0Adrymhb9mqfkOqYVHwnQ%2Fh2uM%2BIw1NKKDfwOljWcgCS24NykbfQUlW%2FSNDTovdDGl%0AT1Aner090Qse%2B19ta8KS%2F3Akz37bkgqMkPO%2FiEOHlF%2FLbLvjfighkoGco51wc6d7%0AHCQwPWR%2BUenbQWzUwR4%2F4Pqw%2FYrxDAv8O%2FEnNfOGwnCnlnFq4a390VGriqMAngzI%0AlRMVDu4qJGW3dFNStVUm71%2B16ba%2FeIVBQGN2rbgie6Rb6VuHdsqSreea0tSLRxdd%0AFd7A0QMQRvtnqoUv6RZBhefr2t0CAwEAAaOBiTCBhjAdBgNVHQ4EFgQUeitnD4U4%0AMXtmLX53dTAZPENjovwwHwYDVR0jBBgwFoAUeitnD4U4MXtmLX53dTAZPENjovww%0ACQYDVR0TBAIwADA5BgNVHREEMjAwggtkb21haW4udGVzdIIQbWFpbC5kb21haW4u%0AdGVzdIIPd3d3LmRvbWFpbi50ZXN0MA0GCSqGSIb3DQEBCwUAA4IBAQAeD4Fc%2FBwM%0AfJEvlPO30%2FOp2JJxG92tbgsoY9CKTYoZy0IMHhwOrt%2FB36joYDrOhtiO6XsRw4Zm%0AAPT8ey9p61kUc6XWs5oU9aifKeAKzWCZV9wQphbY%2F0rQp1YPsVN9tBgiag754HPo%0AbNDhWOZSZDKnh82DikTD6iciTxeblrvcbFC4Z76JH31dvqmNMEAgZvPCpq86Ued5%0A52gKM0u2%2BrK%2FzIYjh%2FhooqN%2BTY%2BJQ667JzLzPNenzAYFsoIQgVj6%2FZoFqJA4nbxC%0Azv%2Fspqc0OQ2W9m5egRPDhngKt%2Bi9804N7FeilBL%2FcpEgUHhgzMBi1T9n%2BYBrc6bO%0AjNjvnEQRbqZY%0A-----END%20CERTIFICATE-----' \\\n key='-----BEGIN%20RSA%20PRIVATE%20KEY-----%0AMIIEowIBAAKCAQEAt6vq%2FPAW347qigdxemr6L85VVARjehbGuofqYH8%2ByxVLHBx%2F%0ApsuOg7iyj%2Bd2vKaFv2ap%2BQ6phUfCdD%2BHa4z4jDU0ooN%2FA6WNZyAJLbg3KRt9BSVb%0A9I0NOi90MaVPUCd6vT3RCx77X21rwpL%2FcCTPftuSCoyQ87%2BIQ4eUX8tsu%2BN%2BKCGS%0AgZyjnXBzp3scJDA9ZH5R6dtBbNTBHj%2Fg%2BrD9ivEMC%2Fw78Sc184bCcKeWcWrhrf3R%0AUauKowCeDMiVExUO7iokZbd0U1K1VSbvX7Xptr94hUFAY3atuCJ7pFvpW4d2ypKt%0A55rS1ItHF10V3sDRAxBG%2B2eqhS%2FpFkGF5%2Bva3QIDAQABAoIBAAONBE79iUOrLKec%0AezolpU6VS5sDNrUeiZsDk6ln7Fvavof9mQ4tc0TipjkX%2FXiqM32%2By1xwRyC3gW%2Fj%0A5odSw19ai%2Fj0V9lHMxOiT%2BsdW5uk12bpEP0KWQ4d6r4m9wCSstHDxy3S3IM8x0%2BM%0ArfmKDKTkM8%2BWZhsAQe8kSN8NPL3pIJnG%2Ftuc8lwFoZOEot6%2BAeGYdxxEdFbvVyEm%0Aa8%2FAhOQ5Z07T36bxuPtyRjwdnFH7hnmzpcWF5Iz8Jp8SrQ2XX2rKSQpa1Ic%2B6TMA%0AF7kJsOFiw%2B8aX6zTTVLsvQTHWEsnNWHKtbuNBoQcq2HyifrUxr550kZVMnyNC3ic%0A6EH%2FCxUCgYEA5qSo6zf6yJ5tdwm%2FNnrKwvFksapd%2Bi9%2BnAqQHHTFPtlzKHkZ7d5x%0AdklyzAMaoHVoeggtQynUcxcYKjy3i9Nj29P8wN6DhcxJY4Ohdk%2FsAILTcu8QyPzN%0A%2FcYVHWykmFuS55uEa2Mlv6j%2FTBraRJUYfiEl2ZvR77L5gke4GAsCKxcCgYEAy91D%0AlmTy4ka991Ungy%2BVcNTSw9z50l%2Fzu4GxmAlj1fsuX%2F27nbfpsOFjbvlm4xLfW3qM%0A%2BWkrvKXUuxeIbGcBnVlHFWgc6%2BKt5vNoOzUVsm5i90R%2Fg3vhB5cdvuVoTKf2EU4n%0ANVTSaM%2F6zpzBEHSKtTsbx0FiPjS04bk%2Bsi0REisCgYAwy3s1MEWtNd9AxN4gP4Aw%0AF%2FPOppV1PaESkCWG76lfL4%2FuaxhyO5JTjRxtTubONaih0KMKx4m7w5IINYo7WcCR%0AnFqnzyuSHfMUy59YMXZjcUoc0bkCXIGUA9kpvXdhCFafC0bLlVFCKBXC2xd8VPK2%0AlHq2fAHBLWMeDeBDreiKhwKBgHrcweP8uOioK8rI9kQ4xD649MD4B1PDYjfqRObV%0AGecXN27Ak3bNJTjlzTBPfLNzZ0tRg2649JP%2F%2BUI8P4rdVXrIGHANTAjZl2bt4S51%0Aorrjjh9pl9PdL9SMPXAUABTa0RDC4hxhH2HtnkEw9aX%2BJq5sjiQ7AoNs7mpvYxqs%0A0HH7AoGBALhKD8FxNGYLK8oCO27NBdL%2F%2BypxgH5EnwVr%2B3fF49tfC5xpV9Odfu1Z%0ANGNFbjK47PVCLaGKzQUvU7jSAbKt3pDR0IcfiF%2BM6rc86CmZf%2BvAPTN3%2BJwG%2BcIE%0AcKuYkroIzFWDu9NYiioUI7%2Fa9XdmTvfrT3RSHmup0FoRmlRHD%2FM8%0A-----END%20RSA%20PRIVATE%20KEY-----' \\\n vhost_name='host.example.com'\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/enqueue_deferred_ssl_installations?api.version=1&username=username&cab=-----BEGIN%2520CERTIFICATE-----%250AMIIB%2bjCCAWMCAgGjMA0GCSqGSIb3DQEBBAUAMEUxCzAJBgNVBAYTAlVTMRgwFgYD%250AVQQKEw9HVEUgQ29ycG9yYXRpb24xHDAaBgNVBAMTE0dURSBDeWJlclRydXN0IFJv%250Ab3QwHhcNOTYwMjIzMjMwMTAwWhcNMDYwMjIzMjM1OTAwWjBFMQswCQYDVQQGEwJV%250AUzEYMBYGA1UEChMPR1RFIENvcnBvcmF0aW9uMRwwGgYDVQQDExNHVEUgQ3liZXJU%250AcnVzdCBSb290MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC45k%2b625h8cXyv%250ARLfTD0bZZOWTwUKOx7pJjTUteueLveUFMVnGsS8KDPufpz%2biCWaEVh43KRuH6X4M%250AypqfpX%2f1FZSj1aJGgthoTNE3FQZor734sLPwKfWVWgkWYXcKIiXUT0Wqx73llt%2f5%250A1KiOQswkwB6RJ0q1bQaAYznEol44AwIDAQABMA0GCSqGSIb3DQEBBAUAA4GBABKz%250AdcZfHeFhVYAA1IFLezEPI2PnPfMD%2bfQ2qLvZ46WXTeorKeDWanOB5sCJo9Px4KWl%250AIjeaY8JIILTbcuPI9tl8vrGvU9oUtCG41tWW4%2f5ODFlitppK%2bULdjG%2bBqXH%2f9Apy%250AbW1EDp3zdHSo1TRJ6V6e6bR64eVaH4QwnNOfpSXY%250A-----END%2520CERTIFICATE-----&crt=-----BEGIN%2520CERTIFICATE-----%250AMIIDNTCCAh2gAwIBAgIFAY0o0kwwDQYJKoZIhvcNAQELBQAwFjEUMBIGA1UEAwwL%250AZG9tYWluLnRlc3QwHhcNMTcxMDMxMTUyMjU1WhcNMTgxMDMxMTUyMjU1WjAWMRQw%250AEgYDVQQDDAtkb21haW4udGVzdDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoC%250AggEBALer6vzwFt%252BO6ooHcXpq%252Bi%252FOVVQEY3oWxrqH6mB%252FPssVSxwcf6bLjoO4so%252Fn%250Adrymhb9mqfkOqYVHwnQ%252Fh2uM%252BIw1NKKDfwOljWcgCS24NykbfQUlW%252FSNDTovdDGl%250AT1Aner090Qse%252B19ta8KS%252F3Akz37bkgqMkPO%252FiEOHlF%252FLbLvjfighkoGco51wc6d7%250AHCQwPWR%252BUenbQWzUwR4%252F4Pqw%252FYrxDAv8O%252FEnNfOGwnCnlnFq4a390VGriqMAngzI%250AlRMVDu4qJGW3dFNStVUm71%252B16ba%252FeIVBQGN2rbgie6Rb6VuHdsqSreea0tSLRxdd%250AFd7A0QMQRvtnqoUv6RZBhefr2t0CAwEAAaOBiTCBhjAdBgNVHQ4EFgQUeitnD4U4%250AMXtmLX53dTAZPENjovwwHwYDVR0jBBgwFoAUeitnD4U4MXtmLX53dTAZPENjovww%250ACQYDVR0TBAIwADA5BgNVHREEMjAwggtkb21haW4udGVzdIIQbWFpbC5kb21haW4u%250AdGVzdIIPd3d3LmRvbWFpbi50ZXN0MA0GCSqGSIb3DQEBCwUAA4IBAQAeD4Fc%252FBwM%250AfJEvlPO30%252FOp2JJxG92tbgsoY9CKTYoZy0IMHhwOrt%252FB36joYDrOhtiO6XsRw4Zm%250AAPT8ey9p61kUc6XWs5oU9aifKeAKzWCZV9wQphbY%252F0rQp1YPsVN9tBgiag754HPo%250AbNDhWOZSZDKnh82DikTD6iciTxeblrvcbFC4Z76JH31dvqmNMEAgZvPCpq86Ued5%250A52gKM0u2%252BrK%252FzIYjh%252FhooqN%252BTY%252BJQ667JzLzPNenzAYFsoIQgVj6%252FZoFqJA4nbxC%250Azv%252Fspqc0OQ2W9m5egRPDhngKt%252Bi9804N7FeilBL%252FcpEgUHhgzMBi1T9n%252BYBrc6bO%250AjNjvnEQRbqZY%250A-----END%2520CERTIFICATE-----&key=-----BEGIN%2520RSA%2520PRIVATE%2520KEY-----%250AMIIEowIBAAKCAQEAt6vq%252FPAW347qigdxemr6L85VVARjehbGuofqYH8%252ByxVLHBx%252F%250ApsuOg7iyj%252Bd2vKaFv2ap%252BQ6phUfCdD%252BHa4z4jDU0ooN%252FA6WNZyAJLbg3KRt9BSVb%250A9I0NOi90MaVPUCd6vT3RCx77X21rwpL%252FcCTPftuSCoyQ87%252BIQ4eUX8tsu%252BN%252BKCGS%250AgZyjnXBzp3scJDA9ZH5R6dtBbNTBHj%252Fg%252BrD9ivEMC%252Fw78Sc184bCcKeWcWrhrf3R%250AUauKowCeDMiVExUO7iokZbd0U1K1VSbvX7Xptr94hUFAY3atuCJ7pFvpW4d2ypKt%250A55rS1ItHF10V3sDRAxBG%252B2eqhS%252FpFkGF5%252Bva3QIDAQABAoIBAAONBE79iUOrLKec%250AezolpU6VS5sDNrUeiZsDk6ln7Fvavof9mQ4tc0TipjkX%252FXiqM32%252By1xwRyC3gW%252Fj%250A5odSw19ai%252Fj0V9lHMxOiT%252BsdW5uk12bpEP0KWQ4d6r4m9wCSstHDxy3S3IM8x0%252BM%250ArfmKDKTkM8%252BWZhsAQe8kSN8NPL3pIJnG%252Ftuc8lwFoZOEot6%252BAeGYdxxEdFbvVyEm%250Aa8%252FAhOQ5Z07T36bxuPtyRjwdnFH7hnmzpcWF5Iz8Jp8SrQ2XX2rKSQpa1Ic%252B6TMA%250AF7kJsOFiw%252B8aX6zTTVLsvQTHWEsnNWHKtbuNBoQcq2HyifrUxr550kZVMnyNC3ic%250A6EH%252FCxUCgYEA5qSo6zf6yJ5tdwm%252FNnrKwvFksapd%252Bi9%252BnAqQHHTFPtlzKHkZ7d5x%250AdklyzAMaoHVoeggtQynUcxcYKjy3i9Nj29P8wN6DhcxJY4Ohdk%252FsAILTcu8QyPzN%250A%252FcYVHWykmFuS55uEa2Mlv6j%252FTBraRJUYfiEl2ZvR77L5gke4GAsCKxcCgYEAy91D%250AlmTy4ka991Ungy%252BVcNTSw9z50l%252Fzu4GxmAlj1fsuX%252F27nbfpsOFjbvlm4xLfW3qM%250A%252BWkrvKXUuxeIbGcBnVlHFWgc6%252BKt5vNoOzUVsm5i90R%252Fg3vhB5cdvuVoTKf2EU4n%250ANVTSaM%252F6zpzBEHSKtTsbx0FiPjS04bk%252Bsi0REisCgYAwy3s1MEWtNd9AxN4gP4Aw%250AF%252FPOppV1PaESkCWG76lfL4%252FuaxhyO5JTjRxtTubONaih0KMKx4m7w5IINYo7WcCR%250AnFqnzyuSHfMUy59YMXZjcUoc0bkCXIGUA9kpvXdhCFafC0bLlVFCKBXC2xd8VPK2%250AlHq2fAHBLWMeDeBDreiKhwKBgHrcweP8uOioK8rI9kQ4xD649MD4B1PDYjfqRObV%250AGecXN27Ak3bNJTjlzTBPfLNzZ0tRg2649JP%252F%252BUI8P4rdVXrIGHANTAjZl2bt4S51%250Aorrjjh9pl9PdL9SMPXAUABTa0RDC4hxhH2HtnkEw9aX%252BJq5sjiQ7AoNs7mpvYxqs%250A0HH7AoGBALhKD8FxNGYLK8oCO27NBdL%252F%252BypxgH5EnwVr%252B3fF49tfC5xpV9Odfu1Z%250ANGNFbjK47PVCLaGKzQUvU7jSAbKt3pDR0IcfiF%252BM6rc86CmZf%252BvAPTN3%252BJwG%252BcIE%250AcKuYkroIzFWDu9NYiioUI7%252Fa9XdmTvfrT3RSHmup0FoRmlRHD%252FM8%250A-----END%2520RSA%2520PRIVATE%2520KEY-----&vhost_name=host.example.com x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '88' servers: - description: A server running WHM. url: https://{host}:{port}/json-api variables: host: default: whm-server.tld description: The hostname of a server running WHM. port: default: '2087' description: The WHM port. /fetch_service_ssl_components: get: description: This function lists the system's services and their associated certificates. operationId: SSL-fetch_service_ssl_components parameters: [] responses: '200': content: application/json: schema: properties: data: properties: services: description: An array of objects containing the certificate information for each service. items: properties: cabundle: description: 'The Certificate Authority (CA) information. This function returns an empty string if no CA bundle exists for the certificate.' example: '' type: string certificate: description: The SSL certificate's contents. example: REDACTED_CERTIFICATE_EXAMPLE format: pem-certificate type: string certificate_info: description: An object containing certificate information data. properties: domains: description: The domains that correspond to the certificate. items: example: example.com format: domain type: string type: array ecdsa_curve_name: description: 'The ECDSA curve that the certificate''s key uses. * `prime256v1` * `secp384r1` * `null` — The certificate''s key is **not** an ECDSA key.' enum: - prime256v1 - secp384r1 example: null type: - string - 'null' ecdsa_public: description: 'The certificate''s key''s ECDSA compressed public point, in hexadecimal format. * `null` — The certificate''s key is **not** an ECDSA key.' example: null type: - string - 'null' is_self_signed: description: 'Whether the certificate is self-signed. * `1` — Self-signed. * `0` — **Not** self-signed.' enum: - 1 - 0 example: 1 type: integer issuer.commonName: description: The certificate's Common Name. example: example.com type: string issuer.organizationName: description: The certificate's Organization Name. example: Writer's Guild of America type: string issuer_text: description: Information about the issuer. example: 'countryName US stateOrProvinceName Unknown localityName Unknown organizationName Unknown organizationalUnitName Unknown commonName example.com emailAddress test@example.com' type: string key_algorithm: description: 'The certificate''s key''s algorithm. * `rsaEncryption` — RSA. * `id-ecPublicKey` — ECDSA.' enum: - rsaEncryption - id-ecPublicKey example: rsaEncryption type: string modulus: description: 'The certificate''s key''s modulus, in hexadecimal format. * `null` — The certificate''s key is **not** an RSA key.' example: null type: - string - 'null' modulus_length: description: 'The certificate''s modulus size. * `null` — The certificate''s key is **not** an RSA key.' example: null type: - integer - 'null' not_after: description: The date the certificate expires. example: 1601467200 format: unix_timestamp type: integer not_before: description: The certificate's validation date. example: 1569844800 format: unix_timestamp type: integer type: object key: description: The certificate's private key. example: REDACTED_PRIVATE_KEY_EXAMPLE format: pem-private-key type: string service: description: 'The service that the certificate corresponds to. * `ftp` * `exim` * `dovecot` * `cpanel`' enum: - ftp - exim - dovecot - cpanel example: ftp type: string type: object type: array type: object metadata: properties: command: description: The method name called. example: fetch_service_ssl_components type: string reason: description: The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds. example: OK type: string result: description: '* `1` — Success. * `0` — Failed. Check the `reason` field for more details.' enum: - 1 - 0 example: 1 type: integer version: description: The version of the API function. example: 1 type: integer type: object description: HTTP Request was successful. summary: Return system services and associated certificates tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n fetch_service_ssl_components\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/fetch_service_ssl_components?api.version=1 x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '11.40' servers: - description: A server running WHM. url: https://{host}:{port}/json-api variables: host: default: whm-server.tld description: The hostname of a server running WHM. port: default: '2087' description: The WHM port. /fetch_ssl_certificates_for_fqdns: get: description: This function retrieves the certificate information for all fully qualified domain names (FQDNs) that the account owns. operationId: SSL-fetch_ssl_certificates_for_fqdns parameters: - description: 'A comma-separated list of domains for which to retrieve information. **Note:** For browser-based calls, you **must** URI-encode each comma (`%2C`).' examples: multiple: summary: Fetch information for multiple domains. value: domains=example-1.com,example-2.com,example-3.com single: summary: Fetch information for a single domain. value: example.com in: query name: domains required: true schema: format: domain type: string responses: '200': content: application/json: schema: properties: data: properties: payload: description: Information about the certificate. items: properties: cab: description: The CA bundle's contents. example: REDACTED_CERTIFICATE_EXAMPLE format: pem-certificate type: - string - 'null' created: description: The date the certificate was created. example: 1538308800 format: unix_timestamp type: integer crt: description: The certificate's contents. example: REDACTED_CERTIFICATE_EXAMPLE format: pem-certificate type: string domains: description: The domains that the CSR covers. example: - example.servername.com - example.com - mail.example.com - www.example.com - www.example.servername.com items: format: domain type: string type: array ecdsa_curve_name: description: 'The ECDSA curve that the certificate''s key uses. * `prime256v1` * `secp384r1` * `null` — The certificate''s key is **not** an ECDSA key.' enum: - prime256v1 - secp384r1 example: null type: - string - 'null' ecdsa_public: description: 'The certificate''s key''s ECDSA compressed public point, in hexadecimal format. * `null` — The certificate''s key is **not** an ECDSA key.' example: null type: - string - 'null' friendly_name: description: The certificate's friendly name. example: example.com type: string id: description: The certificate's identification. example: example_servername_com_ce52d_6e643_2813308004_119580f9b01960cjones72bc519206bc type: string is_self_signed: description: 'Whether the certificate is self-signed. * `1` — Self-signed. * `0` — **Not** self-signed.' enum: - 1 - 0 example: 0 type: integer issuer.commonName: description: The certificate's Common Name. example: example.servername.com type: string issuer.organizationName: description: The certificate's Organization Name. example: Organization type: string key: description: The private key's text. example: REDACTED_PRIVATE_KEY_EXAMPLE format: pem-private-key type: string key_algorithm: description: 'The certificate''s key''s algorithm. * `rsaEncryption` — RSA. * `id-ecPublicKey` — ECDSA.' enum: - rsaEncryption - id-ecPublicKey example: rsaEncryption type: string modulus: description: 'The certificate''s key''s modulus, in hexadecimal format. * `null` — The certificate''s key is **not** an RSA key.' example: ab4c2a3cc30ff10e918915dee7b5171318373de000774d31c4546bea93303d9b56ae4728615d247c7119ee72660fa05d527b97ac3a936f5cfbf027aa505b79f9942d8c6b79e428cf15a5241db344ad99b697c6ca07ab239c44d9ede7b8017c7f99a7ff8e1819d28e123004b987cecd3a8179ca0fd8d2d9ee9dca6efd1cb3797cc92f1cb4327d163069b6c39b17487e25e286862e8ac65b20d47d03e3c00c1c42c562f7b159ef312546bbbffe327fb6a8a354b10bbf5016b9d264b999c92662960af913e98a48201f145706d382716e67ce94b3661f7b5ee931ab4054957c3006d1ca6dd9e2b996999af5c6b4dda12f8b4b0cf89027df058e69b03469fd646a01 type: - string - 'null' modulus_length: description: 'The certificate''s key''s modulus length. * `null` — The certificate''s key is **not** an RSA key.' example: 2048 type: - integer - 'null' not_after: description: The date the certificate expired. example: 1569844800 format: unix_timestamp type: integer not_before: description: The date the certificate started. example: 1538308800 format: unix_timestamp type: integer signature_algorithm: description: The certificate's OID hash algorithm signature. example: sha256WithRSAEncryption type: string subject.commonName: description: The certificate's Common Name. example: example.com type: string users: description: A list of cPanel account owners. example: - username items: format: username type: string type: array validation_type: description: 'The certificate''s validation type. * `ev` — Extended Validation. * `ov` — Organization Validated. * `dv` — Domain Validated. * `null` — The system could **not** parse and determine the certificate''s validation type.' enum: - ev - ov - dv example: dv type: - string - 'null' verify_error: description: An error message that explains the reason for a verification error. example: DEPTH_ZERO_SELF_SIGNED_CERT type: string type: array type: object metadata: properties: command: description: The method name called. example: fetch_ssl_certificates_for_fqdns type: string reason: description: The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds. example: OK type: string result: description: '* `1` — Success. * `0` — Failed. Check the `reason` field for more details.' enum: - 1 - 0 example: 1 type: integer version: description: The version of the API function. example: 1 type: integer type: object description: HTTP Request was successful. summary: Return cPanel account FQDN certificate information tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n fetch_ssl_certificates_for_fqdns \\\n domains='example.com'\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/fetch_ssl_certificates_for_fqdns?api.version=1&domains=example.com x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '66' servers: - description: A server running WHM. url: https://{host}:{port}/json-api variables: host: default: whm-server.tld description: The hostname of a server running WHM. port: default: '2087' description: The WHM port. /fetch_ssl_vhosts: get: description: This function lists the server's virtual hosts (vhosts) and their installed SSL certificates. operationId: SSL-fetch_ssl_vhosts parameters: [] responses: '200': content: application/json: schema: properties: data: properties: vhosts: description: An array of objects containing virtual host information. items: properties: crt: description: Information about the certificate. properties: created: description: The date the certificate was created. example: 1538308800 format: unix_timestamp type: integer domains: description: A list of the certificate's associated domains. example: - example.com - subdomain.example.com items: format: domain type: string type: array ecdsa_curve_name: description: 'The ECDSA curve that the certificate''s key uses. * `prime256v1` * `secp384r1` * `null` — The certificate''s key is **not** an ECDSA key.' enum: - prime256v1 - secp384r1 example: null type: - string - 'null' ecdsa_public: description: 'The certificate''s key''s ECDSA compressed public point, in hexadecimal format. * `null` — The certificate''s key is **not** an ECDSA key.' example: null type: - string - 'null' encryption_algorithm: description: 'The certificate''s key''s algorithm. * `rsaEncryption` — RSA. * `id-ecPublicKey` — ECDSA.' enum: - rsaEncryption - id-ecPublicKey example: rsaEncryption type: string id: description: The certificate's ID. example: example1_com_e353a_5bc13_1408033388_9a1d40aff655f98fed7206e5af466065 type: string is_self_signed: description: 'Whether the certificate is self-signed. * `1` — Self-signed. * `0` — Not self-signed.' enum: - 1 - 0 example: 1 type: integer issuer.commonName: description: The certificate's issuer. example: example.com type: string issuer.organizationName: description: The certificate's Organization Name. example: Organization type: string issuer_text: description: The full text of issuer information. example: 'commonName subdomain.example.com' type: string modulus: description: 'The certificate''s key''s modulus, in hexadecimal format. * `null` — The certificate''s key is **not** an RSA key.' example: e353aa25cc8ad05d3225611e4410c0270c11b2d46f88705d3d179a23102ab24ee167c1a9070b9f554e83bade1b84256e11c5a0cb2ac96b96f28e802b11c721d73fbfe61dd9839974a6fce4e17915c0fbf885056f18656041cf70db460b22cab5fd2502491e4ab9f0d2cb727480e0ebd62e83870acda31bfa2d4625efd82234f9729f351ea02fb162609c1654c11b5dec468539a3bb83073a85f78bcf577cd8b718501145cccd89d7adb0bb18c872e7303a15e2c75a6ab315c7fa099e4351a4f0ff126c2693f71d9f21d9f798b94bb689277083fea8dcc01b6af268d0ad8b7a481f8a179d07639cdf3290c93723937a767c400a8ce4b1ca19f0a7117084d5bc13 type: - string - 'null' modulus_length: description: 'The certificate''s key''s modulus length. * `null` — The certificate''s key is **not** an RSA key.' example: 2048 type: - integer - 'null' not_after: description: The date the certificate expires. example: 1601467200 format: unix_timestamp type: integer not_before: description: The date the certificate became active. example: 1569844800 format: unix_timestamp type: integer public_exponent: description: The certificate's exponent. example: '010001' type: string signature_algorithm: description: The certificate's OID hash algorithm. example: sha256WithRSAEncryption type: string subject.commonName: description: An object containing the certificate's Common Name. properties: commonName: description: The certificate's Common Name. example: example.com type: string type: object subject_text: description: The certificate's subject text. example: 'commonName subdomain.example.com' type: string validation_type: description: 'The certificate''s validation type. * `dv` — Domain validation. * `ev` — Extended validation. * `ov` — Organizational validation. * `null` — Self-signed certificate.' enum: - dv - ev - ov example: dv type: - string - 'null' type: object docroot: description: The absolute directory path of the primary domain's document root. example: /home/example/public_html format: path type: string domains: description: A list of the virtual host's domains. example: - example.com items: format: domain type: string type: array ip: description: The virtual host's IP address. example: 192.168.0.20 format: ipv4 type: string iptype: description: 'The type of IP address. * `shared` * `dedicated`' enum: - shared - dedicated example: dedicated type: string ipv6: description: The virtual host's IPv6 address. example: 2001:0db8:0:0:1:0:0:1 format: ipv6 type: string is_primary_on_ip: description: 'Whether the certificate''s domain is the IP address''s primary domain. * `1` — Primary domain. * `0` — **Not** the primary domain.' enum: - 1 - 0 example: 1 type: integer mail_sni_status: description: 'Whether SNI for mail is enabled. * `1` — Enabled. * `0` — Disabled.' enum: - 1 - 0 example: 1 type: integer needs_sni: description: 'Whether the virtual host requires SNI to function properly for SSL certificates. * `1` — Requires SNI. * `0` — Does **not** require SNI.' enum: - 1 - 0 example: 0 type: integer servername: description: The virtual host's primary domain. example: example.com format: domain type: string type: description: 'The virtual host''s domain type. * `addon` — Addon domain. * `main` — Main domain on account. * `parked` — Parked domain. * `sub` — Subomain.' enum: - addon - main - parked - sub example: sub type: string user: description: The virtual host's username. example: example format: username type: string type: object type: array type: object metadata: properties: command: description: The method name called. example: fetch_ssl_vhosts type: string reason: description: The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds. example: OK type: string result: description: '* `1` — Success. * `0` — Failed. Check the `reason` field for more details.' enum: - 1 - 0 example: 1 type: integer version: description: The version of the API function. example: 1 type: integer type: object description: HTTP Request was successful. summary: Return server vhosts and SSL certificates tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n fetch_ssl_vhosts\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/fetch_ssl_vhosts?api.version=1 x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '11.32' servers: - description: A server running WHM. url: https://{host}:{port}/json-api variables: host: default: whm-server.tld description: The hostname of a server running WHM. port: default: '2087' description: The WHM port. /fetch_vhost_ssl_components: get: description: 'This function lists the components of each SSL certificate on the server''s virtual hosts. **Warning:** * On most servers, this function returns a large amount of output. We **strongly** recommend that you filter and sort the output. * The following example uses the filter and sort options: `https://hostname.example.com:2087/cpsess##########/json-api/fetch_vhost_ssl_components?api.version=1&api.filter.a.field=servername&api.filter.a.arg0=servername.com&api.filter.a.type=eq&api.filter.enable=1&api.sort.enable=1&api.sort.a.field=servername`' operationId: SSL-fetch_vhost_ssl_components parameters: [] responses: '200': content: application/json: schema: properties: data: properties: components: description: An array of objects containing the certificate information. items: properties: cabundle: description: The certificate's certificate authority (CA) bundle. example: null type: - string - 'null' cabundle_id: description: The ID of the certificate's CA bundle. example: null type: - string - 'null' certificate: description: The certificate's text. example: REDACTED_CERTIFICATE_EXAMPLE type: string certificate_id: description: The certificate's ID. example: example_com_ecfeb_5c8df_1608653403_1de5d524f287f7ec75531239a2f4a133 type: string key: description: The certificate's private key. example: REDACTED_PRIVATE_KEY_EXAMPLE type: string key_id: description: The ID of the certificate's key. example: ecfeb_5c8df_35927dbac0386ff253c269a9cda4c6f3 type: string servername: description: The domain or domains that the certificate covers. example: example.com format: domain type: string type: object type: array type: object metadata: properties: command: description: The method name called. example: fetch_vhost_ssl_components type: string reason: description: The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds. example: OK type: string result: description: '* `1` — Success. * `0` — Failed. Check the `reason` field for more details.' enum: - 1 - 0 example: 1 type: integer version: description: The version of the API function. example: 1 type: integer type: object description: HTTP Request was successful. summary: Return all SSL certificate components on vhost tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n fetch_vhost_ssl_components\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/fetch_vhost_ssl_components?api.version=1 x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '11.32' servers: - description: A server running WHM. url: https://{host}:{port}/json-api variables: host: default: whm-server.tld description: The hostname of a server running WHM. port: default: '2087' description: The WHM port. /fetchcrtinfo: get: description: This function retrieves information about a certificate. operationId: SSL-fetchcrtinfo parameters: - description: The certificate's internal system ID. in: query name: id required: true schema: example: example_com_bf638_f81af_1500191700_79e34f42c83f748bd49474ab9d66f7cd type: string - description: The cPanel account's username. in: query name: user required: true schema: example: username format: username type: string responses: '200': content: application/json: schema: properties: data: properties: cabundle: description: The certificate authority (CA) bundle certificate. example: REDACTED_CERTIFICATE_EXAMPLE type: string certificate: description: The certificate's text. example: REDACTED_CERTIFICATE_EXAMPLE type: string is_self_signed: description: 'Whether the certificate is self-signed. * `1` — Self-signed. * `0` — **Not** self-signed.' enum: - 1 - 0 example: 0 type: integer key: description: The private key's text. example: REDACTED_PRIVATE_KEY_EXAMPLE type: string subject.commonName_ip: description: The certificate's IP address. example: 192.0.2.0 format: ipv4 type: string type: object metadata: properties: command: description: The method name called. example: fetchcrtinfo type: string reason: description: The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds. example: OK type: string result: description: '* `1` — Success. * `0` — Failed. Check the `reason` field for more details.' enum: - 1 - 0 example: 1 type: integer version: description: The version of the API function. example: 1 type: integer type: object description: HTTP Request was successful. summary: Return SSL certificate information tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n fetchcrtinfo \\\n user='username' \\\n id='example_com_bf638_f81af_1500191700_79e34f42c83f748bd49474ab9d66f7cd'\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/fetchcrtinfo?api.version=1&user=username&id=example_com_bf638_f81af_1500191700_79e34f42c83f748bd49474ab9d66f7cd x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '11.32' servers: - description: A server running WHM. url: https://{host}:{port}/json-api variables: host: default: whm-server.tld description: The hostname of a server running WHM. port: default: '2087' description: The WHM port. /fetchsslinfo: get: description: This function retrieves information about SSL certificates that you could install for a user. This function does **not** provide information about the currently installed certificates. operationId: SSL-fetchsslinfo parameters: - description: The certificate's text. in: query name: crtdata required: false schema: example: REDACTED_CERTIFICATE_EXAMPLE type: string - description: The domain's name. in: query name: domain required: false schema: example: example.com format: domain type: string responses: '200': content: application/json: schema: properties: data: properties: cab: description: The certificate's certificate authority (CA) bundle. example: REDACTED_CERTIFICATE_EXAMPLE type: string crt: description: The certificate's text. example: REDACTED_CERTIFICATE_EXAMPLE type: string crt_origin: description: The username of the certificate's creator. example: example format: username type: string domain: description: The domain name on the certificate. example: example.com format: domain type: string ip: description: The certificate's IP address. example: 192.168.0.20 format: ipv4 type: string key: description: The certificate's private key. example: REDACTED_PRIVATE_KEY_EXAMPLE type: string key_origin: description: The username of the key's creator. example: example format: username type: string searched_users: description: A list of users that the system searched to find certificate information. example: - root - example items: format: username type: string type: array user: description: The certificate's owner. example: example format: username type: string type: object metadata: properties: command: description: The method name called. example: fetchsslinfo type: string reason: description: The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds. example: OK type: string result: description: '* `1` — Success. * `0` — Failed. Check the `reason` field for more details.' enum: - 1 - 0 example: 1 type: integer version: description: The version of the API function. example: 1 type: integer type: object description: HTTP Request was successful. summary: Return cPanel account SSL certificate information tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n fetchsslinfo\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/fetchsslinfo?api.version=1 x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '11.32' servers: - description: A server running WHM. url: https://{host}:{port}/json-api variables: host: default: whm-server.tld description: The hostname of a server running WHM. port: default: '2087' description: The WHM port. /generatessl: get: description: This function generates a private key file, a certificate signing request (CSR), and a self-signed SSL certificate. operationId: SSL-generatessl parameters: - description: A comma-separated list of the certificate's domains. examples: multiple: summary: Generate an SSL certificate for multiple domains. value: domain=example1.com,example2.com,example3.com single: summary: Generate an SSL certificate for a single domain. value: example.com in: query name: domains required: true schema: format: domain type: string - description: 'The certificate''s country code. If you do not use this parameter, your CSR will **not** include this field.' in: query name: countryName required: false schema: example: US format: ISO-3166-1 (alpha-2) type: string - description: 'The certificate''s contact email address. If you do not use this parameter, your CSR will **not** include this field.' in: query name: emailAddress required: false schema: example: username@example.com format: email type: string - description: 'The size of the certificate''s key, in bits. If you do not use this parameter, your CSR will **not** include this field.' in: query name: keysize required: false schema: example: 2048 minimum: 1 type: integer - description: 'The certificate''s city or locality. If you do not use this parameter, your CSR will **not** include this field.' in: query name: localityName required: false schema: example: Houston type: string - description: The department of the organization that owns the certificate. in: query name: organizationalUnitName required: false schema: default: null example: Development type: - string - 'null' - description: 'The certificate''s organization. If you do not use this parameter, your CSR will **not** include this field.' in: query name: organizationName required: false schema: example: Example, L.L.C. type: string - description: The certificate's passphrase. in: query name: pass required: false schema: default: null example: 123456luggage type: - string - 'null' - description: 'Whether the function will skip certificate generation. * `1` — Skip certificate generate (do **not** generate a certificate). * `0` — Do **not** skip certificate generation (generate a certificate). **Note:** The function will still generate a CSR and key and save both to the user''s `SSLStorage` data store.' in: query name: skip_certificate required: false schema: default: 0 enum: - 1 - 0 example: 0 type: integer - description: 'The certificate''s state or province name. If you do not use this parameter, your CSR will **not** include this field.' in: query name: stateOrProvinceName required: false schema: example: Texas type: string responses: '200': content: application/json: schema: properties: data: properties: cert: description: The certificate's text. example: REDACTED_CERTIFICATE_EXAMPLE format: base64 certificate type: string cert_id: description: The certificate's ID. example: example_com_a2459_9d253_1405012775_521f3620ac92180d24a74813a921b23e type: string certfile: description: The absolute file path to the certificate's location. example: /var/cpanel/ssl/system/certs/example_com_e0054_da789_1405012513_401c27501f5e0dd8d1b1d9caa902a0c8.crt format: path type: string csr: description: The CSR's text. example: REDACTED_CERTIFICATE_EXAMPLE format: base64 certificate type: string csr_id: description: The CSR's ID. example: example_com_e0054_da789_96b6625681492b7c43844b6ec37764de type: string csrfile: description: The absolute file path to the CSR. example: /var/cpanel/ssl/system/csrs/example_com_a2459_9d253_d5edb563abb8dd426099bbb358c8f2bc.csr format: path type: string key: description: The private key's text. example: REDACTED_PRIVATE_KEY_EXAMPLE format: base64 certificate type: string key_id: description: The private key's ID. example: e0054_da789_101721a053024156a34e0df8a9c388d4 type: string keyfile: description: The absolute file path to the private key. example: /var/cpanel/ssl/system/keys/e0054_da789_101721a053024156a34e0df8a9c388d4.key format: path type: string sender: description: The username that generated the request. example: admin type: string sender_host: description: The host that generated the request. example: hostname.example.com format: domain type: string type: object metadata: properties: command: description: The method name called. example: generatessl type: string reason: description: The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds. example: Key, Certificate, and CSR generated OK type: string result: description: '* `1` — Success. * `0` — Failed. Check the `reason` field for more details.' enum: - 0 - 1 example: 1 type: integer version: description: The version of the API function. example: 1 type: integer type: object description: HTTP Request was successful. summary: Create self-signed SSL certificate tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n generatessl \\\n domains='example.com'\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/generatessl?api.version=1&domains=example.com x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '11.32' servers: - description: A server running WHM. url: https://{host}:{port}/json-api variables: host: default: whm-server.tld description: The hostname of a server running WHM. port: default: '2087' description: The WHM port. /get_autossl_check_schedule: get: description: This function returns the cron entry for the `autossl_check.pl` AutoSSL certificate check script. operationId: SSL-get_autossl_check_schedule parameters: [] responses: '200': content: application/json: schema: properties: data: properties: cron: description: A list of the time elements of a cron entry that schedules when the script will run. For more information about each element in a cron entry, read the [Cron Wikipedia article](https://en.wikipedia.org/wiki/Cron). items: example: 54 1 * * * type: string type: array next_time: description: The next time that the script will run. A time value, in [ISO-8601](http://www.iso.org/iso/home/standards/iso8601.htm) format. example: '2016-06-09T06:00:00.000Z' format: ISO-8601 Date Time type: string type: object metadata: properties: command: description: The method name called. example: get_autossl_check_schedule type: string reason: description: The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds. example: OK type: string result: description: '* `1` - Success. * `0` - Failed. Check the `reason` field for more details.' enum: - 0 - 1 example: 1 type: integer version: description: The version of the API function. example: 1 type: integer type: object description: HTTP Request was successful. summary: Return AutoSSL check script cron entry tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n get_autossl_check_schedule\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/get_autossl_check_schedule?api.version=1 x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '58' servers: - description: A server running WHM. url: https://{host}:{port}/json-api variables: host: default: whm-server.tld description: The hostname of a server running WHM. port: default: '2087' description: The WHM port. /get_autossl_log: get: description: This function returns the contents of an AutoSSL log file. operationId: SSL-get_autossl_log parameters: - description: When the system created the log file. in: query name: start_time required: true schema: example: '2016-06-09T14:25:37.000Z' format: ISO-8601 Date Time type: string responses: '200': content: application/json: schema: properties: data: properties: payload: description: Entries from an AutoSSL log. items: properties: contents: description: The contents of an entry. example: This system has AutoSSL set to use cPanel (powered by Sectigo). type: string indent: description: The level of indentation to display. example: 0 minimum: 0 type: integer partial: description: We do not currently use this return. enum: - 0 example: 0 type: integer pid: description: The AutoSSL process’s ID. example: 29189 minimum: 1 type: integer timestamp: description: When the system created the log file entry. example: '2016-06-09T14:25:37.000Z' format: ISO-8601 Date Time type: string type: description: 'The type of log file entry. * `out` (WHM''s _Manage AutoSSL_ interface represents this type as `info`.) * `warn` * `success` * `failure`' enum: - out - warn - success - failure example: out type: string type: object type: array type: object metadata: properties: command: description: The method name called. example: get_autossl_log type: string reason: description: The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds. example: OK type: string result: description: '* `1` - Success * `0` - Failed: Check the reason field for more details.' enum: - 0 - 1 example: 1 type: integer version: description: The version of the API function. example: 1 type: integer type: object description: HTTP Request was successful. summary: Return AutoSSL log file's contents tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n get_autossl_log \\\n start_time='2016-06-09T14:25:37Z'\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/get_autossl_log?api.version=1&start_time=2016-06-09T14%3a25%3a37Z x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '58' servers: - description: A server running WHM. url: https://{host}:{port}/json-api variables: host: default: whm-server.tld description: The hostname of a server running WHM. port: default: '2087' description: The WHM port. /get_autossl_logs_catalog: get: description: This function lists the AutoSSL feature's log files. operationId: SSL-get_autossl_logs_catalog parameters: [] responses: '200': content: application/json: schema: properties: data: properties: payload: description: An array of objects that contain information about an AutoSSL log file. items: properties: in_progress: description: 'Whether AutoSSL is in progress. * `1` — AutoSSL is in progress. * `0` — AutoSSL is **not** in progress.' enum: - 0 - 1 example: 1 type: integer provider: description: The AutoSSL provider's name. example: cPanel type: string start_time: description: When the system created the log file. example: '2016-06-09T14:25:37.000Z' format: ISO-8601 Date Time type: string username: description: 'The user that corresponds to the AutoSSL log entry. * The username of a cPanel user that the account owns. * `*` — All users.' example: username type: string type: object type: array type: object metadata: properties: command: description: The method name called. example: get_autossl_logs_catalog type: string reason: description: The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds. example: OK type: string result: description: '* `1` - Success. * `0` - Failed. Check the `reason` field for more details.' enum: - 0 - 1 example: 1 type: integer version: description: The version of the API function. example: 1 type: integer type: object description: HTTP Request was successful. summary: Return AutoSSL log files tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n get_autossl_logs_catalog\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/get_autossl_logs_catalog?api.version=1 x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '58' servers: - description: A server running WHM. url: https://{host}:{port}/json-api variables: host: default: whm-server.tld description: The hostname of a server running WHM. port: default: '2087' description: The WHM port. /get_autossl_metadata: get: description: This function retrieves values for the currently authenticated user's AutoSSL's metadata keys. operationId: SSL-get_autossl_metadata parameters: [] responses: '200': content: application/json: schema: properties: data: properties: payload: description: An object containing the user's AutoSSL metadata key values. properties: clobber_externally_signed: description: 'This option will allow AutoSSL to replace certificates that none of this systems AutoSSL modules issued. When you enable this option, AutoSSL will install certificates that replace users Certificate Authority (CA) issued certificates if they are invalid or expire within three days. * `1` - Replace the certificate. * `0` - Do **not** replace the certificate.' enum: - 0 - 1 example: 1 type: integer notify_autossl_expiry: description: 'This option will send a notification when an AutoSSL certificate expires. This occurs when AutoSSL cannot request a new certificate. **Note:** This can happen if all of a websites domains fail Domain Control Validation (DCV), or if the AutoSSL provider has not issued a certificate in response to a request. * `1` - Notify. * `0` - Do **not** notify.' enum: - 0 - 1 example: 1 type: integer notify_autossl_expiry_coverage: description: 'This option will send a notification if at least one currently-secured domain will lose coverage when the certificate renews. * `1` - Notify. * `0` - Do **not** notify.' enum: - 0 - 1 example: 1 type: integer notify_autossl_expiry_coverage_user: description: 'This option will send a notification if at least one of a user''s currently-secured domains will lose coverage when the certificate renews. * `1` - Notify. * `0` - Do **not** notify.' enum: - 0 - 1 example: 1 type: integer notify_autossl_expiry_user: description: 'This option will send a notification when a user''s AutoSSL certificate expires. This occurs when AutoSSL cannot request a new certificate for a user. * `1` - Notify. * `0` - Do **not** notify.' enum: - 0 - 1 example: 1 type: integer notify_autossl_renewal: description: 'This option will send a notification when AutoSSL successfully renews a certificate. * `1` - Notify. * `0` - Do **not** notify.' enum: - 0 - 1 example: 1 type: integer notify_autossl_renewal_coverage: description: 'This option will send a notification if a currently-secured domain fails DCV and the certificate has not reached its renewal period. * `1` - Notify. * `0` - Do **not** notify.' enum: - 0 - 1 example: 1 type: integer notify_autossl_renewal_coverage_reduced: description: 'This option will send a notification when AutoSSL has renewed a certificate and the new certificate lacks at least one domain that the previous certificate secured. * `1` - Notify. * `0` - Do **not** notify.' enum: - 0 - 1 example: 1 type: integer notify_autossl_renewal_coverage_reduced_user: description: 'This option will send a notification when AutoSSL has renewed a certificate for a user and the new certificate lacks at least one domain that the previous certificate secured. * `1` - Notify. * `0` - Do **not** notify.' enum: - 0 - 1 example: 1 type: integer notify_autossl_renewal_coverage_user: description: 'This option will send a notification if a currently-secured domain fails DCV and the certificate has not reached its renewal period. * `1` - Notify. * `0` - Do **not** notify.' type: integer notify_autossl_renewal_uncovered_domains: description: 'This option will send a notification when AutoSSL has renewed a certificate and the new certificate lacks one or more of the websites domains. * `1` - Notify. * `0` - Do **not** notify.' enum: - 0 - 1 example: 1 type: integer notify_autossl_renewal_uncovered_domains_user: description: 'This option will send a notification when AutoSSL has renewed a certificate for a user and the new certificate lacks one or more of the websites domains. * `1` - Notify. * `0` - Do **not** notify.' enum: - 0 - 1 example: 1 type: integer notify_autossl_renewal_user: description: 'This option will send a notification when AutoSSL successfully renews a certificate for a user. * `1` - Notify * `0` - Do **not** notify.' enum: - 0 - 1 example: 1 type: integer type: object type: object metadata: properties: command: description: The method name called. example: get_autossl_metadata type: string reason: description: 'The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.' example: OK type: string result: description: '* `1` - Success * `0` - Failed: Check the reason field for more details.' enum: - 0 - 1 example: 1 type: integer version: description: The version of the API function. example: 1 type: integer type: object description: HTTP Request was successful. summary: Return current user's AutoSSL metadata tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n get_autossl_metadata\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/get_autossl_metadata?api.version=1 x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '60' servers: - description: A server running WHM. url: https://{host}:{port}/json-api variables: host: default: whm-server.tld description: The hostname of a server running WHM. port: default: '2087' description: The WHM port. /get_autossl_problems_for_domain: get: description: This function returns a list of objects that contains the latest Domain Control Validation (DCV) problems for a specific domain. operationId: SSL-get_autossl_problems_for_domain parameters: - description: The domain for which to poll the DCV status. in: query name: domain required: true schema: example: example.com format: domain type: string responses: '200': content: application/json: schema: properties: data: properties: problems_by_domain: description: An array of objects that contains DCV problems for a domain. items: description: An object containing information about a DCV problem for a domain. properties: domain: description: The domain queried for problems. example: example.tld format: domain type: string log: description: The name of the directory containing the log files for this problem. This directory is located under `/var/cpanel/logs/autossl/`. example: '2017-08-19T13:41:04.000Z' format: ISO-8601 Date Time type: string problem: description: The problem the domain encountered during DCV. example: The domain does not resolve to any IPv4 addresses on the internet. type: string time: description: The time that the problem occurred. example: '2017-08-19T13:41:04.000Z' format: ISO-8601 Date Time type: string type: object type: array metadata: properties: command: description: The method name called. example: get_autossl_problems_for_domain type: string reason: description: The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds. example: OK type: string result: description: '* `1` - Success. * `0` - Failed. Check the `reason` field for more details.' enum: - 0 - 1 example: 1 type: integer version: description: The version of the API function. example: 1 type: integer type: object description: HTTP Request was successful. summary: Return domain DCV issues tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n get_autossl_problems_for_domain \\\n domain='example.com'\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/get_autossl_problems_for_domain?api.version=1&domain=example.com x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '68' servers: - description: A server running WHM. url: https://{host}:{port}/json-api variables: host: default: whm-server.tld description: The hostname of a server running WHM. port: default: '2087' description: The WHM port. /get_autossl_problems_for_user: get: description: This function returns the list of the latest Domain Control Validation (DCV) problems for a cPanel user. operationId: SSL-get_autossl_problems_for_user parameters: - description: The user for whom to poll the DCV status. in: query name: username required: true schema: example: username format: username type: string responses: '200': content: application/json: schema: properties: data: properties: problems_by_domain: description: An array of objects that contain information about DCV problems for each domain. items: properties: domain: description: The domain's name example: doesnotexist.example.com format: domain type: string log: description: The log folder of the last run in the `/var/cpanel/logs/autossl/` directory. example: '2017-09-07T03:51:01.000Z' format: ISO-8601 Date Time type: string problem: description: 'The human readable explanation of the DCV problem. **Note** The system does **not** localize this return.' example: doesnotexist.example.com does not resolve to any IPv4 addresses on the internet. type: string time: description: The last run time of the AutoSSL queue. example: '2017-08-12T21:02:56.000Z' format: ISO-8601 Date Time type: string type: object type: array type: object metadata: properties: command: description: The method name called. example: get_autossl_problems_for_user type: string reason: description: The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds. example: OK type: string result: description: '* `1` - Success. * `0` - Failed. Check the `reason` field for more details.' enum: - 0 - 1 example: 1 type: integer version: description: The version of the API function. example: 1 type: integer type: object description: HTTP Request was successful. summary: Return account DCV issues tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n get_autossl_problems_for_user \\\n username='username'\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/get_autossl_problems_for_user?api.version=1&username=username x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '68' servers: - description: A server running WHM. url: https://{host}:{port}/json-api variables: host: default: whm-server.tld description: The hostname of a server running WHM. port: default: '2087' description: The WHM port. /get_autossl_providers: get: description: This function lists available AutoSSL providers on the server. operationId: SSL-get_autossl_providers parameters: [] responses: '200': content: application/json: schema: properties: data: properties: payload: description: This array of objects contains information about available AutoSSL providers. example: - display_name: Sectigo enabled: 1 module_name: cPanel specs: AVERAGE_DELIVERY_TIME: 120 DCV_METHODS: - http - dns DELIVERY_METHOD: queue HTTP_DCV_MAX_REDIRECTS: 0 MAX_DOMAINS_PER_CERTIFICATE: 1000 RATE_LIMIT_CERTIFICATES_PER_REGISTERED_DOMAIN_PER_WEEK: 0 SUPPORTS_ANCESTOR_DCV: 1 SUPPORTS_WILDCARD: 0 VALIDITY_PERIOD: 7776000 - display_name: Let’s Encrypt™ enabled: 0 module_name: LetsEncrypt specs: AVERAGE_DELIVERY_TIME: 5 DCV_METHODS: - http - dns DELIVERY_METHOD: api HTTP_DCV_MAX_REDIRECTS: 10 MAX_DOMAINS_PER_CERTIFICATE: 100 RATE_LIMIT_CERTIFICATES_PER_REGISTERED_DOMAIN_PER_WEEK: 50 SUPPORTS_ANCESTOR_DCV: 0 SUPPORTS_WILDCARD: 1 VALIDITY_PERIOD: 7776000 x_account_id: https://acme-v01.api.letsencrypt.org/acme/reg/12345678 x_terms_of_service: https://letsencrypt.org/documents/LE-SA-v1.2-November-15-2017.pdf x_terms_of_service_accepted: 1 items: additionalProperties: description: Additional returns specific to the AutoSSL provider module. The name of the property will always start with `x_`. properties: display_name: description: The AutoSSL provider module's display name. example: Sectigo type: string enabled: description: 'Whether the AutoSSL provider is enabled. * `1` - The provider is enabled. * `0` - The provider is disabled.' enum: - 0 - 1 example: 1 type: integer module_name: description: The AutoSSL provider module's name. example: cPanel type: string specs: description: The provider's specifications. properties: AVERAGE_DELIVERY_TIME: description: The amount of time in seconds that the provider requires to issue a certificate. example: 120 type: integer DCV_METHODS: description: 'The methods that the provider uses to validate the domain. * `dns` - DNS Validation Method. * `http` - HTTP Validation Method.' items: enum: - dns - http example: http type: string type: array DELIVERY_METHOD: description: 'The method that the provider uses to issue the certificate. * `queue` - The provider delivers certificates through a download queue. * `api` - The provider delivers certificates through API calls.' enum: - queue - api example: queue type: string HTTP_DCV_MAX_REDIRECTS: description: The maximum number of redirections a domain can use and still pass an HTTP-based DCV. example: 10 type: integer MAX_DOMAINS_PER_CERTIFICATE: description: The number of unique domains each certificate can contain. example: 100 minimum: 1 type: integer RATE_LIMIT_CERTIFICATES_PER_REGISTERED_DOMAIN_PER_WEEK: description: The maximum number of certificates that the provider will allow per domain in a week. example: 50 type: integer SUPPORTS_ANCESTOR_DCV: description: 'Whether the successful Domain Control Validation (DCV) of a parent domain implies the success of a subdomain. * `1` - The provider supports DCV. * `0` - The provider does **not** support DCV."' enum: - 0 - 1 example: 1 type: integer SUPPORTS_WILDCARD: description: 'Whether the provider supports wildcard domains on an SSL certificate. * `1` - The provider supports wildcard domains. * `0` - The provider does **not** support wildcard domains.' enum: - 0 - 1 example: 1 type: integer VALIDITY_PERIOD: description: "The amount of time before the certificate expired, in seconds.\n\n**Note:**\n\n\n A valid integer." example: 7776000 type: integer type: object x_account_id: description: The user's account profile URL at the provider. example: https://acme-v01.api.letsencrypt.org/acme/reg/12345678 type: string x_terms_of_service: description: 'The URL of the provider''s current terms of service. **Note:** If the terms of service available at the `x_terms_of_service` location is newer than the `x_terms_of_service_accepted` location, the system administrator will need to accept the new terms of service.' example: https://letsencrypt.org/documents/LE-SA-v1.0.1-July-27-2015.pdf format: url type: string x_terms_of_service_accepted: description: 'Whether the AutoSSL provider is Enabled. * `1` - The AutoSSL provider is enabled. * `0` - The AutoSSL provider is **not** enabled.' enum: - 0 - 1 example: 1 type: integer type: object type: array type: object metadata: properties: command: description: The method name called. example: get_autossl_providers type: string reason: description: The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds. example: OK type: string result: description: '* `1` - Success. * `0` - Failed. Check the reason field for more details.' enum: - 0 - 1 example: 1 type: integer version: description: The version of the API function. example: 1 type: integer type: object description: HTTP Request was successful. summary: Return available AutoSSL providers tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n get_autossl_providers\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/get_autossl_providers?api.version=1 x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '58' servers: - description: A server running WHM. url: https://{host}:{port}/json-api variables: host: default: whm-server.tld description: The hostname of a server running WHM. port: default: '2087' description: The WHM port. /get_autossl_user_excluded_domains: get: description: This function lists an account's domains the system excludes from AutoSSL. operationId: SSL-get_autossl_user_excluded_domains parameters: - description: The cPanel user's account. in: query name: username required: true schema: example: example format: username type: string responses: '200': content: application/json: schema: properties: data: properties: payload: description: An array of objects that contain a list of domains excluded from AutoSSL. items: properties: excluded_domain: description: A list of domains excluded from AutoSSL. example: cpcalendars.example.com format: domain type: string type: object type: array type: object metadata: properties: command: description: The method name called. example: get_autossl_user_excluded_domains type: string reason: description: The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds. example: OK type: string result: description: '* `1` - Success. * `0` - Failed. Check the `reason` field for more details.' enum: - 0 - 1 example: 1 type: integer version: description: The version of the API function. example: 1 type: integer type: object description: HTTP Request was successful. summary: Return all AutoSSL-excluded domains tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n get_autossl_user_excluded_domains \\\n username='example'\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/get_autossl_user_excluded_domains?api.version=1&username=example x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '66' servers: - description: A server running WHM. url: https://{host}:{port}/json-api variables: host: default: whm-server.tld description: The hostname of a server running WHM. port: default: '2087' description: The WHM port. /get_best_ssldomain_for_service: get: description: This function retrieves the most appropriate SSL-encrypted domain to use to access a service. operationId: SSL-get_best_ssldomain_for_service parameters: - description: The service's name. in: query name: service required: true schema: example: whostmgr type: string responses: '200': content: application/json: schema: properties: data: properties: cert_match_method: description: 'The method that the system used to match the domain with the certificate. * `none` — No domain matches the certificate. * `exact` — The domain exactly matches the certificate. * `exact-wildcard` — The domain exactly matches the domain of a wildcard certificate. * `mail-wildcard` — The mail subdomain of the domain matches the domain of the wildcard certificate. * `www-wildcard` — The `www` subdomain of the domain matches the domain of the wildcard certificate. * `hostname-wildcard` — The hostname''s domain matches the domain of the wildcard certificate. * `hostname` — The hostname matches the domain of the certificate. * `localdomain_on_cert-mail-wildcard` — Any `mail` subdomain of any domain on the server matches the certificate. * `localdomain_on_cert-www-wildcard` — Any `www` subdomain of any domain on the server matches the certificate. * `localdomain_on_cert` — Any domain on the server matches the certificate.' enum: - none - exact - exact-wildcard - mail-wildcard - www-wildcard - hostname-wildcard - hostname - localdomain_on_cert-mail-wildcard - localdomain_on_cert-www-wildcard - localdomain_on_cert example: none type: string cert_valid_not_after: description: The expiration date of the certificate. example: 1457452989 format: unix_timestamp type: integer is_currently_valid: description: 'Whether the certificate is currently valid. * `1` — The certificate is valid. * `0` — The certificate is **not** valid. **Note:** If the certificate is valid, the following statements are true: * The certificate is **not** self-signed (the `is_self_signed` value is `0`). * The certificate matches the SSL domain (the `ssldomain_matches_cert` value is `1`). * The certificate is within its validity period (the `cert_valid_not_after` value is less than the current time and date).' enum: - 0 - 1 example: 0 type: integer is_self_signed: description: 'Whether the certificate is self-signed. * `1` — The certificate is self-signed. * `0` — The certificate is **not** self-signed. **Note:** For legacy reasons, if the `ssldomain_matches_cert` value is `0`, then the function will **always** return a value of `1` for the `is_self_signed return` return, regardless of whether the certificate is actually self-signed.' enum: - 0 - 1 example: 1 type: integer is_wild_card: description: 'Whether the service uses a wildcard certificate. * `1` — The service uses a wildcard certificate. * `0` — The service does **not** use a wildcard certificate.' enum: - 0 - 1 example: 0 type: integer ssldomain: description: The domain of the service's SSL certificate. example: hostname.example.com format: domain type: string ssldomain_matches_cert: description: 'Whether an SSL-encrypted domain matches the certificate. * `1` — Matches. * `0` — Does **not** match.' enum: - 0 - 1 example: 0 type: integer type: object metadata: properties: command: description: The method name called. example: get_best_ssldomain_for_service type: string reason: description: The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds. example: OK type: string result: description: '* `1` - Success * `0` - Failed: Check the reason field for more details.' enum: - 0 - 1 example: 1 type: integer version: description: The version of the API function. example: 1 type: integer type: object description: HTTP Request was successful. summary: Return SSL-encrypted domain for service access tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n get_best_ssldomain_for_service \\\n service='whostmgr'\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/get_best_ssldomain_for_service?api.version=1&service=whostmgr x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '56' servers: - description: A server running WHM. url: https://{host}:{port}/json-api variables: host: default: whm-server.tld description: The hostname of a server running WHM. port: default: '2087' description: The WHM port. /install_service_ssl_certificate: get: description: 'This function installs a new SSL certificate on a service. **Important:** You **must** restart the selected service after you install a new SSL certificate.' operationId: SSL-install_service_ssl_certificate parameters: - description: 'The certificate to install. **Note:** You **must** URI-encode this value.' in: query name: crt required: true schema: example: REDACTED_CERTIFICATE_EXAMPLE format: pem-certificate type: string - description: 'The certificate''s key. **Note:** You **must** URI-encode this value.' in: query name: key required: true schema: example: REDACTED_PRIVATE_KEY_EXAMPLE format: pem-private-key type: string - description: 'The service on which to install the SSL certificate. * `ftp` * `exim` * `dovecot` * `cpanel` **Important:** You **must** restart the selected service after you install a new SSL certificate.' in: query name: service required: true schema: enum: - ftp - exim - dovecot - cpanel example: cpanel type: string - description: 'The certificate''s Certificate Authority (CA) bundle. **Note:** You **must** URI-encode this value.' in: query name: cabundle required: false schema: default: '' example: REDACTED_CERTIFICATE_EXAMPLE format: pem-certificate type: string responses: '200': content: application/json: schema: properties: data: properties: certificate: description: The SSL certificate's contents. example: REDACTED_CERTIFICATE_EXAMPLE format: pem-certificate type: string certificate_info: description: An object containing the service's certificate information. properties: domains: description: A list of domains that correspond to the certificate. items: example: example.com format: domain type: string type: array ecdsa_curve_name: description: 'The ECDSA curve that the certificate''s key uses. * `prime256v1` * `secp384r1` * `null` — The certificate''s key is **not** an ECDSA key.' enum: - prime256v1 - secp384r1 example: null type: - string - 'null' ecdsa_public: description: 'The certificate''s key''s ECDSA compressed public point, in hexadecimal format. * `null` — The certificate''s key is **not** an ECDSA key.' example: null type: - string - 'null' is_self_signed: description: 'Whether the certificate is self-signed. * `1` — Self-signed. * `0` — **Not** self-signed.' enum: - 1 - 0 example: 1 type: integer issuer.commonName: description: The certificate's Common Name. example: example.com type: - string - 'null' issuer.organizationName: description: The certificate's Organization Name. example: Organization type: string issuer_text: description: The certificate's issuer information. example: 'localityName city emailaddress c.example@example.com stateOrProvinceName state countryName US commonName hostname organizationName cpanel' type: string key_algorithm: description: 'The certificate''s key''s algorithm. * `rsaEncryption` — RSA. * `id-ecPublicKey` — ECDSA.' enum: - rsaEncryption - id-ecPublicKey example: rsaEncryption type: string modulus: description: 'The certificate''s key''s modulus, in hexadecimal format. * `null` — The certificate''s key is **not** an RSA key.' example: a673c3b17344664b35f8791f562d3aea6bf4d8faa3ae3fc0a519380fd453964a36677c34d48677ecb7f5ed035df026f5f0f8fbfe21745e52daf1f3b9e58c73f0baefdb709320e2202e7d05250b051a59b30ff1fef22d83d7140c1c81cea314a0890ce8d2226799872181c58a74016c7aaa2cff5ac72b575cecde8f304aa572a2ea03d8b173ab76c6e8cdb9dfd0da81e1119cefd4b8b4dbfbe0e46c7f1ee2fe8b5fd5504e58ccbc0d13b4fa41ecc9ebd0dabe1d1fec5c724f748167e7c0553e997f9b77eb36abce70973f06df151748d41b758de3efd7afa6f2464a1547f5ff158469d96e248be464df9eda0e7ce854a89332a2c1278b17c425368a9604f454db type: - string - 'null' modulus_length: description: 'The certificate''s key''s modulus size, in bits. * `null` — The certificate''s key is **not** an RSA key.' example: 2048 type: integer not_after: description: The date the certificate expires. example: 1601467200 format: unix_timestamp type: integer not_before: description: The certificate's validation date. example: 1601467200 format: unix_timestamp type: integer signature_algorithm: description: The certificate's OID hash algorithm signature. example: sha256WithRSAEncryption type: string validation_type: description: 'The certificate''s validation type. * `ev` — Extended Validation. * `ov` — Organization Validation. * `dv` — Domain Validation. * `null` — The certificate does not match one of the system’s recognized validation types.' enum: - ev - ov - dv example: dv type: - string - 'null' type: object service: description: 'The service that the certificate corresponds to. * `ftp` * `exim` * `dovecot` * `cpanel`' enum: - ftp - exim - dovecot - cpanel example: cpanel type: string service_description: description: The service's description. example: Calendar, cPanel, WebDisk, Webmail, and WHM Services type: string type: object metadata: properties: command: description: The method name called. example: install_service_ssl_certificate type: string reason: description: The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds. example: OK type: string result: description: '* `1` — Success. * `0` — Failed. Check the `reason` field for more details.' enum: - 1 - 0 example: 1 type: integer version: description: The version of the API function. example: 1 type: integer type: object description: HTTP Request was successful. summary: Install SSL certificate for service tags: - SSL x-codeSamples: - label: CLI lang: Shell source: REDACTED_PRIVATE_KEY_EXAMPLE - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/install_service_ssl_certificate?api.version=1&service=cpanel&crt=-----BEGIN%20CERTIFICATE-----%0aMIIE3f4g5h7j73f235gy54hvcNAQELBQAwgYYxEDAOBgNVBAcMB2hvd097342boi0w389w0BCQEWEmMubGFycnl8293rhqurpg9qfgm5ldDEOMAwGA1UECAwFdGV4YXMxCzAJBgNVBAYTAlVTMSEwHwYDVQQDDBhiaW5hcnlhZ2Fpbi5jcGFuZWwubmluamExDzANBgNVBAoMBmNwYW5lbDAeFw0yMDA1MTgxODQ3NTFaFw0yMTA1MTgxODQ3NTFaMIGGMRAwDgYDVQQHDAdob3VzdG9uMSEwHwYJKoZIhvcNAQkBFhJjLmxhcnJ5QGNwYW5lbC5uZXQxDjAMBgNVBAgMBXRleGFzMQswCQYDVQQGEwJVUzEhMB8GA1UEAwwYYmluYXJ5YWdhaW4uY3BhbmVsLm5pbmphMQ8wDQYDVQQKDAZjcGFuZWwwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC3i1fOlIUoURJf4BkMgoVvCeq5GZjzuCl6WXzz5WsADYUl84UzgXJIWtwBoTc2l32zyeWkIAkM%2feNR12YMb0kXbgihbZtEsH0XimqcXmtiicoM3tjBi6u0cDEFr8TMdI396oArnnTc0CASfdXUGGtReZ6vOwxXOPPK5nYCvyFqBl1n0pQ2AV%2fCo9%2fWwhOCvV%2fBm9aTzueZrbYB%2f9uW31LOpjs%2b0s1QNGHv6PTvH8HZFW%2f7Z9M3gSwUxfOOOQHEiiHRWfb%2fUqcTZZxjZhfY%2fIN6%2fSOsc3Z2t2KmQ5XI6ijCrjjJeaZSQYsge8LpHskr8G3WeTV9M9%2b1YnI7GRqs3%2bGdAgMBAAGjggEsMIIBKDAdBgNVHQ4EFgQUYWWThQj2tRL5PNkdPhUJdqEIcrswCQYDVR0TBAIwADCBtwYDVR0jBIGvMIGsgBRhZZOFCPa1Evk82R0%2bFQl2oQhyu6GBjKSBiTCBhjEQMA4GA1UEBwwHaG91c3RvbjEhMB8GCSqGSIb3DQEJARYSYy5sYXJyeUBjcGFuZWwubmV0MQ4wDAYDVQQIDAV0ZXhhczELMAkGA1UEBhMCVVMxITAfBgNVBAMMGGJpbmFyeWFnYWluLmNwYW5lbC5uaW5qYTEPMA0GA1UECgwGY3BhbmVsggUCGG94JTAdBgNVHSUEFjAUBggrBgEFBQcDAQYIKwYBBQUHAwIwIwYDVR0RBBwwGoIYYmluYXJ5YWdhaW4uY3BhbmVsLm5pbmphMA0GCSqGSIb3DQEBCwUAA4IBAQBhKmds%2bXDTycHc2bsSH%2bzDkWIw58%2bJ26Re9Q9VnUcrSKtV3mmtW88r8FuEHEZdAOzFPTJ3Tdd1fha15wuS5dzOV%2bbCRrDTvJmD4vRPkQ5TSdyJgpIjpjwiOP1%2bZwaF7xZ%2bFLMTcEl8SXM%2blkoKEUQpHFKyQ0zGIaLCVt0QyXx16lesPMgPeb%2fKRXJPy7ZrUtyF0z0LgvOSDGNsGt4rD8FVgtdHRlMJf%2fXIoFeV5Zk%2brHNoCXIQXh4nBzM8X2r3IrQ1Qh0Z3njN2Ld8ZUlxsWctlLzvzmjARzIzvbglO3wod5XoRLS%2bfU6oVyQ9yuQLGG6r6Y7iBYSHfAO8e0pLkp7G%0a-----END%20CERTIFICATE-----&key=-----BEGIN%20RSA%20PRIVATE%20KEY-----%0aMIIEpQIBAAKCAQEA4FIdZcIKVK5%2bPtdzVm4CN45BXG5wX7KZ1%2fdP84MGIwtwxkkX%0ahBqw7BawbHlexYXuarSnrHA8hm6RRxv%2ffRy%2bzOeg7y8v5CWG52m91GK7qSLxpruY%0agCJGJEK8fj6spbbLjxNd5XAmDwT80uMsq%2f3E9rGmg%2fELY9X9vn5WlErRfi2Qjsiq%0ax7AYUvcIkBHPOlRWzZgx2KjMjBU2U0w2RCUjgKgww%2f6xx2ccnTvn7HGvVjQMkh%2b1%0aUYCdGvT8fR2qJBKHZ5Cjdfc9N304qZCqYMhcrHX2gJqc%2b9zLtLk7PoEYXu17l6nU%0aO3C%2fIdzBXYWu%2bUoMzpZ5tc5jKRA3%2bI7ggKjJlwIDAQABAoIBAQDR4GI648qQolXh%0a6%2biws%2bqFGibTGU0wbET%2bSBjYx%2f0E6t5P1vEWm3Zu3WehhgkCm6WO1omOj9BBIs%2fw%0aDSUEZNGrmwf64VZYijfm6gs%2b3EWiINyhWCF9uRORN5NuNquHvDhGHCOc2EnzgYIe%0auYgBP0R6X4phJjS26u8mvMO6qSnKd4wRrOf9ZU73L1VTmhMItshVxH2tuhKurkMV%0ajWDAjWeJfycWe4JVgYxM4GA6g5kKi5nrkhpVEsklh1FJZn65U0aWXUpHAm2ihhKf%0aFq9FgC%2b8Xz8UAtf8JYbAW3D1E%2f0lRZuLt%2b5cosK8b2%2b9CIUNRjYMtyXlbI0RGwl9%0aFO%2f9sv05AoGBAP0jfp8qUqf4u4pkE1W2SzzbQ6oYKYHTMiORVHi2qysgrxAZFKGj%0afW7c7UTpxlCaqqDBRQA%2blZH16xVD3idwYvmw%2f9AKxSozxe3wKbQFRM%2bXYHc7la%2b2%0aTiQiJgjflEadSa57FNgBB7SpeEzaIfmGBYWJXkM%2b6wuaGUz5qZs%2fSFJNAoGBAOLb%0aOuh7CWTk5oISVBfqxnwFEpaMHT5vpzNBwUWUVMhrxNZP3OVSN%2b%2bqKxpJhCF%2fM2no%0aOdxX7CYkrGvHFTvV9WKpa0kYQGms%2bybyoMOYxJax8rV%2bZq9gg2QKwaakoJljaAlX%0a5yUuy32YhLxWodQhE7mlhAUyXIuNLVuYee0Y2ZVzAoGAaV6tBnQHlAPljOW7ZqJL%0aDzn2IIeOP4w6ArQsBVOETJ9%2bP6UxAVecjtlHqrfk5Qh8ng3VOxTSDb%2ff6yok%2fyW5%0aDVawJVlWWQrUCQc%2fVMActIy%2biuMym8G3JTNRwb%2fPaNVwJkD1nDRRkNI6UUM7gTJY%0aeg2EP1mhXWL3xSLnhsgAwsECgYEAqnm2xfeXsqM0%2bbAOU77RE2e4dTuryjybeDBE%0ariXupIIf9DElvYrQkCDfrSxrx8RP%2fZlOyd%2bkjXFnxMJhmYqKkW7hOZeo6ADe54DT%0aAMmvidMFog%2fv2ID9m9NdfP4f1cTW7JaLE%2b0bbDGOJf4wNDn7GbphAIq88v3PhRKL%0aJXpUIDMCgYEA2P7D%2foZu%2bdEPW8JhUsDDXY238ZDbQzWBi6n1uUnMJCnUABd%2fmvuV%0aILR%2fiSBHmt9UdH2YECwry58xFjhXwfTvPc155PiJddjENGFUqohjl0wh0VzLEyfF%0aVb6iVMIdrycD%2fO4U26I3Qco2lQYPoPgrBkAGJ5%2fGCjkTiL0JssoMXa4%3d%0a-----END%20RSA%20PRIVATE%20KEY----- x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '11.40' servers: - description: A server running WHM. url: https://{host}:{port}/json-api variables: host: default: whm-server.tld description: The hostname of a server running WHM. port: default: '2087' description: The WHM port. /installssl: get: description: This function installs an SSL certificate. operationId: SSL-installssl parameters: - description: 'The certificate''s text. **Note:** You **must** URI-encode this value.' in: query name: crt required: true schema: example: '-----BEGIN%20CERTIFICATE-----%0AMIIDNTCCAh2gAwIBAgIFAY0o0kwwDQYJKoZIhvcNAQELBQAwFjEUMBIGA1UEAwwL%0AZG9tYWluLnRlc3QwHhcNMTcxMDMxMTUyMjU1WhcNMTgxMDMxMTUyMjU1WjAWMRQw%0AEgYDVQQDDAtkb21haW4udGVzdDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoC%0AggEBALer6vzwFt%2BO6ooHcXpq%2Bi%2FOVVQEY3oWxrqH6mB%2FPssVSxwcf6bLjoO4so%2Fn%0Adrymhb9mqfkOqYVHwnQ%2Fh2uM%2BIw1NKKDfwOljWcgCS24NykbfQUlW%2FSNDTovdDGl%0AT1Aner090Qse%2B19ta8KS%2F3Akz37bkgqMkPO%2FiEOHlF%2FLbLvjfighkoGco51wc6d7%0AHCQwPWR%2BUenbQWzUwR4%2F4Pqw%2FYrxDAv8O%2FEnNfOGwnCnlnFq4a390VGriqMAngzI%0AlRMVDu4qJGW3dFNStVUm71%2B16ba%2FeIVBQGN2rbgie6Rb6VuHdsqSreea0tSLRxdd%0AFd7A0QMQRvtnqoUv6RZBhefr2t0CAwEAAaOBiTCBhjAdBgNVHQ4EFgQUeitnD4U4%0AMXtmLX53dTAZPENjovwwHwYDVR0jBBgwFoAUeitnD4U4MXtmLX53dTAZPENjovww%0ACQYDVR0TBAIwADA5BgNVHREEMjAwggtkb21haW4udGVzdIIQbWFpbC5kb21haW4u%0AdGVzdIIPd3d3LmRvbWFpbi50ZXN0MA0GCSqGSIb3DQEBCwUAA4IBAQAeD4Fc%2FBwM%0AfJEvlPO30%2FOp2JJxG92tbgsoY9CKTYoZy0IMHhwOrt%2FB36joYDrOhtiO6XsRw4Zm%0AAPT8ey9p61kUc6XWs5oU9aifKeAKzWCZV9wQphbY%2F0rQp1YPsVN9tBgiag754HPo%0AbNDhWOZSZDKnh82DikTD6iciTxeblrvcbFC4Z76JH31dvqmNMEAgZvPCpq86Ued5%0A52gKM0u2%2BrK%2FzIYjh%2FhooqN%2BTY%2BJQ667JzLzPNenzAYFsoIQgVj6%2FZoFqJA4nbxC%0Azv%2Fspqc0OQ2W9m5egRPDhngKt%2Bi9804N7FeilBL%2FcpEgUHhgzMBi1T9n%2BYBrc6bO%0AjNjvnEQRbqZY%0A-----END%20CERTIFICATE-----' type: string - description: The domain's name. in: query name: domain required: true schema: example: example.com format: domain type: string - description: 'The certificate''s key. **Note:** You **must** URI-encode this value.' in: query name: key required: true schema: example: '-----BEGIN%20RSA%20PRIVATE%20KEY-----%0AMIIEpAIBAAKCAQEA4AVM6J4Qg3DIFWr/eJ5GRmIATYsJIepKbrDy70sq+udcO8R8xxak0oMZ/9mUdpjSNK/fLVTuCO0kxTfQ9VUWJllX7ThD6Zh9ZvlC/nf/OEZLm3ZbnBgu8rbC8E9wuDOkKbJLnINgdhtowIydLK2MJ++q62bFV89jkHWTMcKyyqHENo3hc+lkpd9vnp8rZTinaVb7nX26uQqAFZYRo+WU0G/NPsq40QVSMoqPxyEz4qXo0hvuIlCXmzFZq/6fCVPEKPLhQgMmpdBkMz4dVOazREfqXdjMD2+QXSNiA1AwWr8l0r4rtzlxEYDJIR41yXp0xMl3KoolxMyvLBqZy32niQIDAQABAoIBAQCmbGmhWmPsMeoCt1WJFxQgD4goE0U6k+Kt7vjbOt14Pk6v/B2yjaju1wSGpO59WLS4/XrwI2se6IXrmba7u3VUEgWXLriNHoLy7/SMNTs+ZEKhAMG36eNe3tVdT7busTag31r6sEMGGwCsIwpU+azosk0oylWLEX/m/uHWEs1eaIEWWWtgHB+KZrrP7Rr9RYfVQ144DxmOxS3Ca9+mST62WqAVPR6POWGEfZqnZl/ePWZPcQYbFrhwnnefNoYBl/bnLZBo8rbNWxAqOEOuKfkrBzglKG/39WKPw8rj4JIVzY0yOuFCW6xCDWRkOrhU8Ol/3FvwDa3uJpkpmgPr4TgxAoGBAPGPLmxSuOYR97mDAXxrs037F2GCbqWvI6m7/ezWe9yn+bMpjSIWfsgtq4FsyqzPueEkDdQWi3xh6nu2WI/1Tl875opGAqEIJMqss/u11tnva5wzu1cCL6H85A5+HMOBvP3sm6CObKcVw92h7kxynVIUJJWhjfeZMN8gBFFpKIVFAoGBAO1ptXBmXLC/YKKvtHI3M16/ZopvM8ZqU2HcAHaw214Refw9JJ/e3/xTNfSerVTyCAQO1AdWTzJKBN8jmSYv1Mk1D3RpQPNR7wVzi46KR081AU41uMpqIGVOwHtyVnW/ZfLrc1DLIK8Cx8aHfoxffwzoMO5SEQSooeZfOLhsfDN1AoGBAKQTUEINsj+75psgbAr6ELGgItJ9yPBLVRr+cUzEpx9LDWVvjMihpP4NX1gq8EOPWT+ewLHVmmsjCyV6xw8JXXF8e2xif3in0m3D/wCzE7u2T06rKM3B017hKnrZmGoHnrqPU2osM4sOUpshWX6dv1Q4EF1+fbK3YCW+VpCBsB9NAoGAQo+uhNLODee56iKkzpjXWCsFTq6ar3hD5F3P63buKdNwhd2GlSPhXFbf+7M5GWW6BZk6rMvv7EOAVice2uvyFm8/4/1WbmF8R+T7LX1rPLO5p/m701QpvP11TabiwqRkqtSEQhSRF0AKTojSW/yyHCZFAawUhV/Z9EKiHmKb97kCgYAyzmFc2it0HqnsOnRybop603nqMtWGTQO4cxa93HUDpYajuK2K3DfrxUj6lG3z/oKJGGE2JqgZ6LBAhNJtJWJu2ox3pKGE63QjLJnVwb8y1NFYpe/crbLePuBwIR0L7drXxfv7O5btY7h6QI2d1/UIAQPAWbxLoTM+ndQ/uPEdfA%3D%3D-----END%20RSA%20PRIVATE%20KEY-----' type: string - description: 'The certificate''s certificate authority (CA) bundle. If you do not use this parameter, the system automatically determines the appropriate CA bundle file to use. **Note:** You **must** URI-encode this value.' in: query name: cab required: false schema: example: '-----BEGIN%20CERTIFICATE-----%0AMIIDNTCCAh2gAwIBAgIFAY0o0kwwDQYJKoZIhvcNAQELBQAwFjEUMBIGA1UEAwwL%0AZG9tYWluLnRlc3QwHhcNMTcxMDMxMTUyMjU1WhcNMTgxMDMxMTUyMjU1WjAWMRQw%0AEgYDVQQDDAtkb21haW4udGVzdDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoC%0AggEBALer6vzwFt%2BO6ooHcXpq%2Bi%2FOVVQEY3oWxrqH6mB%2FPssVSxwcf6bLjoO4so%2Fn%0Adrymhb9mqfkOqYVHwnQ%2Fh2uM%2BIw1NKKDfwOljWcgCS24NykbfQUlW%2FSNDTovdDGl%0AT1Aner090Qse%2B19ta8KS%2F3Akz37bkgqMkPO%2FiEOHlF%2FLbLvjfighkoGco51wc6d7%0AHCQwPWR%2BUenbQWzUwR4%2F4Pqw%2FYrxDAv8O%2FEnNfOGwnCnlnFq4a390VGriqMAngzI%0AlRMVDu4qJGW3dFNStVUm71%2B16ba%2FeIVBQGN2rbgie6Rb6VuHdsqSreea0tSLRxdd%0AFd7A0QMQRvtnqoUv6RZBhefr2t0CAwEAAaOBiTCBhjAdBgNVHQ4EFgQUeitnD4U4%0AMXtmLX53dTAZPENjovwwHwYDVR0jBBgwFoAUeitnD4U4MXtmLX53dTAZPENjovww%0ACQYDVR0TBAIwADA5BgNVHREEMjAwggtkb21haW4udGVzdIIQbWFpbC5kb21haW4u%0AdGVzdIIPd3d3LmRvbWFpbi50ZXN0MA0GCSqGSIb3DQEBCwUAA4IBAQAeD4Fc%2FBwM%0AfJEvlPO30%2FOp2JJxG92tbgsoY9CKTYoZy0IMHhwOrt%2FB36joYDrOhtiO6XsRw4Zm%0AAPT8ey9p61kUc6XWs5oU9aifKeAKzWCZV9wQphbY%2F0rQp1YPsVN9tBgiag754HPo%0AbNDhWOZSZDKnh82DikTD6iciTxeblrvcbFC4Z76JH31dvqmNMEAgZvPCpq86Ued5%0A52gKM0u2%2BrK%2FzIYjh%2FhooqN%2BTY%2BJQ667JzLzPNenzAYFsoIQgVj6%2FZoFqJA4nbxC%0Azv%2Fspqc0OQ2W9m5egRPDhngKt%2Bi9804N7FeilBL%2FcpEgUHhgzMBi1T9n%2BYBrc6bO%0AjNjvnEQRbqZY%0A-----END%20CERTIFICATE-----' type: string - description: 'The IP address of the certificate''s domain. This parameter defaults to the domain''s local IP address.' in: query name: ip required: false schema: example: 192.168.0.20 format: ipv4 type: string responses: '200': content: application/json: schema: properties: data: properties: action: description: The action for the function to execute. enum: - install example: install type: string aliases: description: A list of domain aliases on the account. example: - mail.example.com - subdomain.example.com items: format: domain type: string type: array domain: description: The domain on which the function installed the SSL certificate. example: example.com format: domain type: string extra_certificate_domains: description: A list of domains that possess additional SSL certificates. example: - mail.example.com - subdomain.example.com items: format: domain type: string type: array html: description: The function's raw HTML output. example: Certificate verification passed

The Certificate for the domain example.com was installed on the IP 192.168.0.20.
Finished SSL Install Process for example.com (www.example.com). type: string ip: description: The domain's IP address. example: 192.168.0.20 format: ipv4 type: string message: description: A message of success or a reason for failure. example: The SSL certificate is now installed onto the domain "example.com" using the IP address "192.168.0.20". Apache is restarting in the background. type: string servername: description: The server's hostname. example: example.com format: hostname type: string status: description: 'Whether the function was successful. * `1` — Success. * `0` — Failure.' enum: - 1 - 0 example: 1 type: integer statusmsg: description: A message of success or a reason for failure. example: The SSL certificate is now installed onto the domain "example.com" using the IP address "192.168.0.20". Apache is restarting in the background. type: string user: description: The username for the account on which the function installed the SSL certificate. example: username format: username type: string warning_domains: description: A list of domains associated with the main domain on which the function did **not** install the SSL certificate. items: example: subdomain.example.com format: domain type: string type: array working_domains: description: An list of domains on which the function installed the SSL certificates. example: - example.com - mail.example.com items: format: domain type: string type: array type: object metadata: properties: command: description: The method name called. example: installssl type: string output: description: The function's raw HTML output. example:
The SSL certificate is now installed onto the domain “example.com“ using the IP address“192.168 .0 .20“. < br / > Apache is restarting in the background. type: string reason: description: The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds. example: The SSL certificate is now installed onto the domain “example.com“ using the IP address “192.168.0.20“.Apache is restarting in the background. type: string result: description: '* `1` — Success. * `0` — Failed. Check the `reason` field for more details.' enum: - 1 - 0 example: 1 type: integer version: description: The version of the API function. example: 1 type: integer type: object description: HTTP Request was successful. summary: Install SSL certificate tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n installssl \\\n domain='example.com' \\\n crt='-----BEGIN%20CERTIFICATE-----%0AMIIDNTCCAh2gAwIBAgIFAY0o0kwwDQYJKoZIhvcNAQELBQAwFjEUMBIGA1UEAwwL%0AZG9tYWluLnRlc3QwHhcNMTcxMDMxMTUyMjU1WhcNMTgxMDMxMTUyMjU1WjAWMRQw%0AEgYDVQQDDAtkb21haW4udGVzdDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoC%0AggEBALer6vzwFt%2BO6ooHcXpq%2Bi%2FOVVQEY3oWxrqH6mB%2FPssVSxwcf6bLjoO4so%2Fn%0Adrymhb9mqfkOqYVHwnQ%2Fh2uM%2BIw1NKKDfwOljWcgCS24NykbfQUlW%2FSNDTovdDGl%0AT1Aner090Qse%2B19ta8KS%2F3Akz37bkgqMkPO%2FiEOHlF%2FLbLvjfighkoGco51wc6d7%0AHCQwPWR%2BUenbQWzUwR4%2F4Pqw%2FYrxDAv8O%2FEnNfOGwnCnlnFq4a390VGriqMAngzI%0AlRMVDu4qJGW3dFNStVUm71%2B16ba%2FeIVBQGN2rbgie6Rb6VuHdsqSreea0tSLRxdd%0AFd7A0QMQRvtnqoUv6RZBhefr2t0CAwEAAaOBiTCBhjAdBgNVHQ4EFgQUeitnD4U4%0AMXtmLX53dTAZPENjovwwHwYDVR0jBBgwFoAUeitnD4U4MXtmLX53dTAZPENjovww%0ACQYDVR0TBAIwADA5BgNVHREEMjAwggtkb21haW4udGVzdIIQbWFpbC5kb21haW4u%0AdGVzdIIPd3d3LmRvbWFpbi50ZXN0MA0GCSqGSIb3DQEBCwUAA4IBAQAeD4Fc%2FBwM%0AfJEvlPO30%2FOp2JJxG92tbgsoY9CKTYoZy0IMHhwOrt%2FB36joYDrOhtiO6XsRw4Zm%0AAPT8ey9p61kUc6XWs5oU9aifKeAKzWCZV9wQphbY%2F0rQp1YPsVN9tBgiag754HPo%0AbNDhWOZSZDKnh82DikTD6iciTxeblrvcbFC4Z76JH31dvqmNMEAgZvPCpq86Ued5%0A52gKM0u2%2BrK%2FzIYjh%2FhooqN%2BTY%2BJQ667JzLzPNenzAYFsoIQgVj6%2FZoFqJA4nbxC%0Azv%2Fspqc0OQ2W9m5egRPDhngKt%2Bi9804N7FeilBL%2FcpEgUHhgzMBi1T9n%2BYBrc6bO%0AjNjvnEQRbqZY%0A-----END%20CERTIFICATE-----' \\\n key='-----BEGIN%20RSA%20PRIVATE%20KEY-----%0AMIIEpAIBAAKCAQEA4AVM6J4Qg3DIFWr/eJ5GRmIATYsJIepKbrDy70sq+udcO8R8xxak0oMZ/9mUdpjSNK/fLVTuCO0kxTfQ9VUWJllX7ThD6Zh9ZvlC/nf/OEZLm3ZbnBgu8rbC8E9wuDOkKbJLnINgdhtowIydLK2MJ++q62bFV89jkHWTMcKyyqHENo3hc+lkpd9vnp8rZTinaVb7nX26uQqAFZYRo+WU0G/NPsq40QVSMoqPxyEz4qXo0hvuIlCXmzFZq/6fCVPEKPLhQgMmpdBkMz4dVOazREfqXdjMD2+QXSNiA1AwWr8l0r4rtzlxEYDJIR41yXp0xMl3KoolxMyvLBqZy32niQIDAQABAoIBAQCmbGmhWmPsMeoCt1WJFxQgD4goE0U6k+Kt7vjbOt14Pk6v/B2yjaju1wSGpO59WLS4/XrwI2se6IXrmba7u3VUEgWXLriNHoLy7/SMNTs+ZEKhAMG36eNe3tVdT7busTag31r6sEMGGwCsIwpU+azosk0oylWLEX/m/uHWEs1eaIEWWWtgHB+KZrrP7Rr9RYfVQ144DxmOxS3Ca9+mST62WqAVPR6POWGEfZqnZl/ePWZPcQYbFrhwnnefNoYBl/bnLZBo8rbNWxAqOEOuKfkrBzglKG/39WKPw8rj4JIVzY0yOuFCW6xCDWRkOrhU8Ol/3FvwDa3uJpkpmgPr4TgxAoGBAPGPLmxSuOYR97mDAXxrs037F2GCbqWvI6m7/ezWe9yn+bMpjSIWfsgtq4FsyqzPueEkDdQWi3xh6nu2WI/1Tl875opGAqEIJMqss/u11tnva5wzu1cCL6H85A5+HMOBvP3sm6CObKcVw92h7kxynVIUJJWhjfeZMN8gBFFpKIVFAoGBAO1ptXBmXLC/YKKvtHI3M16/ZopvM8ZqU2HcAHaw214Refw9JJ/e3/xTNfSerVTyCAQO1AdWTzJKBN8jmSYv1Mk1D3RpQPNR7wVzi46KR081AU41uMpqIGVOwHtyVnW/ZfLrc1DLIK8Cx8aHfoxffwzoMO5SEQSooeZfOLhsfDN1AoGBAKQTUEINsj+75psgbAr6ELGgItJ9yPBLVRr+cUzEpx9LDWVvjMihpP4NX1gq8EOPWT+ewLHVmmsjCyV6xw8JXXF8e2xif3in0m3D/wCzE7u2T06rKM3B017hKnrZmGoHnrqPU2osM4sOUpshWX6dv1Q4EF1+fbK3YCW+VpCBsB9NAoGAQo+uhNLODee56iKkzpjXWCsFTq6ar3hD5F3P63buKdNwhd2GlSPhXFbf+7M5GWW6BZk6rMvv7EOAVice2uvyFm8/4/1WbmF8R+T7LX1rPLO5p/m701QpvP11TabiwqRkqtSEQhSRF0AKTojSW/yyHCZFAawUhV/Z9EKiHmKb97kCgYAyzmFc2it0HqnsOnRybop603nqMtWGTQO4cxa93HUDpYajuK2K3DfrxUj6lG3z/oKJGGE2JqgZ6LBAhNJtJWJu2ox3pKGE63QjLJnVwb8y1NFYpe/crbLePuBwIR0L7drXxfv7O5btY7h6QI2d1/UIAQPAWbxLoTM+ndQ/uPEdfA%3D%3D-----END%20RSA%20PRIVATE%20KEY-----'\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/installssl?api.version=1&domain=example.com&crt=-----BEGIN%2520CERTIFICATE-----%250AMIIDNTCCAh2gAwIBAgIFAY0o0kwwDQYJKoZIhvcNAQELBQAwFjEUMBIGA1UEAwwL%250AZG9tYWluLnRlc3QwHhcNMTcxMDMxMTUyMjU1WhcNMTgxMDMxMTUyMjU1WjAWMRQw%250AEgYDVQQDDAtkb21haW4udGVzdDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoC%250AggEBALer6vzwFt%252BO6ooHcXpq%252Bi%252FOVVQEY3oWxrqH6mB%252FPssVSxwcf6bLjoO4so%252Fn%250Adrymhb9mqfkOqYVHwnQ%252Fh2uM%252BIw1NKKDfwOljWcgCS24NykbfQUlW%252FSNDTovdDGl%250AT1Aner090Qse%252B19ta8KS%252F3Akz37bkgqMkPO%252FiEOHlF%252FLbLvjfighkoGco51wc6d7%250AHCQwPWR%252BUenbQWzUwR4%252F4Pqw%252FYrxDAv8O%252FEnNfOGwnCnlnFq4a390VGriqMAngzI%250AlRMVDu4qJGW3dFNStVUm71%252B16ba%252FeIVBQGN2rbgie6Rb6VuHdsqSreea0tSLRxdd%250AFd7A0QMQRvtnqoUv6RZBhefr2t0CAwEAAaOBiTCBhjAdBgNVHQ4EFgQUeitnD4U4%250AMXtmLX53dTAZPENjovwwHwYDVR0jBBgwFoAUeitnD4U4MXtmLX53dTAZPENjovww%250ACQYDVR0TBAIwADA5BgNVHREEMjAwggtkb21haW4udGVzdIIQbWFpbC5kb21haW4u%250AdGVzdIIPd3d3LmRvbWFpbi50ZXN0MA0GCSqGSIb3DQEBCwUAA4IBAQAeD4Fc%252FBwM%250AfJEvlPO30%252FOp2JJxG92tbgsoY9CKTYoZy0IMHhwOrt%252FB36joYDrOhtiO6XsRw4Zm%250AAPT8ey9p61kUc6XWs5oU9aifKeAKzWCZV9wQphbY%252F0rQp1YPsVN9tBgiag754HPo%250AbNDhWOZSZDKnh82DikTD6iciTxeblrvcbFC4Z76JH31dvqmNMEAgZvPCpq86Ued5%250A52gKM0u2%252BrK%252FzIYjh%252FhooqN%252BTY%252BJQ667JzLzPNenzAYFsoIQgVj6%252FZoFqJA4nbxC%250Azv%252Fspqc0OQ2W9m5egRPDhngKt%252Bi9804N7FeilBL%252FcpEgUHhgzMBi1T9n%252BYBrc6bO%250AjNjvnEQRbqZY%250A-----END%2520CERTIFICATE-----&key=-----BEGIN%2520RSA%2520PRIVATE%2520KEY-----%250AMIIEpAIBAAKCAQEA4AVM6J4Qg3DIFWr%2feJ5GRmIATYsJIepKbrDy70sq%2budcO8R8xxak0oMZ%2f9mUdpjSNK%2ffLVTuCO0kxTfQ9VUWJllX7ThD6Zh9ZvlC%2fnf%2fOEZLm3ZbnBgu8rbC8E9wuDOkKbJLnINgdhtowIydLK2MJ%2b%2bq62bFV89jkHWTMcKyyqHENo3hc%2blkpd9vnp8rZTinaVb7nX26uQqAFZYRo%2bWU0G%2fNPsq40QVSMoqPxyEz4qXo0hvuIlCXmzFZq%2f6fCVPEKPLhQgMmpdBkMz4dVOazREfqXdjMD2%2bQXSNiA1AwWr8l0r4rtzlxEYDJIR41yXp0xMl3KoolxMyvLBqZy32niQIDAQABAoIBAQCmbGmhWmPsMeoCt1WJFxQgD4goE0U6k%2bKt7vjbOt14Pk6v%2fB2yjaju1wSGpO59WLS4%2fXrwI2se6IXrmba7u3VUEgWXLriNHoLy7%2fSMNTs%2bZEKhAMG36eNe3tVdT7busTag31r6sEMGGwCsIwpU%2bazosk0oylWLEX%2fm%2fuHWEs1eaIEWWWtgHB%2bKZrrP7Rr9RYfVQ144DxmOxS3Ca9%2bmST62WqAVPR6POWGEfZqnZl%2fePWZPcQYbFrhwnnefNoYBl%2fbnLZBo8rbNWxAqOEOuKfkrBzglKG%2f39WKPw8rj4JIVzY0yOuFCW6xCDWRkOrhU8Ol%2f3FvwDa3uJpkpmgPr4TgxAoGBAPGPLmxSuOYR97mDAXxrs037F2GCbqWvI6m7%2fezWe9yn%2bbMpjSIWfsgtq4FsyqzPueEkDdQWi3xh6nu2WI%2f1Tl875opGAqEIJMqss%2fu11tnva5wzu1cCL6H85A5%2bHMOBvP3sm6CObKcVw92h7kxynVIUJJWhjfeZMN8gBFFpKIVFAoGBAO1ptXBmXLC%2fYKKvtHI3M16%2fZopvM8ZqU2HcAHaw214Refw9JJ%2fe3%2fxTNfSerVTyCAQO1AdWTzJKBN8jmSYv1Mk1D3RpQPNR7wVzi46KR081AU41uMpqIGVOwHtyVnW%2fZfLrc1DLIK8Cx8aHfoxffwzoMO5SEQSooeZfOLhsfDN1AoGBAKQTUEINsj%2b75psgbAr6ELGgItJ9yPBLVRr%2bcUzEpx9LDWVvjMihpP4NX1gq8EOPWT%2bewLHVmmsjCyV6xw8JXXF8e2xif3in0m3D%2fwCzE7u2T06rKM3B017hKnrZmGoHnrqPU2osM4sOUpshWX6dv1Q4EF1%2bfbK3YCW%2bVpCBsB9NAoGAQo%2buhNLODee56iKkzpjXWCsFTq6ar3hD5F3P63buKdNwhd2GlSPhXFbf%2b7M5GWW6BZk6rMvv7EOAVice2uvyFm8%2f4%2f1WbmF8R%2bT7LX1rPLO5p%2fm701QpvP11TabiwqRkqtSEQhSRF0AKTojSW%2fyyHCZFAawUhV%2fZ9EKiHmKb97kCgYAyzmFc2it0HqnsOnRybop603nqMtWGTQO4cxa93HUDpYajuK2K3DfrxUj6lG3z%2foKJGGE2JqgZ6LBAhNJtJWJu2ox3pKGE63QjLJnVwb8y1NFYpe%2fcrbLePuBwIR0L7drXxfv7O5btY7h6QI2d1%2fUIAQPAWbxLoTM%2bndQ%2fuPEdfA%253D%253D-----END%2520RSA%2520PRIVATE%2520KEY----- x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '11.32' servers: - description: A server running WHM. url: https://{host}:{port}/json-api variables: host: default: whm-server.tld description: The hostname of a server running WHM. port: default: '2087' description: The WHM port. /listcrts: get: description: This function lists the server's domains with installed SSL certificates. operationId: SSL-listcrts parameters: - description: 'Whether to limit the results to certificates registered with a certificate authority (CA). * `1` — Registered certificates **only**. * `0` — All certificates.' in: query name: registered required: false schema: default: 0 enum: - 1 - 0 example: 1 type: integer - description: 'The cPanel username. If you do **not** use this parameter, the function returns certificates for **all** accounts on the server.' in: query name: user required: false schema: example: username format: username type: string responses: '200': content: application/json: schema: properties: data: properties: crt: description: Information about the certificate. items: properties: domain: description: The certificate's primary domain. example: example.com format: domain type: string domain_owners: description: A list of the owners of the domain or domains that the certificate covers. example: - username items: format: username type: string type: array domains: description: A list of the domain or domains that the certificate covers. example: - example.com items: format: domain type: string type: array ecdsa_curve_name: description: 'The ECDSA curve that the certificate''s key uses. * `prime256v1` * `secp384r1` * `null` — The certificate''s key is **not** an ECDSA key.' enum: - prime256v1 - secp384r1 example: null type: - string - 'null' friendly_name: description: The certificate's friendly name. example: TestCertificate type: string id: description: The certificate's ID. example: example._com_d13b4_362b9_1400343187_b05e5c3e443dda9a8869c4cf7457829e type: string is_self_signed: description: 'Whether the certificate is self-signed. * `1` — Self-signed. * `0` — **Not** self-signed.' enum: - 1 - 0 example: 1 type: integer issuer.organizationName: description: The certificate's Organization Name. example: Organization type: string key_algorithm: description: 'The certificate''s key''s algorithm. * `rsaEncryption` — RSA. * `id-ecPublicKey` — ECDSA.' enum: - rsaEncryption - id-ecPublicKey example: rsaEncryption type: string modulus_length: description: 'The certificate''s key''s modulus length, in bits. * `null` — The certificate''s key is **not** an RSA key.' example: 2048 type: - integer - 'null' not_after: description: The date the certificate expires. example: 1601467200 format: unix_timestamp type: integer registered: description: 'Whether the certificate is registered with a CA. * `1` — Registered. * `0` — **Not** registered.' enum: - 1 - 0 example: 1 type: integer signature_algorithm: description: The certificate's OID hash algorithm signature. example: sha256WithRSAEncryption type: string validation_type: description: 'The certificate''s validation type. * `ev` — Extended Validation. * `ov` — Organization Validation. * `dv` — Domain Validated. * `null` — The system could **not** parse and determine the certificate''s validation type.' enum: - ev - dv - ov example: dv type: - string - 'null' type: object type: array type: object metadata: properties: command: description: The method name called. example: listcrts type: string reason: description: The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds. example: OK type: string result: description: '* `1` — Success. * `0` — Failed. Check the `reason` field for more details.' enum: - 1 - 0 example: 1 type: integer version: description: The version of the API function. example: 1 type: integer type: object description: HTTP Request was successful. summary: Return domains with installed SSL certificates tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n listcrts\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/listcrts?api.version=1 x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '11' servers: - description: A server running WHM. url: https://{host}:{port}/json-api variables: host: default: whm-server.tld description: The hostname of a server running WHM. port: default: '2087' description: The WHM port. /rebuildinstalledssldb: get: description: 'This function is a no-op and performs no actions. **Note:** This function previously rebuilt the database of installed SSL certificates, but this operation is no longer necessary and the function always succeeds without taking any action.' operationId: SSL-rebuildinstalledssldb parameters: [] responses: '200': content: application/json: schema: properties: data: properties: {} type: object metadata: properties: command: description: The method name called. example: rebuildinstalledssldb type: string reason: description: 'The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.' example: OK type: string result: description: '* `1` - Success * `0` - Failed. Check the `reason` field for more details.' enum: - 0 - 1 example: 1 type: integer version: description: The version of the API function. example: 1 type: integer warnings: description: Warnings generated while running the function. items: example: This function is now a no-op. type: string type: array type: object description: HTTP Request was successful. summary: Rebuild installed SSL database (no-op) tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n rebuildinstalledssldb\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/rebuildinstalledssldb?api.version=1 x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '11.36' servers: - description: A server running WHM. url: https://{host}:{port}/json-api variables: host: default: whm-server.tld description: The hostname of a server running WHM. port: default: '2087' description: The WHM port. /rebuilduserssldb: get: description: This function rebuilds the database of SSL certificate users. operationId: SSL-rebuilduserssldb parameters: [] responses: '200': content: application/json: schema: properties: data: properties: records: description: The cPanel accounts that the function rebuilt SSL certificate information for. items: example: username format: username type: string type: array type: object metadata: properties: command: description: The method name called. example: rebuilduserssldb type: string reason: description: The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds. example: OK type: string result: description: '* `1` - Success * `0` - Failed. Check the `reason` field for more details.' enum: - 0 - 1 example: 1 type: integer version: description: The version of the API function. example: 1 type: integer type: object description: HTTP Request was successful. summary: Update SSL certificate users database tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n rebuilduserssldb\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/rebuilduserssldb?api.version=1 x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '11.38' servers: - description: A server running WHM. url: https://{host}:{port}/json-api variables: host: default: whm-server.tld description: The hostname of a server running WHM. port: default: '2087' description: The WHM port. /remove_autossl_user_excluded_domains: get: description: This function enables AutoSSL for an account's specified domains. operationId: SSL-remove_autossl_user_excluded_domains parameters: - description: 'Enable AutoSSL for this domain. **Note:** For multiple domains, increment the parameter name. For example, domain-1, domain-2, and domain-3.' examples: multiple: summary: Enable AutoSSL for multiple domains. value: domain-1=cpcalendars.example.com&domain-2=cpcontacts.example.com single: summary: Enable AutoSSL for a single domain. value: cpcalendars.example.com in: query name: domain required: true schema: example: cpcalendars.example.com format: domain type: string - description: The cPanel user's account. in: query name: username required: true schema: example: username format: username type: string responses: '200': content: application/json: schema: properties: metadata: properties: command: description: The method name called. example: remove_autossl_user_excluded_domains type: string reason: description: The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds. example: OK type: string result: description: '* `1` - Success * `0` - Failed. Check the `reason` field for more details.' enum: - 0 - 1 example: 1 type: integer version: description: The version of the API function. example: 1 type: integer type: object description: HTTP Request was successful. summary: Remove AutoSSL for domain tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n remove_autossl_user_excluded_domains \\\n username='username' \\\n domain='cpcalendars.example.com'\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/remove_autossl_user_excluded_domains?api.version=1&username=username&domain=cpcalendars.example.com x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '66' servers: - description: A server running WHM. url: https://{host}:{port}/json-api variables: host: default: whm-server.tld description: The hostname of a server running WHM. port: default: '2087' description: The WHM port. /reset_autossl_provider: get: description: This function resets the AutoSSL registration with a remote AutoSSL provider. operationId: SSL-reset_autossl_provider parameters: - description: The AutoSSL provider's name. in: query name: provider required: true schema: example: cPanel type: string - description: "Additional parameters which you wish to pass to the AutoSSL provider.\n\n**Note:**\n\n These additional parameters begin with the `x_` prefix.\n For example, the Let's Encrypt provider accepts the `x_terms_of_service_accepted` parameter,\n to which you would pass the URL of the terms of service that you accept." in: query name: x_* required: false schema: example: (varies) type: string responses: '200': content: application/json: schema: properties: metadata: properties: command: description: The method name called. example: reset_autossl_provider type: string reason: description: The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds. example: OK type: string result: description: '* `1` - Success * `0` - Failed. Check the `reason` field for more details.' enum: - 0 - 1 example: 1 type: integer version: description: The version of the API function. example: 1 type: integer type: object description: HTTP Request was successful. summary: Restore AutoSSL registration tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n reset_autossl_provider \\\n provider='cPanel'\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/reset_autossl_provider?api.version=1&provider=cPanel x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '58' servers: - description: A server running WHM. url: https://{host}:{port}/json-api variables: host: default: whm-server.tld description: The hostname of a server running WHM. port: default: '2087' description: The WHM port. /reset_service_ssl_certificate: get: description: This function regenerates a self-signed SSL certificate and assigns it to a service. operationId: SSL-reset_service_ssl_certificate parameters: - description: 'The service. * `ftp` - The `ftp` service. * `exim` - The `exim` service. * `dovecot` - The `dovecot` service. * `cpanel` - The `cpanel` service.' in: query name: service required: true schema: enum: - ftp - exim - dovecot - cpanel example: cpanel type: string responses: '200': content: application/json: schema: properties: data: properties: certificate: description: The SSL certificate's contents. example: REDACTED_CERTIFICATE_EXAMPLE format: pem-certificate type: string certificate_info: description: Detailed information about the certificate. properties: domains: description: The domains that correspond to the certificate. items: example: example.com format: domain type: string type: array ecdsa_curve_name: description: 'The ECDSA curve that the certificate''s key uses. * `prime256v1` * `secp384r1` * `null` — The certificate''s key is **not** an ECDSA key.' enum: - prime256v1 - secp384r1 example: null type: - string - 'null' ecdsa_public: description: 'The certificate''s key''s ECDSA compressed public point, in hexadecimal format. * `null` — The certificate''s key is **not** an ECDSA key.' example: null type: - string - 'null' is_self_signed: description: 'This value indicates whether the certificate is a self-signed certificate. * `1` - Certificate is self-signed. * `0` - Certificate is **not** self-signed.' enum: - 0 - 1 example: 1 type: integer issuer.commonName: description: The Common Name of the organization that issued the certificate. example: example.com type: string issuer.organizationName: description: The organization that generated the certificate. example: Writer's Guild of America type: string issuer_text: description: Information about the issuer. example: 'commonName hostname.example.com emailAddress ssl@hostname.example.com' type: string key_algorithm: description: 'The certificate''s key''s algorithm. * `rsaEncryption` — RSA. * `id-ecPublicKey` — ECDSA.' enum: - rsaEncryption - id-ecPublicKey example: rsaEncryption type: string modulus: description: 'The certificate''s key''s modulus, in hexadecimal format. * `null` — The certificate''s key is **not** an RSA key.' example: a673c3b17344664b35f8791f562d3aea6bf4d8faa3ae3fc0a519380fd453964a36677c34d48677ecb7f5ed035df026f5f0f8fbfe21745e52daf1f3b9e58c73f0baefdb709320e2202e7d05250b051a59b30ff1fef22d83d7140c1c81cea314a0890ce8d2226799872181c58a74016c7aaa2cff5ac72b575cecde8f304aa572a2ea03d8b173ab76c6e8cdb9dfd0da81e1119cefd4b8b4dbfbe0e46c7f1ee2fe8b5fd5504e58ccbc0d13b4fa41ecc9ebd0dabe1d1fec5c724f748167e7c0553e997f9b77eb36abce70973f06df151748d41b758de3efd7afa6f2464a1547f5ff158469d96e248be464df9eda0e7ce854a89332a2c1278b17c425368a9604f454db type: - string - 'null' modulus_length: description: 'The certificate''s key''s modulus length, in bits. * `null` — The certificate''s key is **not** an RSA key.' example: 2048 minimum: 1 type: - integer - 'null' not_after: description: When the certificate expires. example: 1398805499 format: unix_timestamp type: integer not_before: description: The certificate's validation date. example: 1367269499 format: unix_timestamp type: integer type: object service: description: 'The service that the certificate corresponds to. * `ftp` - The `ftp` service. * `exim` - The `exim` service. * `dovecot` - The `dovecot` service. * `cpanel` - The `cpanel` service.' enum: - ftp - exim - dovecot - cpanel example: ftp type: string type: object metadata: properties: command: description: The method name called. example: reset_service_ssl_certificate type: string reason: description: The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds. example: OK type: string result: description: '* `1` - Success. * `0` - Failed. Check the reason field for more details.' enum: - 0 - 1 example: 1 type: integer version: description: The version of the API function. example: 1 type: integer type: object description: HTTP Request was successful. summary: Create self-signed SSL certificate for service tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n reset_service_ssl_certificate \\\n service='cpanel'\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/reset_service_ssl_certificate?api.version=1&service=cpanel x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '11.40' servers: - description: A server running WHM. url: https://{host}:{port}/json-api variables: host: default: whm-server.tld description: The hostname of a server running WHM. port: default: '2087' description: The WHM port. /set_autossl_metadata: get: description: 'This function sets values for AutoSSL''s metadata keys. This allows you to replace certificates that AutoSSL did not issue and toggle other AutoSSL notifications. **Note:** We recommend that you use the WHM API 1 `set_autossl_metadata_key` function instead. **Information:** * You can enter more than one key and value pair in the `metadata_json` JSON hash. * Any keys that you do not **explicitly** define will adopt the system''s default value.' operationId: SSL-set_autossl_metadata parameters: - content: application/json: schema: example: clobber_externally_signed: 1 notify_autossl_expiry: 1 notify_autossl_expiry_coverage: 1 notify_autossl_expiry_coverage_user: 1 notify_autossl_expiry_user: 1 notify_autossl_renewal: 1 notify_autossl_renewal_coverage: 1 notify_autossl_renewal_coverage_reduced: 1 notify_autossl_renewal_coverage_reduced_user: 1 notify_autossl_renewal_coverage_user: 1 notify_autossl_renewal_uncovered_domains: 1 notify_autossl_renewal_uncovered_domains_user: 1 notify_autossl_renewal_user: 1 properties: clobber_externally_signed: default: 0 description: 'Whether to allow AutoSSL to replace certificates that none of this system’s AutoSSL modules issued. When you enable this option, AutoSSL will install certificates that replace users’ Certificate Authority (CA) issued certificates if they are invalid or expire within three days. * `1` - Replace certificates not issued by the AutoSSL system. * `0` - Only replace certificates issued by the AutoSSL system.' enum: - 0 - 1 example: 1 type: integer notify_autossl_expiry: default: 1 description: 'Whether to send a notification when an AutoSSL certificate expires. This occurs when AutoSSL cannot request a new certificate. * `1` - Send a notification. * `0` - Do **not** send a notification. **Notes:** This can happen if all of a website’s domains fail Domain Control Validation (DCV), or if the AutoSSL provider has not issued a certificate in response to a request.' enum: - 0 - 1 example: 1 type: integer notify_autossl_expiry_coverage: default: 1 description: 'Whether to send a notification if at least one currently-secured domain will lose coverage when the certificate renews. * `1` - Send a notification. * `0` - Do **not** send a notification.' enum: - 0 - 1 example: 1 type: integer notify_autossl_expiry_coverage_user: default: 1 description: 'Whether to send a notification if at least one of a user''s currently-secured domains will lose coverage when the certificate renews. * `1` - Send a notification. * `0` - Do **not** send a notification.' enum: - 0 - 1 example: 1 type: integer notify_autossl_expiry_user: default: 1 description: 'Whether to send a notification when a user''s AutoSSL certificate expires. This occurs when AutoSSL cannot request a new certificate for a user. * `1` - Send a notification. * `0` - Do **not** send a notification.' enum: - 0 - 1 example: 1 type: integer notify_autossl_renewal: default: 1 description: 'Whether to send a notification when AutoSSL successfully renews a certificate. * `1` - Send a notification. * `0` - Do **not** send a notification.' enum: - 0 - 1 example: 1 type: integer notify_autossl_renewal_coverage: default: 1 description: 'Whether to send a notification if a currently-secured domain fails DCV and the certificate has not reached its renewal period. * `1` - Send a notification. * `0` - Do **not** send a notification.' enum: - 0 - 1 example: 1 type: integer notify_autossl_renewal_coverage_reduced: default: 1 description: 'Whether to send a notification when AutoSSL has renewed a certificate and the new certificate lacks at least one domain that the previous certificate secured. * `1` - Send a notification. * `0` - Do **not** send a notification.' enum: - 0 - 1 example: 1 type: integer notify_autossl_renewal_coverage_reduced_user: default: 1 description: 'Whether to send a notification when AutoSSL has renewed a certificate for a user and the new certificate lacks at least one domain that the previous certificate secured. * `1` - Send a notification. * `0` - Do **not** send a notification.' enum: - 0 - 1 example: 1 type: integer notify_autossl_renewal_coverage_user: default: 1 description: 'Whether to send a notification if a currently-secured domain fails DCV and the certificate has not reached its renewal period. * `1` - Send a notification. * `0` - Do **not** send a notification.' enum: - 0 - 1 example: 1 type: integer notify_autossl_renewal_uncovered_domains: default: 1 description: 'Whether to send a notification when AutoSSL has renewed a certificate and the new certificate lacks one or more of the website’s domains. * `1` - Send a notification. * `0` - Do **not** send a notification.' enum: - 0 - 1 example: 1 type: integer notify_autossl_renewal_uncovered_domains_user: default: 1 description: 'Whether to send a notification when AutoSSL has renewed a certificate for a user and the new certificate lacks one or more of the website’s domains. * `1` - Send a notification. * `0` - Do **not** send a notification.' enum: - 0 - 1 example: 1 type: integer notify_autossl_renewal_user: default: 1 description: 'Whether to send a notification when AutoSSL successfully renews a certificate for a user. * `1` - Send a notification. * `0` - Do **not** send a notification.' enum: - 0 - 1 example: 1 type: integer type: object description: JSON-encoded object of metadata keys and values that control AutoSSL's behavior. in: query name: metadata_json required: true responses: '200': content: application/json: schema: properties: metadata: properties: command: description: The method name called. example: set_autossl_metadata type: string reason: description: The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds. example: OK type: string result: description: '* `1` - Success. * `0` - Failed. Check the reason field for more details.' enum: - 0 - 1 example: 1 type: integer version: description: The version of the API function. example: 1 type: integer type: object description: HTTP Request was successful. summary: Update AutoSSL metadata tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n set_autossl_metadata \\\n metadata_json='{\"clobber_externally_signed\":\"1\",\"notify_autossl_expiry\":\"1\",\"notify_autossl_expiry_coverage\":\"1\",\"notify_autossl_expiry_coverage_user\":\"1\",\"notify_autossl_expiry_user\":\"1\",\"notify_autossl_renewal\":\"1\",\"notify_autossl_renewal_coverage\":\"1\",\"notify_autossl_renewal_coverage_reduced\":\"1\",\"notify_autossl_renewal_coverage_reduced_user\":\"1\",\"notify_autossl_renewal_coverage_user\":\"1\",\"notify_autossl_renewal_uncovered_domains\":\"1\",\"notify_autossl_renewal_uncovered_domains_user\":\"1\",\"notify_autossl_renewal_user\":\"1\"}'\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/set_autossl_metadata?api.version=1&metadata_json=%7b%22clobber_externally_signed%22%3a%221%22%2c%22notify_autossl_expiry%22%3a%221%22%2c%22notify_autossl_expiry_coverage%22%3a%221%22%2c%22notify_autossl_expiry_coverage_user%22%3a%221%22%2c%22notify_autossl_expiry_user%22%3a%221%22%2c%22notify_autossl_renewal%22%3a%221%22%2c%22notify_autossl_renewal_coverage%22%3a%221%22%2c%22notify_autossl_renewal_coverage_reduced%22%3a%221%22%2c%22notify_autossl_renewal_coverage_reduced_user%22%3a%221%22%2c%22notify_autossl_renewal_coverage_user%22%3a%221%22%2c%22notify_autossl_renewal_uncovered_domains%22%3a%221%22%2c%22notify_autossl_renewal_uncovered_domains_user%22%3a%221%22%2c%22notify_autossl_renewal_user%22%3a%221%22%7d x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '60' servers: - description: A server running WHM. url: https://{host}:{port}/json-api variables: host: default: whm-server.tld description: The hostname of a server running WHM. port: default: '2087' description: The WHM port. /set_autossl_metadata_key: get: description: 'This function sets values for AutoSSL''s metadata keys. This allows you to replace certificates that AutoSSL did not issue and toggle other AutoSSL notifications. **Note:** * This function performs the same actions as the WHM API 1 `set_autossl_metadata` function. However, this function accepts a single key and value pair as a parameter instead of JSON. Additionally, you can **only** enter one key and value pair per function call. * This function **only** accepts a single key and value pair. To set all values, use the WHM API 1 `set_autossl_metadata` function or make multiple calls to this function.' operationId: SSL-set_autossl_metadata_key parameters: - description: 'The AutoSSL metadata key that you wish to modify. * `clobber_externally_signed` — Whether to allow AutoSSL to replace certificates that none of this system’s AutoSSL modules issued. When you enable this option, AutoSSL will install certificates that replace users’ Certificate Authority (CA) issued certificates if they are invalid or expire within three days. * `notify_autossl_expiry` — Whether to send a notification when an AutoSSL certificate expires. This occurs when AutoSSL cannot request a new certificate. * `notify_autossl_expiry_coverage` — Whether to send a notification if at least one currently-secured domain will lose coverage when the certificate renews. * `notify_autossl_expiry_coverage_user `— Whether to send a notification if at least one currently-secured domain for a user will lose coverage when the certificate renews. * `notify_autossl_renewal` — Whether to send a notification when AutoSSL successfully renews a certificate. * `notify_autossl_renewal_user` — Whether to send a notification when AutoSSL successfully renews a certificate for a user. * `notify_autossl_renewal_coverage` — Whether to send a notification when a currently-secured domain fails DCV and the certificate has not reached its renewal period. * `notify_autossl_renewal_coverage_user` — Whether to send a notification when a user''s currently-secured domain fails DCV and the certificate has not reached its renewal period. * `notify_autossl_renewal_coverage_reduced` — Whether to send a notification when AutoSSL has renewed a certificate, but the new certificate lacks at least one domain that the previous certificate secured. * `notify_autossl_renewal_coverage_reduced_user` — Whether to send a notification when AutoSSL has renewed a certificate for a user, but the new certificate lacks at least one domain that the previous certificate secured. * `notify_autossl_renewal_uncovered_domains` — Whether to send a notification when AutoSSL has renewed a certificate, but the new certificate lacks one or more of the website’s domains. * `notify_autossl_renewal_uncovered_domains_user` — Whether to send a notification when AutoSSL has renewed a certificate, but the new certificate lacks one or more of the website’s domains.' in: query name: key required: true schema: enum: - clobber_externally_signed - notify_autossl_expiry - notify_autossl_expiry_coverage - notify_autossl_expiry_coverage_user - notify_autossl_renewal - notify_autossl_renewal_user - notify_autossl_renewal_coverage - notify_autossl_renewal_coverage_user - notify_autossl_renewal_coverage_reduced - notify_autossl_renewal_coverage_reduced_user - notify_autossl_renewal_uncovered_domains - notify_autossl_renewal_uncovered_domains_user example: notify_autossl_expiry type: string - description: "Whether to allow AutoSSL to replace certificates that it did not issue for the `clobber_externally_signed` parameter.\n\n**or**\n\nWhether to send a notification for the `notify_autossl_expiry`, `notify_autossl_expiry_coverage`, `notify_autossl_expiry_coverage_user`, `notify_autossl_renewal`, `notify_autossl_renewal_user`, `notify_autossl_renewal_coverage`, `notify_autossl_renewal_coverage`, `notify_autossl_renewal_coverage_reduced`, `notify_autossl_renewal_coverage_reduced_user`, `notify_autossl_renewal_uncovered_domains`, and `notify_autossl_renewal_uncovered_domains_user` parameters.\n* `1` — Allow or notify.\n* `0` — Do **not** allow or notify.\n\n**Note:**\n\n For reference, the system preconfigures AutoSSL metadata keys to the following values:\n * The value for `clobber_externally_signed` defaults to `0`.\n * The value for `notify_autossl_expiry` defaults to `1`.\n * The value for `notify_autossl_expiry_coverage` defaults to `1`.\n * The value for `notify_autossl_expiry_coverage_user` defaults to `1`.\n * The value for `notify_autossl_renewal` defaults to `1`.\n * The value for `notify_autossl_renewal_user` defaults to `1`.\n * The value for `notify_autossl_renewal_coverage` defaults to `1`.\n * The value for `notify_autossl_renewal_coverage_user` defaults to `1`.\n * The value for `notify_autossl_renewal_coverage_reduced` defaults to `1`.\n * The value for `notify_autossl_renewal_coverage_reduced_user` defaults to `1`.\n * The value for `notify_autossl_renewal_uncovered_domains` defaults to `1`.\n * The value for `notify_autossl_renewal_uncovered_domains_user` defaults to `1`." in: query name: value required: true schema: enum: - 0 - 1 example: 1 type: integer responses: '200': content: application/json: schema: properties: metadata: properties: command: description: The method name called. example: set_autossl_metadata_key type: string reason: description: The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds. example: OK type: string result: description: '* `1` - Success. * `0` - Failed. Check the `reason` field for more details.' enum: - 0 - 1 example: 1 type: integer version: description: The version of the API function. example: 1 type: integer type: object description: HTTP Request was successful. summary: Update AutoSSL metadata via JSON tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n set_autossl_metadata_key \\\n key='notify_autossl_expiry' \\\n value='1'\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/set_autossl_metadata_key?api.version=1&key=notify_autossl_expiry&value=1 x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '70' servers: - description: A server running WHM. url: https://{host}:{port}/json-api variables: host: default: whm-server.tld description: The hostname of a server running WHM. port: default: '2087' description: The WHM port. /set_autossl_provider: get: description: 'This function sets the provider that the AutoSSL feature uses. **Note:** To disable AutoSSL, call WHM API 1''s `disable_autossl` function.' operationId: SSL-set_autossl_provider parameters: - description: 'The AutoSSL provider''s name. For example: * `cPanel` * `LetsEncrypt`' in: query name: provider required: true schema: example: cPanel type: string - description: "Additional parameters which you wish to pass to the AutoSSL provider.\n\n **Note:**\n\n These additional parameters begin with the `x_` prefix. For example, the Let's Encrypt provider accepts the `x_terms_of_service_accepted parameter`, to which you would pass the URL of the terms of service that you accept." in: query name: x_* required: false schema: example: (varies) type: string responses: '200': content: application/json: schema: properties: metadata: properties: command: description: The method name called. example: set_autossl_provider type: string reason: description: The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds. example: OK type: string result: description: '* `1` - Success. * `0` - Failed. Check the `reason` field for more details.' enum: - 0 - 1 example: 1 type: integer version: description: The version of the API function. example: 1 type: integer type: object description: HTTP Request was successful. summary: Update the AutoSSL provider tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n set_autossl_provider \\\n provider='cPanel'\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/set_autossl_provider?api.version=1&provider=cPanel x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '58' servers: - description: A server running WHM. url: https://{host}:{port}/json-api variables: host: default: whm-server.tld description: The hostname of a server running WHM. port: default: '2087' description: The WHM port. /set_autossl_user_excluded_domains: get: description: 'This function disables AutoSSL for a specific domain on an account. **Warning:** This function **replaces** the list of any previously-excluded domains. To add a domain to the list of the user''s excluded domains, use the `add_autossl_user_excluded_domains` function.' operationId: SSL-set_autossl_user_excluded_domains parameters: - description: The cPanel user's account. in: query name: username required: true schema: example: example format: username type: string - description: 'Disable AutoSSL for this domain. If you do **not** include this parameter, the system will **enable** AutoSSL for every domain on the account. **Note** To disable AutoSSL for multiple domains, duplicate or increment the parameter name. For example, to exclude three domains, you could: * Use the `domain` parameter multiple times. * Use the `domain`, `domain-1`, and `domain-2` parameters.' examples: multiple: summary: Multiple domains value: domain=example.com&domain-1=example1.com&domain-2=example2.com multiple-alternative: summary: Multiple domains value: domain=example.com&domain=example1.com&domain=example2.com single: summary: A single domain. value: example.com in: query name: domain required: false schema: example: cpcalendars.example.com format: domain type: string responses: '200': content: application/json: schema: properties: metadata: properties: command: description: The method name called. example: set_autossl_user_excluded_domains type: string reason: description: The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds. example: OK type: string result: description: '* `1` - Success. * `0` - Failed. Check the `reason` field for more details.' enum: - 0 - 1 example: 1 type: integer version: description: The version of the API function. example: 1 type: integer type: object description: HTTP Request was successful. summary: Disable AutoSSL for domain tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n set_autossl_user_excluded_domains \\\n username='example'\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/set_autossl_user_excluded_domains?api.version=1&username=example x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '66' servers: - description: A server running WHM. url: https://{host}:{port}/json-api variables: host: default: whm-server.tld description: The hostname of a server running WHM. port: default: '2087' description: The WHM port. /start_autossl_check_for_all_users: get: description: This function performs an AutoSSL certificate check in the background for all cPanel users that have the feature enabled. operationId: SSL-start_autossl_check_for_all_users parameters: [] responses: '200': content: application/json: schema: properties: data: properties: pid: description: The process ID of the script. example: 29193 minimum: 1 type: integer type: object metadata: properties: command: description: The method name called. example: start_autossl_check_for_all_users type: string reason: description: The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds. example: OK type: string result: description: '* `1` - Success. * `0` - Failed. Check the `reason` field for more details.' enum: - 0 - 1 example: 1 type: integer version: description: The version of the API function. example: 1 type: integer type: object description: HTTP Request was successful. summary: Start AutoSSL check for all cPanel accounts tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n start_autossl_check_for_all_users\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/start_autossl_check_for_all_users?api.version=1 x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '58' servers: - description: A server running WHM. url: https://{host}:{port}/json-api variables: host: default: whm-server.tld description: The hostname of a server running WHM. port: default: '2087' description: The WHM port. /start_autossl_check_for_one_user: get: description: This function performs an AutoSSL certificate check in the background for a cPanel user. operationId: SSL-start_autossl_check_for_one_user parameters: - description: The cPanel username. in: query name: username required: true schema: example: example type: string responses: '200': content: application/json: schema: properties: data: properties: pid: description: The process ID of the script. example: 12345 minimum: 1 type: integer metadata: properties: command: description: The method name called. example: start_autossl_check_for_one_user type: string reason: description: The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds. example: OK type: string result: description: '* `1` — Success. * `0` — Failed. Check the `reason` field for more details.' enum: - 0 - 1 example: 1 type: integer version: description: The version of the API function. example: 1 type: integer type: object description: HTTP Request was successful. summary: Start cPanel account AutoSSL check tags: - SSL x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n start_autossl_check_for_one_user \\\n username='example'\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/start_autossl_check_for_one_user?api.version=1&username=example x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '58' servers: - description: A server running WHM. url: https://{host}:{port}/json-api variables: host: default: whm-server.tld description: The hostname of a server running WHM. port: default: '2087' description: The WHM port. components: securitySchemes: BasicAuth: scheme: basic type: http externalDocs: url: https://cpanel.net/developers/ x-refined-from: - cpanel-uapi-openapi.yml - cpanel-whm-api-openapi.yml x-tagGroups: - name: API Development Tools tags: - API Token Management - Batch - SSE Task Management - URL Parsing - name: Authentication tags: - External Authentication - Two-Factor Settings - name: Backup Information tags: - BackupInfo - BackupInfo Status - name: Block Ip Addresses tags: - Block IP - name: Commerce Integration tags: - Market Integration - SSL Certificates - name: Contact Information tags: - Contact Information - name: cPanel Account tags: - Account Enhancements - Account Information - Account Management - AuditLog - Contact Information - cPanel Features - Disk Quotas - DomainRecommendations - Personalization - Resource Usage and Statistics - Subaccount Management - Team Roles - Team Users - name: cPanel Account Backups tags: - Backup - File Restoration - name: cPanel Plugin Framework tags: - Formbricks - Plugins - name: cPanel Theme Management tags: - Application Information - Brand Management - Branding Files - Browser Cache Management - Language - Theme Settings - name: Directory Management tags: - Directory Indexes - Directory Privacy - Directory Protection - name: DNS tags: - DNS - DNS Information - DNS Security - Dynamic DNS - Email DNS Settings - ZoneEdit - name: Domain tags: - Domain - name: Domain Management tags: - AddonDomain - Direct Link Protection (Hotlink) - Domain - Domain Information - Domain Redirection - DomainLookup - Park - SubDomain - Virtual Host Information - name: Domains tags: - Subdomains - name: Email tags: - Email Accounts - Email Filtering - Email Forwarding - Email Server Information - Email Suspensions - Mail Server Information - Mailbox Management - Mailing Lists - Signing and Encryption (GnuPG Keys) - Spam Filtering (Greylisting) - Spam Management - Spam Prevention (BoxTrapper) - Webmail Applications - Webmail Sessions - name: Extract Information tags: - ExtractInfo - ExtractInfo Status - name: File Manager tags: - Trash - name: Files tags: - FTP Accounts - FTP Server Settings - Image Tools - Jodit - Manage Files - Manage Files - WebDisk Settings - name: GIT Management tags: - Deployment Settings - Repository Management - name: InProductSurvey tags: - InProductSurvey - name: MySQL and MariaDB tags: - Database Information - Database Management - Remote Databases - User Management - name: Notifications tags: - Pushbullet - name: Optional Applications tags: - Antivirus Protection (ClamAV) - Calendar and Contacts (DAV) - Calendar and Contacts Server - WordPress Manager Backups - name: PostgreSQL tags: - PostgreSQL Database Management - PostgreSQL User Management - name: Retrieve bandwidth information tags: - Bandwidth - name: Security tags: - Known SSH Hosts Management - Login Information - name: Server Information tags: - cPanel Server Information - Notifications - Password Strength - SSH - WebPros MCP - WebProsMCP - name: ServiceProxy tags: - ServiceProxy - name: Site Quality Monitoring tags: - SiteQuality - name: SSL Certificates tags: - Auto-generated SSL Certificates - cPanel Account SSL Management - SNI Email Settings - SSL Certificate Management - Verify Domain Ownership - name: Statistics tags: - Domain Statistics - Weblog Settings - name: UserData tags: - UserData - name: Web Server Configuration tags: - EA4 - EasyApache Settings - PHP - name: Web Server Management tags: - Application Manager - ModSecurity - NginxCaching - PHP Settings - Web Apps - name: Website Configuration tags: - Handler Management - Logs - Mime Type Management - Nova - Site Information - Site Installation - Sitejet - WPX