Managing Deployments
Stay organized with collections
Save and categorize content based on your preferences.
This section provides an overview of the Apps Script API methods you can
use to create, list, read, modify, and delete a script project's
deployments.
| API method overview |
| Create a deployment |
projects.deployments.create
Results: Create a new deployment for a script project.
You specify the code version,
the manifest file, and
deployment description to use. Returns a
Deployment
object, containing the deployment configuration details.
|
| List a project's deployments |
projects.deployments.list
Results: Returns an array of
Deployment objects, each representing one of the
deployments of the script project.
|
| Read a deployment |
projects.deployments.get
Results: Returns a
Deployment that represents a specific deployment
in a specific script project.
|
| Update a deployment |
projects.deployments.update
Results: Changes a deployment's description, code
version, or the
manifest where the
deployment is defined.
|
| Delete a deployment |
projects.deployments.delete
Results: Removes a deployment.
Warning: Deleting a deployment causes
any add-on, web app, or other application that makes use of that
deployment to lose access to the Apps Script project, usually causing
them to fail. Do not delete a deployment without first updating any apps
that depend on it.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-28 UTC.
[null,null,["Last updated 2025-08-28 UTC."],[[["\u003cp\u003eThis section explains how to manage script project deployments using the Apps Script API.\u003c/p\u003e\n"],["\u003cp\u003eYou can create new deployments with specific code versions, manifests, and descriptions.\u003c/p\u003e\n"],["\u003cp\u003eThe API allows listing, reading, updating, and deleting existing deployments for a script project.\u003c/p\u003e\n"],["\u003cp\u003eUpdating a deployment involves modifying its description, version, or manifest.\u003c/p\u003e\n"],["\u003cp\u003eDeleting deployments can cause dependent add-ons or applications to fail, requiring caution.\u003c/p\u003e\n"]]],[],null,["# Managing Deployments\n\nThis section provides an overview of the Apps Script API methods you can\nuse to create, list, read, modify, and delete a script project's\n[deployments](/apps-script/concepts/deployments).\n\n| **API method overview** ||\n|----------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| **Create a deployment** | [projects.deployments.create](/apps-script/api/reference/rest/v1/projects.deployments/create) **Results** : Create a new deployment for a script project. You specify the code [version](/apps-script/guides/versions), the [manifest](/apps-script/concepts/manifests) file, and deployment description to use. Returns a [`Deployment`](/apps-script/api/reference/rest/v1/projects.deployments#resource-deployment) object, containing the deployment configuration details. |\n| **List a project's deployments** | [projects.deployments.list](/apps-script/api/reference/rest/v1/projects.deployments/list) **Results** : Returns an array of [`Deployment`](/apps-script/api/reference/rest/v1/projects.deployments#resource-deployment) objects, each representing one of the deployments of the script project. |\n| **Read a deployment** | [projects.deployments.get](/apps-script/api/reference/rest/v1/projects.deployments/get) **Results** : Returns a [`Deployment`](/apps-script/api/reference/rest/v1/projects.deployments#resource-deployment) that represents a specific deployment in a specific script project. |\n| **Update a deployment** | [projects.deployments.update](/apps-script/api/reference/rest/v1/projects.deployments/update) **Results** : Changes a deployment's description, code [version](/apps-script/guides/versions), or the [manifest](/apps-script/concepts/manifests) where the deployment is defined. |\n| **Delete a deployment** | [projects.deployments.delete](/apps-script/api/reference/rest/v1/projects.deployments/delete) **Results**: Removes a deployment. **Warning:** Deleting a deployment causes any add-on, web app, or other application that makes use of that deployment to lose access to the Apps Script project, usually causing them to fail. Do not delete a deployment without first updating any apps that depend on it. |"]]
