Method: projects.deployments.create
Stay organized with collections
Save and categorize content based on your preferences.
Creates a deployment with the specified name and configuration.
HTTP request
POST https://gsuiteaddons.googleapis.com/v1/{parent=projects/*}/deployments
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
Required. Name of the project in which to create the deployment. Example: projects/my_project.
Authorization requires the following IAM permission on the specified resource parent:
gsuiteaddons.deployments.create
|
Query parameters
| Parameters |
deploymentId |
string
Required. The ID to use for this deployment. The full name of the created resource will be projects/<projectNumber>/deployments/<deploymentId>.
|
Request body
The request body contains an instance of Deployment.
Response body
If successful, the response body contains a newly created instance of Deployment.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authorization guide.
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-04-22 UTC.
[null,null,["Last updated 2025-04-22 UTC."],[[["\u003cp\u003eCreates a deployment with a specified name and configuration using an HTTP POST request.\u003c/p\u003e\n"],["\u003cp\u003eRequires \u003ccode\u003egsuiteaddons.deployments.create\u003c/code\u003e IAM permission and \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"],["\u003cp\u003eUtilizes path parameters for project specification and query parameters for deployment ID.\u003c/p\u003e\n"],["\u003cp\u003eRequest and response bodies contain instances of the \u003ccode\u003eDeployment\u003c/code\u003e resource, allowing configuration and retrieval of deployment details.\u003c/p\u003e\n"]]],["This outlines creating a deployment using a POST request to `https://gsuiteaddons.googleapis.com/v1/{parent=projects/*}/deployments`. It requires a `parent` path parameter specifying the project and a `deploymentId` query parameter. The request body defines the deployment's configuration, and a successful response returns a newly created deployment instance. Authorization requires the `gsuiteaddons.deployments.create` IAM permission and the `https://www.googleapis.com/auth/cloud-platform` OAuth scope.\n"],null,["# Method: projects.deployments.create\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nCreates a deployment with the specified name and configuration.\n\n### HTTP request\n\n`POST https://gsuiteaddons.googleapis.com/v1/{parent=projects/*}/deployments`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `parent` | `string` Required. Name of the project in which to create the deployment. Example: `projects/my_project`. Authorization requires the following [IAM](https://cloud.google.com/iam/docs/) permission on the specified resource `parent`: - `gsuiteaddons.deployments.create` |\n\n### Query parameters\n\n| Parameters ||\n|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `deploymentId` | `string` Required. The ID to use for this deployment. The full name of the created resource will be `projects/\u003cprojectNumber\u003e/deployments/\u003cdeploymentId\u003e`. |\n\n### Request body\n\nThe request body contains an instance of [Deployment](/workspace/add-ons/reference/rest/v1/projects.deployments#Deployment).\n\n### Response body\n\nIf successful, the response body contains a newly created instance of [Deployment](/workspace/add-ons/reference/rest/v1/projects.deployments#Deployment).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
