--- title: "PATCH /v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}" method: PATCH path: "/v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}" tags: ["projects"] --- # PATCH /v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId} `PATCH /v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}` ## Request - Base URL: `https://apihub.googleapis.com` - URL: `https://apihub.googleapis.com/v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}` - Auth: one of: - OAuth 2 and OAuth 2 - Implicit: `https://accounts.google.com/o/oauth2/auth` - Scopes: `https://www.googleapis.com/auth/apihub.readwrite` - Authorization code: `https://accounts.google.com/o/oauth2/auth` - Token URL: `https://accounts.google.com/o/oauth2/token` scopes: `https://www.googleapis.com/auth/apihub.readwrite` - OAuth 2 and OAuth 2 - Implicit: `https://accounts.google.com/o/oauth2/auth` - Scopes: `https://www.googleapis.com/auth/cloud-platform` - Authorization code: `https://accounts.google.com/o/oauth2/auth` - Token URL: `https://accounts.google.com/o/oauth2/token` scopes: `https://www.googleapis.com/auth/cloud-platform` - TypeScript: (a function with typed inputs; its response is checked against the schema) Update a deployment resource in the API hub. The following fields in the deployment resource can be updated: * display_name * description * documentation * deployment_type * resource_uri * endpoints * slo * environment * attributes * source_project * source_environment * management_url * source_uri The update_mask should be used to specify the fields being updated. ## Path parameters - `projectsId` string, required - `locationsId` string, required - `deploymentsId` string, required ## Query parameters - `updateMask` string, google-fieldmask ## Request body - GoogleCloudApihubV1Deployment: Details of the deployment where APIs are hosted. A deployment could represent an Apigee proxy, API gateway, other Google Cloud services or non-Google Cloud services as well. A deployment entity is a root level entity in the API hub and exists independent of any API. - `apiOperations` string[]: Output only. The API operations linked directly to this deployment. - `apiVersions` string[]: Output only. The API versions linked to this deployment. Note: A particular deployment could be linked to multiple different API versions (of same or different APIs). - `attributes` object: Optional. The list of user defined attributes associated with the deployment resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource. - `createTime` string, google-datetime: Output only. The time at which the deployment was created. - `deploymentType` GoogleCloudApihubV1AttributeValues: The attribute values associated with resource. - `attribute` string: Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} - `enumValues` GoogleCloudApihubV1EnumAttributeValues: The attribute values of data type enum. - `values` GoogleCloudApihubV1AllowedValue[]: Required. The attribute values in case attribute data type is enum. - `description` string: Optional. The detailed description of the allowed value. - `displayName` string: Required. The display name of the allowed value. - `id` string: Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 3-500 characters, and valid characters are /a-z[0-9]-_/. - `immutable` boolean: Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes. - `jsonValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `stringValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `uriValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `description` string: Optional. The description of the deployment. - `displayName` string: Required. The display name of the deployment. - `documentation` GoogleCloudApihubV1Documentation: Documentation details. - `externalUri` string: Optional. The uri of the externally hosted documentation. - `endpoints` string[]: Required. The endpoints at which this deployment resource is listening for API requests. This could be a list of complete URIs, hostnames or an IP addresses. - `environment` GoogleCloudApihubV1AttributeValues: The attribute values associated with resource. - `attribute` string: Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} - `enumValues` GoogleCloudApihubV1EnumAttributeValues: The attribute values of data type enum. - `values` GoogleCloudApihubV1AllowedValue[]: Required. The attribute values in case attribute data type is enum. - `description` string: Optional. The detailed description of the allowed value. - `displayName` string: Required. The display name of the allowed value. - `id` string: Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 3-500 characters, and valid characters are /a-z[0-9]-_/. - `immutable` boolean: Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes. - `jsonValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `stringValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `uriValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `managementUrl` GoogleCloudApihubV1AttributeValues: The attribute values associated with resource. - `attribute` string: Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} - `enumValues` GoogleCloudApihubV1EnumAttributeValues: The attribute values of data type enum. - `values` GoogleCloudApihubV1AllowedValue[]: Required. The attribute values in case attribute data type is enum. - `description` string: Optional. The detailed description of the allowed value. - `displayName` string: Required. The display name of the allowed value. - `id` string: Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 3-500 characters, and valid characters are /a-z[0-9]-_/. - `immutable` boolean: Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes. - `jsonValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `stringValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `uriValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `name` string: Identifier. The name of the deployment. Format: `projects/{project}/locations/{location}/deployments/{deployment}` - `resourceUri` string: Required. The resource URI identifies the deployment within its gateway. For Apigee gateways, its recommended to use the format: organizations/{org}/environments/{env}/apis/{api}. For ex: if a proxy with name `orders` is deployed in `staging` environment of `cymbal` organization, the resource URI would be: `organizations/cymbal/environments/staging/apis/orders`. - `slo` GoogleCloudApihubV1AttributeValues: The attribute values associated with resource. - `attribute` string: Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} - `enumValues` GoogleCloudApihubV1EnumAttributeValues: The attribute values of data type enum. - `values` GoogleCloudApihubV1AllowedValue[]: Required. The attribute values in case attribute data type is enum. - `description` string: Optional. The detailed description of the allowed value. - `displayName` string: Required. The display name of the allowed value. - `id` string: Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 3-500 characters, and valid characters are /a-z[0-9]-_/. - `immutable` boolean: Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes. - `jsonValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `stringValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `uriValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `sourceEnvironment` string: Optional. The environment at source for the deployment. For example: prod, dev, staging, etc. - `sourceMetadata` GoogleCloudApihubV1SourceMetadata[]: Output only. The list of sources and metadata from the sources of the deployment. - `originalResourceCreateTime` string, google-datetime: Output only. The time at which the resource was created at the source. - `originalResourceId` string: Output only. The unique identifier of the resource at the source. - `originalResourceUpdateTime` string, google-datetime: Output only. The time at which the resource was last updated at the source. - `pluginInstanceActionSource` GoogleCloudApihubV1PluginInstanceActionSource: PluginInstanceActionSource represents the plugin instance action source. - `actionId` string: Output only. The id of the plugin instance action. - `pluginInstance` string: Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}` - `sourceType` 'SOURCE_TYPE_UNSPECIFIED' | 'PLUGIN': Output only. The type of the source. - `sourceProject` string: Optional. The project to which the deployment belongs. For Google Cloud gateways, this will refer to the project identifier. For others like Edge/OPDK, this will refer to the org identifier. - `sourceRevision` string: Optional. A revision identifier for the underlying gateway configuration that this deployment serves. For Apigee gateway variants, this is typically the proxy revision number populated automatically when the deployment is discovered. - `sourceUri` GoogleCloudApihubV1AttributeValues: The attribute values associated with resource. - `attribute` string: Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} - `enumValues` GoogleCloudApihubV1EnumAttributeValues: The attribute values of data type enum. - `values` GoogleCloudApihubV1AllowedValue[]: Required. The attribute values in case attribute data type is enum. - `description` string: Optional. The detailed description of the allowed value. - `displayName` string: Required. The display name of the allowed value. - `id` string: Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 3-500 characters, and valid characters are /a-z[0-9]-_/. - `immutable` boolean: Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes. - `jsonValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `stringValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `uriValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `specs` string[]: Output only. The specs linked directly to this deployment. Note: a deployment could serve multiple specs (e.g., across different revisions of the same underlying gateway configuration). - `updateTime` string, google-datetime: Output only. The time at which the deployment was last updated. ## Response `200` Successful response - GoogleCloudApihubV1Deployment: Details of the deployment where APIs are hosted. A deployment could represent an Apigee proxy, API gateway, other Google Cloud services or non-Google Cloud services as well. A deployment entity is a root level entity in the API hub and exists independent of any API. - `apiOperations` string[]: Output only. The API operations linked directly to this deployment. - `apiVersions` string[]: Output only. The API versions linked to this deployment. Note: A particular deployment could be linked to multiple different API versions (of same or different APIs). - `attributes` object: Optional. The list of user defined attributes associated with the deployment resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource. - `createTime` string, google-datetime: Output only. The time at which the deployment was created. - `deploymentType` GoogleCloudApihubV1AttributeValues: The attribute values associated with resource. - `attribute` string: Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} - `enumValues` GoogleCloudApihubV1EnumAttributeValues: The attribute values of data type enum. - `values` GoogleCloudApihubV1AllowedValue[]: Required. The attribute values in case attribute data type is enum. - `description` string: Optional. The detailed description of the allowed value. - `displayName` string: Required. The display name of the allowed value. - `id` string: Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 3-500 characters, and valid characters are /a-z[0-9]-_/. - `immutable` boolean: Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes. - `jsonValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `stringValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `uriValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `description` string: Optional. The description of the deployment. - `displayName` string: Required. The display name of the deployment. - `documentation` GoogleCloudApihubV1Documentation: Documentation details. - `externalUri` string: Optional. The uri of the externally hosted documentation. - `endpoints` string[]: Required. The endpoints at which this deployment resource is listening for API requests. This could be a list of complete URIs, hostnames or an IP addresses. - `environment` GoogleCloudApihubV1AttributeValues: The attribute values associated with resource. - `attribute` string: Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} - `enumValues` GoogleCloudApihubV1EnumAttributeValues: The attribute values of data type enum. - `values` GoogleCloudApihubV1AllowedValue[]: Required. The attribute values in case attribute data type is enum. - `description` string: Optional. The detailed description of the allowed value. - `displayName` string: Required. The display name of the allowed value. - `id` string: Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 3-500 characters, and valid characters are /a-z[0-9]-_/. - `immutable` boolean: Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes. - `jsonValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `stringValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `uriValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `managementUrl` GoogleCloudApihubV1AttributeValues: The attribute values associated with resource. - `attribute` string: Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} - `enumValues` GoogleCloudApihubV1EnumAttributeValues: The attribute values of data type enum. - `values` GoogleCloudApihubV1AllowedValue[]: Required. The attribute values in case attribute data type is enum. - `description` string: Optional. The detailed description of the allowed value. - `displayName` string: Required. The display name of the allowed value. - `id` string: Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 3-500 characters, and valid characters are /a-z[0-9]-_/. - `immutable` boolean: Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes. - `jsonValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `stringValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `uriValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `name` string: Identifier. The name of the deployment. Format: `projects/{project}/locations/{location}/deployments/{deployment}` - `resourceUri` string: Required. The resource URI identifies the deployment within its gateway. For Apigee gateways, its recommended to use the format: organizations/{org}/environments/{env}/apis/{api}. For ex: if a proxy with name `orders` is deployed in `staging` environment of `cymbal` organization, the resource URI would be: `organizations/cymbal/environments/staging/apis/orders`. - `slo` GoogleCloudApihubV1AttributeValues: The attribute values associated with resource. - `attribute` string: Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} - `enumValues` GoogleCloudApihubV1EnumAttributeValues: The attribute values of data type enum. - `values` GoogleCloudApihubV1AllowedValue[]: Required. The attribute values in case attribute data type is enum. - `description` string: Optional. The detailed description of the allowed value. - `displayName` string: Required. The display name of the allowed value. - `id` string: Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 3-500 characters, and valid characters are /a-z[0-9]-_/. - `immutable` boolean: Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes. - `jsonValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `stringValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `uriValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `sourceEnvironment` string: Optional. The environment at source for the deployment. For example: prod, dev, staging, etc. - `sourceMetadata` GoogleCloudApihubV1SourceMetadata[]: Output only. The list of sources and metadata from the sources of the deployment. - `originalResourceCreateTime` string, google-datetime: Output only. The time at which the resource was created at the source. - `originalResourceId` string: Output only. The unique identifier of the resource at the source. - `originalResourceUpdateTime` string, google-datetime: Output only. The time at which the resource was last updated at the source. - `pluginInstanceActionSource` GoogleCloudApihubV1PluginInstanceActionSource: PluginInstanceActionSource represents the plugin instance action source. - `actionId` string: Output only. The id of the plugin instance action. - `pluginInstance` string: Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}` - `sourceType` 'SOURCE_TYPE_UNSPECIFIED' | 'PLUGIN': Output only. The type of the source. - `sourceProject` string: Optional. The project to which the deployment belongs. For Google Cloud gateways, this will refer to the project identifier. For others like Edge/OPDK, this will refer to the org identifier. - `sourceRevision` string: Optional. A revision identifier for the underlying gateway configuration that this deployment serves. For Apigee gateway variants, this is typically the proxy revision number populated automatically when the deployment is discovered. - `sourceUri` GoogleCloudApihubV1AttributeValues: The attribute values associated with resource. - `attribute` string: Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} - `enumValues` GoogleCloudApihubV1EnumAttributeValues: The attribute values of data type enum. - `values` GoogleCloudApihubV1AllowedValue[]: Required. The attribute values in case attribute data type is enum. - `description` string: Optional. The detailed description of the allowed value. - `displayName` string: Required. The display name of the allowed value. - `id` string: Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 3-500 characters, and valid characters are /a-z[0-9]-_/. - `immutable` boolean: Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes. - `jsonValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `stringValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `uriValues` GoogleCloudApihubV1StringAttributeValues: The attribute values of data type string or JSON. - `values` string[]: Required. The attribute values in case attribute data type is string or JSON. - `specs` string[]: Output only. The specs linked directly to this deployment. Note: a deployment could serve multiple specs (e.g., across different revisions of the same underlying gateway configuration). - `updateTime` string, google-datetime: Output only. The time at which the deployment was last updated. ## Changes - **2026-11-08** `09b6c7d2247b`: 4 info - the security scope `https://www.googleapis.com/auth/apihub.readwrite` was added to the endpoint's security scheme `Oauth2` - the security scope `https://www.googleapis.com/auth/apihub.readwrite` was added to the endpoint's security scheme `Oauth2c` - the security scope `https://www.googleapis.com/auth/cloud-platform` was removed from the endpoint's security scheme `Oauth2` - the security scope `https://www.googleapis.com/auth/cloud-platform` was removed from the endpoint's security scheme `Oauth2c` [Operation history](https://skmtc.dev/google/apis/apihub/changes/v1/projects/:projectsId/locations/:locationsId/deployments/:deploymentsId/patch.md) --- [API](https://skmtc.dev/google/apis/apihub.md) - [All operations](https://skmtc.dev/google/apis/apihub/llms.txt) - [OpenAPI document](https://skmtc.dev/google/apis/apihub/revisions/09b6c7d2247b?raw)