---
title: "Return whether server role is enabled"
method: GET
path: "/is_role_enabled"
tags: ["Server Administration", "Server Profiles"]
---

# Return whether server role is enabled

`GET /is_role_enabled`

This function checks whether a specific server role is currently enabled
for the server.

For more information about server roles, read our [How to Use Server Profiles](https://go.cpanel.net/serverroles) documentation.

## Query parameters

- `role` 'CalendarContact' | 'DNS' | 'FileStorage' | 'FTP' | 'MailLocal' | 'MailReceive' | 'MailRelay' | 'MailSend' | 'MySQL' | 'MySQLClient' | 'Postgres' | 'PostgresClient' | 'SpamFilter' | 'WebDisk' | 'Webmail' | 'WebServer', required

## Response `200`

HTTP Request was successful.

- object
  - `data` object
    - `enabled` 1 | 0 — Whether a role is enabled or disabled. * `1` - Enabled. * `0` - Disabled.
  - `metadata` object
    - `command` string — The method name called.
    - `reason` string — The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.
    - `result` 1 | 0 — * `1` - Success * `0` - Failed: Check the reason field for more details.
    - `version` integer — The version of the API function.

---

[API](https://skmtc.net/cpanel/apis/whm-api.md) · [All operations](https://skmtc.net/cpanel/apis/whm-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cpanel/whm-api/revisions/3da41671c02c/schema)