latestOpenAPI 3.0.2cPanel License2026-08-106251554.3 MB

3da41671c02c

Server Administration
Server Profiles

Return server's node profile

This function returns details about the server's current cPanel & WHM server profile.

get/get_current_profile

Response

HTTP Request was successful.

Example response

{
  "data": {
    "code": "MAILNODE",
    "description": "This profile provides only services and cPanel features that allow the system to serve mail.",
    "disabled_roles": [
      {
        "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": "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": "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"
      }
    ],
    "enabled_roles": [
      {
        "description": "Calendars and Contacts provides CalDAV and CardDAV services.",
        "module": "CalendarContact",
        "name": "Calendars and Contacts"
      },
      {
        "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": "Webmail provides access to webmail services.",
        "module": "Webmail",
        "name": "Webmail"
      }
    ],
    "experimental": 1,
    "name": "Mail",
    "optional_roles": [
      {
        "description": "DNS allows users to create and edit Domain Name System zone files.",
        "module": "DNS",
        "name": "DNS"
      },
      {
        "description": "Spam Filter allows users to use Apache SpamAssassin™ to identify, sort, and delete unsolicited mail.",
        "module": "SpamFilter",
        "name": "Spam Filter"
      }
    ]
  },
  "metadata": {
    "command": "get_current_profile",
    "reason": "OK",
    "result": 1,
    "version": 1
  }
}