Return available server profiles

This function returns a list of available server profiles.

Authorizations:

Responses

Response Schema: application/json
object
object

Request samples

whmapi1 --output=jsonpretty \
  get_available_profiles

Response samples

Content type
application/json
{
  • "data": {
    • "profiles": [
      • {
        • "code": "STANDARD",
        • "description": "The Standard Node profile provides all services and access to every cPanel feature.",
        • "enabled_roles": [
          • {
            • "description": "Calendars and Contacts provides CalDAV and CardDAV services.",
            • "module": "CalendarContact",
            • "name": "Calendars and Contacts"
            },
          • {
            • "description": "DNS allows users to create and edit Domain Name System zone files.",
            • "module": "DNS",
            • "name": "DNS"
            },
          • {
            • "description": "FTP allows users to manage the files associated with their site with an FTP client.",
            • "module": "FTP",
            • "name": "FTP"
            },
          • {
            • "description": "File Storage allows users to access the File Manager and Git™ Version Control features.",
            • "module": "FileStorage",
            • "name": "File Storage"
            },
          • {
            • "description": "Receive Mail allows users to receive email, as well as create and manage their email accounts.",
            • "module": "MailReceive",
            • "name": "Receive Mail"
            },
          • {
            • "description": "Send Mail allows users to send email.",
            • "module": "MailSend",
            • "name": "Send Mail"
            },
          • {
            • "description": "Local Mail allows the system to process email.",
            • "module": "MailLocal",
            • "name": "Local Mail"
            },
          • {
            • "description": "MySQL®/MariaDB allows users to create and manage MySQL/MariaDB databases.",
            • "module": "MySQL",
            • "name": "MySQL/MariaDB"
            },
          • {
            • "description": "PostgreSQL allows users to create and manage PostgreSQL databases.",
            • "module": "Postgres",
            • "name": "PostgreSQL"
            },
          • {
            • "description": "Spam Filter allows users to use Apache SpamAssassin™ to identify, sort, and delete unsolicited mail.",
            • "module": "SpamFilter",
            • "name": "Spam Filter"
            },
          • {
            • "description": "Webmail provides access to webmail services.",
            • "module": "Webmail",
            • "name": "Webmail"
            },
          • {
            • "description": "Web Disk allows users to manage and manipulate files on the server with multiple types of devices.",
            • "module": "WebDisk",
            • "name": "Web Disk"
            },
          • {
            • "description": "Web Server allows users to create and manage websites for their domains.",
            • "module": "WebServer",
            • "name": "Web Server"
            }
          ],
        • "experimental": 0
        }
      ]
    },
  • "metadata": {
    • "command": "get_available_profiles",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}