v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB
SSL
cPanel Account SSL Management

Return SSL-related items

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.

get/SSL/list_ssl_items

Query parameters

domainsstring

The domain name or names.

itemstring

The SSL item type or types.

  • key
  • csr
  • crt

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

{
  "apiversion": 3,
  "func": "list_ssl_items",
  "module": "SSL",
  "result": {
    "data": [
      {
        "host": "example.com",
        "id": "example_com_a74f7_9dddf_1446659822_eae1ff43c4ec1991e195877c55755eff",
        "type": "key"
      }
    ],
    "metadata": {
      "transformed": 1
    },
    "status": 1
  }
}