---
title: "Return remote MySQL profile"
method: GET
path: "/remote_mysql_read_profile"
tags: ["Databases", "Remote MySQL Databases"]
---

# Return remote MySQL profile

`GET /remote_mysql_read_profile`

This function displays the details of a specified remote MySQL® profile.

## Query parameters

- `name` string, required

## Response `200`

HTTP Request was successful.

- object
  - `data` object
    - `profile_details` object — An object containing the profile's data.
      - `active` 1 | 0 — Whether the system uses this profile to access the MySQL server. * `1` — The system uses the profile. * `0` — The system does **not** use the profile.
      - `mysql_host` union — The MySQL server's IP address or hostname.
        - string, ipv4 — A valid IP address.
        - string, hostname — A valid hostname.
      - `mysql_pass` string — The MySQL server's password.
      - `mysql_port` integer — The MySQL server's port number.
      - `mysql_user` string — The MySQL server's username.
      - `setup_via` string — A description of the MySQL profile data.
    - `profile_name` string — The MySQL profile'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` 0 | 1 — * `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)