> **Building with AI coding agents?** Install the authstack plugin with one command. This equips your agent with accurate Scalekit implementation patterns.
>
> **Recommended** (the `-y` flags skip prompts, so the command runs without an interactive terminal):
> ```bash
> npx -y @scalekit-inc/cli setup -y
> ```
>
> Global:
> ```bash
> npm install -g @scalekit-inc/cli
> scalekit setup -y
> ```
>
> Supports Claude Code, Cursor, GitHub Copilot, Codex + skills for other Agent Skills-compatible agents in `~/.agents/skills`.
> Skills: integrate-agentkit, implement-saaskit, add-mcp-oauth, implement-sso, implement-scim.
> [Full setup guide](https://docs.scalekit.com/dev-kit/build-with-ai/)

---

# Connect AI agents to DeployHQ

The DeployHQ connector lets your AI agent act in each user's DeployHQ account. Each user connects their own DeployHQ API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 60 tools.

**Authentication:** Email and API Key
**Categories:** Developer Tools
**Tools:** 60: 31 read, 21 write, 8 destructive
**Users sign in with:** Username and password
**Built by:** Scalekit connector
**Try it:** [Playground in the Scalekit dashboard](https://app.scalekit.com/ws/signup?sk_intent=playground&provider=DEPLOYHQ)

## Setup

1. ### Install the SDK

   **Node.js**

   ```bash
   npm install @scalekit-sdk/node dotenv
   ```

   **Python**

   ```bash
   pip install scalekit-sdk-python python-dotenv
   ```

2. ### Set your credentials

   Add your Scalekit credentials to your `.env` file. Find values in **[app.scalekit.com](https://app.scalekit.com)** > **Developers** > **API Credentials**.

   ```sh title=".env"
   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>
   ```

3. ### Create the DeployHQ connection

   In **AgentKit > Connections**, create a DeployHQ connection. The name you give it is the `connection_name` your code passes. See [Configure connections](/agentkit/connections/).

## Tools

Pass the exact name to `execute_tool`, with an input like each tool's example. To ask for a tool that's missing, use the [request form](https://scalekitsupport.portal.usepylon.com/forms/request-a-connector-tool).

**Node.js**

```typescript
const result = await actions.executeTool({
  toolName: 'deployhq_account_get',
  toolInput: {},
  connector: 'deployhq',
  identifier: 'user_123',
})
```

**Python**

```python
result = actions.execute_tool(
    tool_name="deployhq_account_get",
    tool_input={},
    connection_name="deployhq",
    identifier="user_123",
)
```

`result.data` is the app's response as JSON, and `result.execution_id` (`executionId` in Node.js) is the ID of the call.

### `deployhq_account_get`

Get Account · Read-only

Get the DeployHQ account: name, permalink, plan and limits. Use this to check the connection.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `deployhq_auto_deployments_list`

List Automatic Deployment Settings · Read-only

List which servers and groups of a project deploy automatically on push, and the project's webhook URL.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `project_id` (`string`, required): Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.

Example input: `{"project_id":"<project_id>"}`

### `deployhq_build_commands_list`

List Build Commands · Read-only

List the build pipeline commands of a project, in order.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `project_id` (`string`, required): Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.

Example input: `{"project_id":"<project_id>"}`

### `deployhq_config_file_get`

Get Config File · Read-only

Get one config file of a project with its contents.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Identifier of the config file. Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890.
- `project_id` (`string`, required): Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.

Example input: `{"id":"<id>","project_id":"<project_id>"}`

### `deployhq_config_files_list`

List Config Files · Read-only

List the config files a project uploads on each deployment.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `project_id` (`string`, required): Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.

Example input: `{"project_id":"<project_id>"}`

### `deployhq_deployment_get`

Get Deployment · Read-only

Get one deployment. Returns its status (pending, running, completed, failed or a preview state), revisions, servers, files changed, steps and timings.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Identifier of the deployment. Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890.
- `project_id` (`string`, required): Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.

Example input: `{"id":"<id>","project_id":"<project_id>"}`

### `deployhq_deployment_step_logs_list`

List Deployment Step Logs · Read-only

List the log entries of one step of a deployment. Use this to see why a deployment failed; step identifiers come from deployhq_deployment_get.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `deployment_id` (`string`, required): Identifier of the deployment. Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890.
- `project_id` (`string`, required): Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.
- `step_id` (`string`, required): Identifier of the deployment step. Example: b2c3d4e5-f6a7-8901-bcde-f12345678901.
- `before` (`integer`, optional): Return log entries with an ID below this one, to page back. Example: 1500.

Example input: `{"deployment_id":"<deployment_id>","project_id":"<project_id>","step_id":"<step_id>"}`

### `deployhq_deployments_list`

List Deployments · Read-only

List the deployments of a project, newest first. Returns per deployment its identifier, servers, start and end revisions, status, deployer and times. Use deployhq_deployment_get for its steps.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `project_id` (`string`, required): Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.
- `currently_running` (`string`, optional): Set to 1 to list only running deployments. Example: 1. One of: `1`.
- `page` (`integer`, optional): Page number, starting at 1. Example: 2.
- `per_page` (`integer`, optional): Deployments per page (default 10). Example: 25.
- `to` (`string`, optional): Only deployments to this server or server group identifier. Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890.

Example input: `{"project_id":"<project_id>"}`

### `deployhq_environment_variable_get`

Get Environment Variable · Read-only

Get one environment variable of a project.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Identifier of the environment variable. Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890.
- `project_id` (`string`, required): Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.

Example input: `{"id":"<id>","project_id":"<project_id>"}`

### `deployhq_environment_variables_list`

List Environment Variables · Read-only

List a project's environment variables (locked values are masked).

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `project_id` (`string`, required): Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.

Example input: `{"project_id":"<project_id>"}`

### `deployhq_excluded_files_list`

List Excluded Files · Read-only

List the file patterns a project never uploads.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `project_id` (`string`, required): Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.

Example input: `{"project_id":"<project_id>"}`

### `deployhq_integrations_list`

List Integrations · Read-only

List the notification integrations of a project (Slack, email, webhooks and others).

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `project_id` (`string`, required): Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.

Example input: `{"project_id":"<project_id>"}`

### `deployhq_language_versions_list`

List Language Versions · Read-only

List the language runtimes and versions available to build pipelines (Node, Ruby, PHP, Python and so on).

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `deployhq_profile_get`

Get My Profile · Read-only

Get the profile of the user whose API key is used: name, email, time zone and preferences.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `deployhq_project_get`

Get Project · Read-only

Get one project by permalink. Returns its name, repository, zone, public key, notification settings and last deployment.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Permalink (identifier) of the project. Example: my-website.

Example input: `{"id":"<id>"}`

### `deployhq_project_insights_get`

Get Project Deployment Insights · Read-only

Get deployment statistics for a project over a period, such as deployment counts, success rate and durations.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Permalink (identifier) of the project. Example: my-website.
- `period` (`integer`, optional): Days to aggregate: 30, 90, 180 or 365. Example: 90.

Example input: `{"id":"<id>"}`

### `deployhq_project_undeployed_changes_list`

List Undeployed Changes · Read-only

List the commits not yet deployed to each server of a project. Use this before deploying to see what will go out.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Permalink (identifier) of the project. Example: my-website.

Example input: `{"id":"<id>"}`

### `deployhq_projects_list`

List Projects · Read-only

List all projects. Returns per project its name, permalink (the identifier other tools take), repository, zone, last deployment and status. Use deployhq_project_get for one project.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `deployhq_repository_branches_list`

List Repository Branches · Read-only

List the branches of a project's repository with their latest commit.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `project_id` (`string`, required): Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.

Example input: `{"project_id":"<project_id>"}`

### `deployhq_repository_get`

Get Repository · Read-only

Get the repository connected to a project: URL, scm type, branch, hosting service and root path.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `project_id` (`string`, required): Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.

Example input: `{"project_id":"<project_id>"}`

### `deployhq_repository_latest_revision_get`

Get Latest Revision · Read-only

Get the latest commit (revision) of a branch. Use it as end_revision when deploying.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `branch` (`string`, required): Branch name. Example: main.
- `project_id` (`string`, required): Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.

Example input: `{"branch":"<branch>","project_id":"<project_id>"}`

### `deployhq_repository_recent_commits_list`

List Recent Commits · Read-only

List recent commits on a branch of a project's repository with message, author and date.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `branch` (`string`, required): Branch name. Example: main.
- `project_id` (`string`, required): Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.
- `update` (`string`, optional): Set to 1 to fetch the repository before listing commits. Example: 1. One of: `1`.

Example input: `{"branch":"<branch>","project_id":"<project_id>"}`

### `deployhq_scheduled_deployments_list`

List Scheduled Deployments · Read-only

List the scheduled deployments of a project with their server, frequency and next run.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `project_id` (`string`, required): Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.

Example input: `{"project_id":"<project_id>"}`

### `deployhq_server_get`

Get Server · Read-only

Get one server of a project. Returns its protocol, connection details (without secrets), path, branch, environment and last deployed revision.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Identifier of the server. Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890.
- `project_id` (`string`, required): Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.

Example input: `{"id":"<id>","project_id":"<project_id>"}`

### `deployhq_server_group_get`

Get Server Group · Read-only

Get one server group of a project with its servers.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Identifier of the server group. Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890.
- `project_id` (`string`, required): Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.

Example input: `{"id":"<id>","project_id":"<project_id>"}`

### `deployhq_server_groups_list`

List Server Groups · Read-only

List the server groups of a project (sets of servers deployed together). Returns per group its identifier, name, branch and servers.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `project_id` (`string`, required): Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.

Example input: `{"project_id":"<project_id>"}`

### `deployhq_servers_list`

List Servers · Read-only

List the servers (deployment targets) of a project. Returns per server its identifier, name, protocol, host, path, branch, environment and last revision.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `project_id` (`string`, required): Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.

Example input: `{"project_id":"<project_id>"}`

### `deployhq_ssh_commands_list`

List SSH Commands · Read-only

List the SSH commands a project runs on its servers before or after deployments.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `project_id` (`string`, required): Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.

Example input: `{"project_id":"<project_id>"}`

### `deployhq_test_access_get`

Get Server Access Test Results · Read-only

Get the results of a server connection test, per server.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Identifier of the access test. Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890.
- `project_id` (`string`, required): Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.

Example input: `{"id":"<id>","project_id":"<project_id>"}`

### `deployhq_users_list`

List Users · Read-only

List the account's users. Returns per user their identifier, name, email, role and status.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `deployhq_zones_list`

List Deployment Zones · Read-only

List the deployment zones (regions DeployHQ deploys from). Returns per zone its id and name. Use this to pick a zone_id for a project.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `deployhq_auto_deployments_update`

Update Automatic Deployment Settings · Write

Turn automatic deployment on push on or off for servers and server groups of a project. Returns the settings.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `deployables` (`array`, required): Servers or groups to set, each with identifier and auto_deploy. Example: [{"identifier": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "auto_deploy": true}]
- `project_id` (`string`, required): Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.

Example input: `{"deployables":[{"identifier":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","auto_deploy":true}],"project_id":"<project_id>"}`

### `deployhq_build_command_create`

Create Build Command · Write

Add a command to a project's build pipeline. Returns the command.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `command` (`string`, required): Shell command to run in the build pipeline. Example: npm ci && npm run build.
- `project_id` (`string`, required): Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.
- `description` (`string`, optional): Description. Example: Install and build assets.
- `enabled` (`boolean`, optional): Whether the command runs. Example: true.
- `halt_on_error` (`boolean`, optional): Stop the deployment if the command fails. Example: true.

Example input: `{"command":"<command>","project_id":"<project_id>"}`

### `deployhq_build_command_update`

Update Build Command · Write

Update a build command of a project. Returns the command.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Identifier of the build command. Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890.
- `project_id` (`string`, required): Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.
- `command` (`string`, optional): Shell command to run in the build pipeline. Example: npm ci && npm run build.
- `description` (`string`, optional): Description. Example: Install and build assets.
- `enabled` (`boolean`, optional): Whether the command runs. Example: true.
- `halt_on_error` (`boolean`, optional): Stop the deployment if the command fails. Example: true.

Example input: `{"id":"<id>","project_id":"<project_id>"}`

### `deployhq_config_file_create`

Create Config File · Write

Add a config file that is uploaded to the servers on each deployment. Returns the config file.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `body` (`string`, required): File contents. Example: production:
  host: db.internal.
- `path` (`string`, required): Path the file is written to on the server, relative to the deployment path. Example: config/database.yml.
- `project_id` (`string`, required): Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.
- `build` (`boolean`, optional): Also write the file in the build environment. Example: false.
- `description` (`string`, optional): Description. Example: Production database settings.

Example input: `{"body":"<body>","path":"<path>","project_id":"<project_id>"}`

### `deployhq_config_file_update`

Update Config File · Write

Update a config file of a project. Returns the config file.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Identifier of the config file. Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890.
- `project_id` (`string`, required): Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.
- `body` (`string`, optional): File contents. Example: production:
  host: db.internal.
- `build` (`boolean`, optional): Also write the file in the build environment. Example: false.
- `description` (`string`, optional): Description. Example: Production database settings.
- `path` (`string`, optional): Path the file is written to on the server, relative to the deployment path. Example: config/database.yml.

Example input: `{"id":"<id>","project_id":"<project_id>"}`

### `deployhq_deployment_abort`

Abort Deployment · Write

Abort a running deployment. Returns the deployment.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `id` (`string`, required): Identifier of the deployment. Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890.
- `project_id` (`string`, required): Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.

Example input: `{"id":"<id>","project_id":"<project_id>"}`

### `deployhq_deployment_create`

Deploy or Preview · Write

Queue a deployment of a revision range to a server or server group, or create a preview of the changes without deploying (mode preview). Returns the deployment with its identifier and status. Use deployhq_deployment_get to follow it.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `parent_identifier` (`string`, required): Identifier of the server or server group, from deployhq_servers_list or deployhq_server_groups_list. Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890.
- `project_id` (`string`, required): Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.
- `branch` (`string`, optional): Branch to deploy. Example: main.
- `copy_config_files` (`boolean`, optional): Upload the project's config files. Example: true.
- `end_revision` (`string`, optional): Commit to deploy up to. Leave empty with use_latest true to deploy the latest commit. Example: 4f2a9c1e8b7d6a5f4e3d2c1b0a9f8e7d6c5b4a39.
- `mode` (`string`, optional): queue to deploy now, preview to see the changes without deploying. Example: queue. One of: `queue`, `preview`.
- `notification_addresses` (`string`, optional): Extra email addresses to notify, comma-separated. Example: ops@example.com.
- `run_build_commands` (`boolean`, optional): Run the build pipeline. Example: true.
- `skip_if_not_changes` (`boolean`, optional): Skip the deployment when there are no changes. Example: false.
- `start_revision` (`string`, optional): Commit to deploy from; defaults to the server's last deployed revision. Example: 1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b.
- `use_build_cache` (`boolean`, optional): Use the build cache. Example: true.
- `use_latest` (`boolean`, optional): Deploy the latest commit of the branch. Example: true.

Example input: `{"parent_identifier":"<parent_identifier>","project_id":"<project_id>"}`

### `deployhq_deployment_retry`

Retry Deployment · Write

Retry a failed deployment. Returns the new deployment.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `id` (`string`, required): Identifier of the deployment. Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890.
- `project_id` (`string`, required): Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.

Example input: `{"id":"<id>","project_id":"<project_id>"}`

### `deployhq_deployment_rollback`

Roll Back Deployment · Write

Roll the servers of a deployment back to the revision before it, or preview the rollback. Returns the rollback deployment.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `id` (`string`, required): Identifier of the deployment. Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890.
- `project_id` (`string`, required): Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.
- `copy_config_files` (`boolean`, optional): Copy config files during the rollback (default true). Example: true.
- `mode` (`string`, optional): preview to preview the rollback, queue to run it now (default). Example: queue. One of: `queue`, `preview`.
- `run_build_commands` (`boolean`, optional): Run build commands during the rollback (default true). Example: true.

Example input: `{"id":"<id>","project_id":"<project_id>"}`

### `deployhq_environment_variable_create`

Create Environment Variable · Write

Add an environment variable to a project. Returns the variable.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `name` (`string`, required): Variable name. Example: API_URL.
- `project_id` (`string`, required): Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.
- `value` (`string`, required): Variable value. Example: https://api.example.com.
- `build_pipeline` (`boolean`, optional): Also expose it to build commands. Example: true.
- `locked` (`boolean`, optional): Hide the value after saving. Example: false.

Example input: `{"name":"<name>","project_id":"<project_id>","value":"<value>"}`

### `deployhq_environment_variable_update`

Update Environment Variable · Write

Update an environment variable of a project. Returns the variable.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Identifier of the environment variable. Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890.
- `project_id` (`string`, required): Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.
- `build_pipeline` (`boolean`, optional): Also expose it to build commands. Example: true.
- `locked` (`boolean`, optional): Hide the value after saving. Example: false.
- `name` (`string`, optional): Variable name. Example: API_URL.
- `value` (`string`, optional): Variable value. Example: https://api.example.com.

Example input: `{"id":"<id>","project_id":"<project_id>"}`

### `deployhq_excluded_file_create`

Add Excluded File · Write

Exclude a file or pattern from deployments. Returns the excluded file.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `path` (`string`, required): Path or glob pattern to exclude. Example: node_modules/**.
- `project_id` (`string`, required): Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.

Example input: `{"path":"<path>","project_id":"<project_id>"}`

### `deployhq_project_create`

Create Project · Write

Create a project, optionally from a template or in a zone. Returns the new project with its permalink and public SSH key. Use deployhq_repository_update and deployhq_server_create to finish setup.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `name` (`string`, required): Project name. Example: My Website.
- `template_id` (`string`, optional): Identifier of a template to pre-populate servers, config files and settings. Example: wordpress-template.
- `zone_id` (`string`, optional): ID of the deployment zone, from deployhq_zones_list. Example: 3.

Example input: `{"name":"<name>"}`

### `deployhq_project_update`

Update Project · Write

Update a project's name, permalink, zone, notification settings or AI overview instructions. Returns the updated project.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Permalink (identifier) of the project. Example: my-website.
- `ai_overview_custom_instructions` (`string`, optional): Instructions for the AI deployment overview. Example: Highlight database migrations.
- `email_notify_on` (`string`, optional): When to email notifications, e.g. never, failure or always. Example: failure.
- `name` (`string`, optional): Project name. Example: My Website.
- `notification_email` (`string`, optional): Email address for deployment notifications. Example: ops@example.com.
- `notify_committer` (`boolean`, optional): Also notify the committer of the deployed changes. Example: true.
- `permalink` (`string`, optional): New permalink (URL identifier). Example: my-website-2.
- `zone_id` (`string`, optional): ID of the deployment zone. Example: 3.

Example input: `{"id":"<id>"}`

### `deployhq_repository_update`

Update Repository · Write

Change the default branch, root path or hosting service of a project's repository. Returns the repository.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `project_id` (`string`, required): Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.
- `branch` (`string`, optional): Default branch to deploy. Example: main.
- `hosting_service_type` (`string`, optional): Hosting service, e.g. github, gitlab or bitbucket. Example: github.
- `root_path` (`string`, optional): Subdirectory of the repository to deploy. Example: public.

Example input: `{"project_id":"<project_id>"}`

### `deployhq_scheduled_deployment_create`

Schedule Deployment · Write

Schedule a deployment to a server once in the future or on a recurring frequency. Returns the scheduled deployment.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `frequency` (`string`, required): How often: future (once), daily, weekly, monthly or custom (cron schedule). Example: daily.
- `project_id` (`string`, required): Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.
- `server_identifier` (`string`, required): Identifier of the server or server group, from deployhq_servers_list or deployhq_server_groups_list. Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890.
- `at` (`string`, optional): Time of day to deploy, HH:MM. Example: 02:30.
- `copy_config_files` (`boolean`, optional): Upload config files. Example: true.
- `day` (`integer`, optional): Day of the month (monthly, or a one-off date). Example: 15.
- `month` (`integer`, optional): Month of a one-off date. Example: 6.
- `run_build_commands` (`boolean`, optional): Run the build pipeline. Example: true.
- `schedule` (`string`, optional): Cron expression for custom schedules. Example: 0 3 * * 1-5.
- `skip_if_not_changes` (`boolean`, optional): Skip when there are no changes. Example: true.
- `use_latest` (`boolean`, optional): Deploy the latest commit at run time. Example: true.
- `weekday` (`string`, optional): Day of the week for weekly schedules. Example: monday.
- `year` (`integer`, optional): Year of a one-off date. Example: 2026.

Example input: `{"frequency":"<frequency>","project_id":"<project_id>","server_identifier":"<server_identifier>"}`

### `deployhq_server_create`

Create Server · Write

Add an SSH/SFTP, FTP/FTPS or Amazon S3 deployment target to a project. SSH needs hostname and username; FTP also needs password; S3 needs bucket_name, access_key_id and secret_access_key. Returns the new server with its identifier.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `name` (`string`, required): Server name. Example: production-web-01.
- `project_id` (`string`, required): Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.
- `protocol_type` (`string`, required): Connection protocol: ssh (SSH/SFTP), ftp, ftps or s3. Example: ssh. One of: `ssh`, `ftp`, `ftps`, `s3`.
- `access_key_id` (`string`, optional): AWS access key ID (S3). Example: AKIAIOSFODNN7EXAMPLE.
- `auto_deploy` (`boolean`, optional): Deploy automatically on push. Example: true.
- `branch` (`string`, optional): Branch to deploy to this server. Example: main.
- `bucket_name` (`string`, optional): S3 bucket name. Example: my-site-bucket.
- `email_notify_on` (`string`, optional): When to email notifications for this server: never, failure or always. Example: failure. One of: `never`, `failure`, `always`.
- `enabled` (`boolean`, optional): Whether the server receives deployments. Example: true.
- `environment` (`string`, optional): Environment label, e.g. production or staging. Example: production.
- `hostname` (`string`, optional): Host name or IP of the server (SSH, FTP). Example: example.com.
- `notification_email` (`string`, optional): Email address for notifications. Example: ops@example.com.
- `password` (`string`, optional): Password (FTP, or SSH without key). Example: s3cret.
- `port` (`integer`, optional): Port, e.g. 22 for SSH or 21 for FTP. Example: 22.
- `root_path` (`string`, optional): Subdirectory of the repository to deploy from. Example: public.
- `secret_access_key` (`string`, optional): AWS secret access key (S3). Example: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY.
- `server_group_identifier` (`string`, optional): Identifier of the server group to put the server in. Example: web-servers.
- `server_path` (`string`, optional): Path on the server to deploy to. Example: /var/www/app.
- `use_ssh_keys` (`boolean`, optional): Authenticate SSH with the project's key pair instead of a password. Example: true.
- `username` (`string`, optional): Login user name (SSH, FTP). Example: deploy.

Example input: `{"name":"<name>","project_id":"<project_id>","protocol_type":"ssh"}`

### `deployhq_server_update`

Update Server · Write

Update the fields you pass on a server. Returns the updated server.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Identifier of the server. Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890.
- `project_id` (`string`, required): Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.
- `auto_deploy` (`boolean`, optional): Deploy automatically on push. Example: true.
- `branch` (`string`, optional): Branch to deploy to this server. Example: main.
- `email_notify_on` (`string`, optional): When to email notifications for this server: never, failure or always. Example: failure. One of: `never`, `failure`, `always`.
- `enabled` (`boolean`, optional): Whether the server receives deployments. Example: true.
- `environment` (`string`, optional): Environment label, e.g. production or staging. Example: production.
- `name` (`string`, optional): Server name. Example: production-web-01.
- `notification_email` (`string`, optional): Email address for notifications. Example: ops@example.com.
- `root_path` (`string`, optional): Subdirectory of the repository to deploy from. Example: public.
- `server_group_identifier` (`string`, optional): Identifier of the server group to put the server in. Example: web-servers.
- `server_path` (`string`, optional): Path on the server to deploy to. Example: /var/www/app.

Example input: `{"id":"<id>","project_id":"<project_id>"}`

### `deployhq_ssh_command_create`

Create SSH Command · Write

Add an SSH command that runs on the servers before or after each deployment. Returns the command.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `command` (`string`, required): Shell command to run on the servers. Example: touch tmp/restart.txt.
- `description` (`string`, required): Description of the command. Example: Restart the application.
- `project_id` (`string`, required): Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.
- `timeout` (`integer`, required): Timeout in seconds: 300, 600, 1800, 3600, 5400 or 10800. Example: 300.
- `timing` (`string`, required): Which deployments run it: all, first (only the first deployment to a server) or after_first. Example: all. One of: `all`, `first`, `after_first`.
- `cback` (`string`, optional): Deployment stage: before_changes (default, before files change), before_symlink (zero-downtime deployments, before the release goes live) or after_changes. Example: after_changes. One of: `before_changes`, `before_symlink`, `after_changes`.
- `enabled` (`boolean`, optional): Whether the command runs. Example: true.
- `halt_on_error` (`boolean`, optional): Stop the deployment if the command fails. Example: true.

Example input: `{"command":"<command>","description":"<description>","project_id":"<project_id>","timeout":300,"timing":"all"}`

### `deployhq_ssh_command_update`

Update SSH Command · Write

Update an SSH command of a project. Returns the command.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Identifier of the SSH command. Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890.
- `project_id` (`string`, required): Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.
- `cback` (`string`, optional): Deployment stage: before_changes (default, before files change), before_symlink (zero-downtime deployments, before the release goes live) or after_changes. Example: after_changes. One of: `before_changes`, `before_symlink`, `after_changes`.
- `command` (`string`, optional): Shell command to run on the servers. Example: touch tmp/restart.txt.
- `description` (`string`, optional): Description of the command. Example: Restart the application.
- `enabled` (`boolean`, optional): Whether the command runs. Example: true.
- `halt_on_error` (`boolean`, optional): Stop the deployment if the command fails. Example: true.
- `timeout` (`integer`, optional): Timeout in seconds: 300, 600, 1800, 3600, 5400 or 10800. Example: 300.
- `timing` (`string`, optional): Which deployments run it: all, first (only the first deployment to a server) or after_first. Example: all. One of: `all`, `first`, `after_first`.

Example input: `{"id":"<id>","project_id":"<project_id>"}`

### `deployhq_test_access_run`

Run Server Access Test · Write

Start a connection test from DeployHQ to every server of the project. Returns the test with its identifier; read results with deployhq_test_access_get.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `project_id` (`string`, required): Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.

Example input: `{"project_id":"<project_id>"}`

### `deployhq_build_command_delete`

Delete Build Command · Destructive

Delete a build command from a project.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Identifier of the build command. Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890.
- `project_id` (`string`, required): Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.

Example input: `{"id":"<id>","project_id":"<project_id>"}`

### `deployhq_config_file_delete`

Delete Config File · Destructive

Delete a config file from a project.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Identifier of the config file. Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890.
- `project_id` (`string`, required): Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.

Example input: `{"id":"<id>","project_id":"<project_id>"}`

### `deployhq_environment_variable_delete`

Delete Environment Variable · Destructive

Delete an environment variable from a project.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Identifier of the environment variable. Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890.
- `project_id` (`string`, required): Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.

Example input: `{"id":"<id>","project_id":"<project_id>"}`

### `deployhq_excluded_file_delete`

Delete Excluded File · Destructive

Stop excluding a file or pattern.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Identifier of the excluded file. Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890.
- `project_id` (`string`, required): Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.

Example input: `{"id":"<id>","project_id":"<project_id>"}`

### `deployhq_project_delete`

Delete Project · Destructive

Delete a project with its servers, deployments and settings. This cannot be undone.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Permalink (identifier) of the project. Example: my-website.

Example input: `{"id":"<id>"}`

### `deployhq_scheduled_deployment_delete`

Cancel Scheduled Deployment · Destructive

Cancel a scheduled deployment.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Identifier of the scheduled deployment. Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890.
- `project_id` (`string`, required): Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.

Example input: `{"id":"<id>","project_id":"<project_id>"}`

### `deployhq_server_delete`

Delete Server · Destructive

Delete a server from a project.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Identifier of the server. Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890.
- `project_id` (`string`, required): Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.

Example input: `{"id":"<id>","project_id":"<project_id>"}`

### `deployhq_ssh_command_delete`

Delete SSH Command · Destructive

Delete an SSH command from a project.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): Identifier of the SSH command. Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890.
- `project_id` (`string`, required): Permalink (identifier) of the project, as returned by deployhq_projects_list. Example: my-website.

Example input: `{"id":"<id>","project_id":"<project_id>"}`

## Related

Other Developer Tools connectors ([all 200](/agentkit/connectors/?category=developer-tools)):

- [GitHub](/agentkit/connectors/github/): Scalekit connector, OAuth, 217 tools
- [Datadog](/agentkit/connectors/datadog/): Scalekit connector, API key, 105 tools
- [Linear](/agentkit/connectors/linear/): Scalekit connector, OAuth, 64 tools


---

## More Scalekit documentation

| Resource | What it contains | When to use it |
|----------|-----------------|----------------|
| [/llms.txt](/llms.txt) | Structured index with routing hints per product area | Start here — find which documentation set covers your topic before loading full content |
| [/llms-full.txt](/llms-full.txt) | Complete documentation for all Scalekit products in one file | Use when you need exhaustive context across multiple products or when the topic spans several areas |
| [sitemap-0.xml](https://docs.scalekit.com/sitemap-0.xml) | Full URL list of every documentation page | Use to discover specific page URLs you can fetch for targeted, page-level answers |
