# Create Project Backup — ClickHelp

> Generates a backup of the specified project. This action ensures you have a safe copy of your project in case of any unpredicted data loss. See the documentation

- Key: `clickhelp-create-project-backup`
- Type: Action (Write)
- Version: 0.0.2
- App: ClickHelp (`clickhelp`) — https://pipedream.com/apps/clickhelp.md
- This page (HTML): https://pipedream.com/apps/clickhelp/actions/create-project-backup
- Hints: open-world
- Source: https://github.com/PipedreamHQ/pipedream/blob/master/components/clickhelp/actions/create-project-backup/create-project-backup.mjs

## Description

Generates a backup of the specified project. This action ensures you have a safe copy of your project in case of any unpredicted data loss. [See the documentation](https://clickhelp.com/software-documentation-tool/user-manual/api-create-project-backup.html)

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `projectId` | `string` | Yes | Identifier of a project Options are loaded from the connected account. |
| `outputFileName` | `string` | Yes | The full file name of the output file, including the file path that starts with Storage/. Example: Storage/Backups/Project-backup_2023-03-13_03-46-07.zip |
| `waitForCompletion` | `boolean` | No | Set to true to poll the API in 3-second intervals until the task is completed |

## Run it

**MCP**

```ts
import { Client } from "@modelcontextprotocol/sdk/client/index.js"
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js"
import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const accessToken = await pd.rawAccessToken

const transport = new StreamableHTTPClientTransport(
  new URL("https://remote.mcp.pipedream.net/v3"),
  {
    requestInit: {
      headers: {
        Authorization: `Bearer ${accessToken}`,
        "x-pd-project-id": process.env.PIPEDREAM_PROJECT_ID!,
        "x-pd-environment": "production",
        "x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
        "x-pd-app-slug": "clickhelp",
      },
    },
  },
)

const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)

const { tools } = await mcp.listTools()

// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
  name: "clickhelp-create-project-backup",
  arguments: {
    projectId: "Project ID",
    outputFileName: "Output File Name",
  },
})
```

**TypeScript**

```ts
import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "clickhelp-create-project-backup",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    clickhelp: { authProvisionId: "apn_xxxxxxx" },
    projectId: "Project ID",
    outputFileName: "Output File Name",
  },
})

console.log(result)
```

**cURL**

```bash
curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
  -H "Content-Type: application/json" \
  -H "X-PD-Environment: production" \
  -H "Authorization: Bearer {access_token}" \
  -d '{
    "external_user_id": "{external_user_id}",
    "id": "clickhelp-create-project-backup",
    "configured_props": {
      "clickhelp": { "authProvisionId": "apn_xxxxxxx" },
      "projectId": "Project ID",
      "outputFileName": "Output File Name"
    }
  }'
```

---

- App: https://pipedream.com/apps/clickhelp.md · All apps: https://pipedream.com/apps