---
title: "Run remote WHM API 1 function"
method: GET
path: "/execute_remote_whmapi1_with_password"
tags: ["API Execution"]
---

# Run remote WHM API 1 function

`GET /execute_remote_whmapi1_with_password`

This function executes WHM API 1 functions on a remote server.

## Query parameters

- `function` string, required
- `host` string, required
- `parameter_name` string, required
- `parameter_value` string, required
- `password` string, required
- `username` string, required
- `tls_verification` string

## Response `200`

HTTP Request was successful.

- object
  - `data` object
    - `app` string[]
    - `key-name*` string — The function's output. **Note:** The system uses the remote function's return name. A valid possible values.
  - `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)