Actions181
- Account Actions
- Get Account
- Create Account
- Update Email
- Update Name
- Update Password
- Update Phone
- Update Status
- Get Preferences
- Update Preferences
- List Sessions
- Delete Sessions
- Get Session
- Update Session
- Delete Session
- Create Anonymous Session
- Create Email/Password Session
- Create Magic URL Session
- Create OAuth2 Session
- Create Phone Session
- Create Session from Token
- Create JWT
- Create Magic URL
- Create Phone Token
- Create Email Verification
- Update Email Verification
- Create Phone Verification
- Update Phone Verification
- Create Password Recovery
- Update Password Recovery
- Create Recovery
- Update Recovery
- Update MFA
- Create MFA Authenticator
- Update MFA Authenticator
- Delete MFA Authenticator
- Create MFA Challenge
- Update MFA Challenge
- Attribute Actions
- Avatars Actions
- Collection Actions
- Database Actions
- Document Actions
- Functions Actions
- Index Actions
- Locale Actions
- Messaging Actions
- Sites Actions
- Storage Actions
- Teams Actions
- Users Actions
Functions → Create Deployment
AI-generatedOverview
This node interacts with the Appwrite API to create a deployment for a specified function. It uploads a code archive (tar.gz) as a deployment, optionally specifying an entrypoint file and whether to activate the deployment automatically. This is useful for developers managing serverless functions in Appwrite, allowing them to deploy new versions of their functions programmatically within an automation workflow.
Use Case Examples
- Deploy a new version of a serverless function by uploading a tar.gz archive containing the function code.
- Automatically activate the deployment upon creation to make the new function version live immediately.
- Specify a custom entrypoint file for the deployment if different from the default function entrypoint.
Properties
| Name | Meaning |
|---|---|
| Function ID | The ID of the function to which the deployment belongs, required to identify the target function. |
| Deployment ID | The ID of the deployment, which can be generated uniquely using unique(). |
| Entrypoint | Optional entrypoint file for the deployment; if not specified, the function's default entrypoint is used. |
| Input Binary Field | Name of the input binary field containing the code archive (tar.gz) to be deployed, required to upload the function code. |
| Activate | Option to automatically activate the deployment upon creation, making it live immediately. |
Output
JSON
deploymentId- The unique identifier of the created deployment.functionId- The ID of the function associated with the deployment.entrypoint- The entrypoint file used for the deployment.activated- Boolean indicating whether the deployment is activated.status- The status of the deployment creation process.
Dependencies
- Appwrite API key credential for authentication
Troubleshooting
- Ensure the binary input field contains a valid tar.gz archive; otherwise, the deployment will fail.
- Verify that the Function ID is correct and exists in the Appwrite project to avoid errors.
- If the deployment ID is not unique, the operation may fail or overwrite an existing deployment.
- Check API key permissions to ensure the node can create deployments in the Appwrite project.
Links
- Appwrite Functions Deployments Documentation - Official documentation on managing function deployments in Appwrite.