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.

Authorizations:
query Parameters
domains
string

The domain name or names.

Examples:
domains=domains=example1.com|example2.com
domains=example.com
item
string
Default: "key"

The SSL item type or types.

  • key
  • csr
  • crt
Examples:
item=item=key|csr
item=key

Responses

Response Schema: application/json
apiversion
integer

The version of the API.

func
string

The name of the method called.

module
string

The name of the module called.

object

Request samples

uapi --user=username SSL list_ssl_items

Response samples

Content type
application/json
{
  • "apiversion": 3,
  • "func": "list_ssl_items",
  • "module": "SSL",
  • "result": {
    • "data": [
      • {
        • "host": "example.com",
        • "id": "example_com_a74f7_9dddf_1446659822_eae1ff43c4ec1991e195877c55755eff",
        • "type": "key"
        }
      ],
    • "errors": null,
    • "messages": null,
    • "metadata": {
      • "transformed": 1
      },
    • "status": 1,
    • "warnings": null
    }
}