Skip to content
post

Create Deployment

Endpoint

posthttps://<REGION>.cloud.appwrite.io/v1/functions/{functionId}/deployments

Description

Create a new function code deployment. Use this endpoint to upload a new version of your code function. To execute your newly uploaded code, you'll need to update the function's deployment to use your new deployment UID.

This endpoint accepts a tar.gz file compressed with your code. Make sure to include any dependencies your code has within the compressed file. You can learn more about code packaging in the Appwrite Cloud Functions tutorial.

Use the "command" param to set the entry point used to execute your code.

Required scopes

functions.write

Authentication

Initialize the Appwrite client with setProject() and a server API key (setKey()). For direct REST calls, send X-Appwrite-Project and X-Appwrite-Key.

Path

string
Required

Function ID.

Body

string
Required

Entrypoint File.

string
Required

Gzip file with your code package. When used with the Appwrite CLI, pass the path to your code directory, and the CLI will automatically package your code. Use a path that is within the current directory.

boolean
Required

Automatically activate the deployment when it is finished building.

Status
Content type
201
application/json

Deployment

Name
Type
Description
string

Deployment ID.

integer

Deployment creation date in Unix timestamp.

integer

Deployment update date in Unix timestamp.

string

Resource ID.

string

Resource type.

string

The entrypoint file to use to execute the deployment code.

integer

The code size in bytes.

string

The current build ID.

boolean

Whether the deployment should be automatically activated.

string

The deployment status.

string

The build stdout.

string

The build stderr.

Python
from appwrite.client import Client
from appwrite.input_file import InputFile
from appwrite.services.functions import Functions


client = Client()


(client
  .set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
  .set_project('5df5acd0d48c2') # Your project ID
  .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
)


functions = Functions(client)


result = functions.create_deployment('[FUNCTION_ID]', '[ENTRYPOINT]', InputFile.from_path('file.png'), False)