Child pages
  • WHM API 1 Functions - is_role_enabled
Skip to end of metadata
Go to start of metadata

Description

This function returns whether a specific role is currently enabled.

Examples


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/is_role_enabled?api.version=1&role=FTP
 Command Line
whmapi1 is_role_enabled role=FTP


Notes:

  • You must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command.
  • If you run CloudLinux™, you must use the full path of the whmapi1 command:

    /usr/local/cpanel/bin/whmapi1

 Output (JSON)
{  
   "data":{  
      "enabled":"1"
   },
   "metadata":{  
      "version":1,
      "command":"is_role_enabled",
      "result":1,
      "reason":"OK"
   }
}


Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

Parameters

ParameterTypeDescriptionPossible valuesExample
rolestring

Required.

The role to check the enabled status of.

Note:

This parameter is case-sensitive.

  • CalendarContact
  • DNS
  • FileStorage
  • FTP
  • MailLocal
  • MailReceive
  • MailSend
  • MySQL
  • Postgres
  • SpamFilter
  • WebDisk
  • Webmail
  • WebServer
FTP

Returns

ReturnTypeDescriptionPossible valuesExample
enabledBooleanWhether a role is enabled or disabled.
  • 0 — Disabled.
  • 1 — Enabled.
1