Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13263478.2 KB
projects

Used to modify a specified deployment.

patch/v1/{+name}

Path parameters

namestring required

Resource name.

Query parameters

allowMissingboolean

If set to true, and the deployment is not found, a new deployment will be created. In this situation, update_mask is ignored.

updateMaskstring

The list of fields to be updated. If omitted, all fields are updated that are set in the request message (fields set to default values are ignored). If an asterisk "*" is specified, all fields are updated, including fields that are unspecified/default in the request.

Request body

descriptionstring

A detailed description.

labelsobject

Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with apigeeregistry.googleapis.com/ and cannot be changed.

revisionUpdateTimestring google-datetime

Output only. Last update timestamp: when the represented revision was last modified.

externalChannelUristring

The address of the external channel of the API (e.g., the Developer Portal). Changes to this value will not affect the revision.

displayNamestring

Human-meaningful name.

endpointUristring

The address where the deployment is serving. Changes to this value will update the revision.

namestring

Resource name.

apiSpecRevisionstring

The full resource name (including revision ID) of the spec of the API being served by the deployment. Changes to this value will update the revision. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec@revision}

createTimestring google-datetime

Output only. Creation timestamp; when the deployment resource was created.

accessGuidancestring

Text briefly describing how to access the endpoint. Changes to this value will not affect the revision.

intendedAudiencestring

Text briefly identifying the intended audience of the API. Changes to this value will not affect the revision.

annotationsobject

Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts.

revisionIdstring

Output only. Immutable. The revision ID of the deployment. A new revision is committed whenever the deployment contents are changed. The format is an 8-character hexadecimal string.

revisionCreateTimestring google-datetime

Output only. Revision creation timestamp; when the represented revision was created.

Response

Successful response