---
title: "Return available server profiles"
method: GET
path: "/get_available_profiles"
tags: ["Server Administration", "Server Profiles"]
---

# Return available server profiles

`GET /get_available_profiles`

This function returns a list of available server profiles.

## Response `200`

HTTP Request was successful.

- object
  - `data` object
    - `profiles` object[] — An array of objects that contains the available server profiles.
      - `code` string — The profile's ID.
      - `description` string — The profile's description.
      - `disabled_roles` object[] — The roles that this profile disables. The function returns an empty array if no disabled roles exist.
        - `description` string — The role's description.
        - `module` string — The role's module name.
        - `name` string — The role's name.
      - `enabled_roles` object[] — The roles that this profile enables.
        - `description` string — The role's description.
        - `module` string — The role's module name.
        - `name` string — The role's name.
      - `experimental` 1 | 0 — Whether the profile is experimental. * `1` - Experimental. * `0` - **Not** experimental.
      - `name` string — The profile's name.
      - `optional_roles` object[] — The optional roles that this profile enables. The function returns an empty array if no optional roles exist.
        - `description` string — The role's description.
        - `module` string — The role's module name.
        - `name` string — The role's name.
  - `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)