View as Markdown
Documenterra icon

Documenterra ACTION

Create Project Backup

Creates a backup of a project. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Documenterra account once, then configure and run Create Project Backup from your backend or agent.

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: "documenterra-create-project-backup",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    documenterra: { authProvisionId: "apn_xxxxxxx" },
    projectId: "Project Identity",
    outputFileName: "Output File Name",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Create Project Backup inputs
Property Type Description
projectId Project Identity string
The unique identifier for the project.
Required Dynamic
outputFileName Output File Name string
The full file name, including the file path starting with Storage/ Eg. Storage/Backups/Project-backup_2023-03-13_03-46-07.zip
Required

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
documenterra-create-project-backup
Version
0.0.2
App
Documenterra
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes