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

# Create remote MySQL profile

`GET /remote_mysql_create_profile`

This function creates a profile to access a remote MySQL® server.

## Query parameters

- `mysql_host` union, required
  - string, ipv4
  - string, hostname
- `mysql_pass` string, required
- `mysql_port` integer, required
- `mysql_user` string, required
- `name` string, required
- `cpcloud` integer
- `setup_via` string

## Response `200`

HTTP Request was successful.

- object
  - `data` object
    - `profile_details` object — An object containing the new profile's data.
      - `active` 0 | 1 — Whether the system uses this profile to access the MySQL server. * `1` — Active. * `0` — **Not** active.
      - `cpcloud` 0 | 1 — Whether the remote database profile is a cPanel Cloud deployment. * `1` — Is cPanel Cloud. * `0` — **Not** cPanel Cloud.
      - `mysql_host` union — The MySQL server's IP address or hostname.
        - string, ipv4
        - string, hostname
      - `mysql_pass` string — The MySQL server's password.
      - `mysql_port` integer — The MySQL server's port.
      - `mysql_user` string — The MySQL server's username.
      - `setup_via` string — A description of the profile data.
    - `profile_saved` string — The new 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)