v1

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

Updates metadata of an existing Secret.

patch/v1/{+name}

Path parameters

namestring required

Output only. The resource name of the Secret in the format projects/*/secrets/*.

Query parameters

updateMaskstring

Required. Specifies the fields to be updated.

Request body

tagsobject

Optional. Input only. Immutable. Mapping of Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" Tags are used to organize and group resources. Tags can be used to control policy evaluation for the resource.

expireTimestring google-datetime

Optional. Timestamp in UTC when the Secret is scheduled to expire. This is always provided on output, regardless of what was sent on input.

etagstring

Optional. Etag of the currently stored Secret.

versionDestroyTtlstring google-duration

Optional. Secret Version TTL after destruction request This is a part of the Delayed secret version destroy feature. For secret with TTL>0, version destruction doesn't happen immediately on calling destroy instead the version goes to a disabled state and destruction happens after the TTL expires.

annotationsobject

Optional. Custom metadata about the secret. Annotations are distinct from various forms of labels. Annotations exist to allow client tools to store their own state information without requiring a database. Annotation keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, begin and end with an alphanumeric character ([a-z0-9A-Z]), and may have dashes (-), underscores (_), dots (.), and alphanumerics in between these symbols. The total size of annotation keys and values must be less than 16KiB.

versionAliasesobject

Optional. Mapping from version alias to version name. A version alias is a string with a maximum length of 63 characters and can contain uppercase and lowercase letters, numerals, and the hyphen (-) and underscore ('_') characters. An alias string must start with a letter and cannot be the string 'latest' or 'NEW'. No more than 50 aliases can be assigned to a given secret. Version-Alias pairs will be viewable via GetSecret and modifiable via UpdateSecret. Access by alias is only be supported on GetSecretVersion and AccessSecretVersion.

labelsobject

The labels assigned to this Secret. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values must be between 0 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be assigned to a given resource.

ttlstring google-duration

Input only. The TTL for the Secret.

namestring

Output only. The resource name of the Secret in the format projects/*/secrets/*.

createTimestring google-datetime

Output only. The time at which the Secret was created.

secretType'SECRET_TYPE_UNSPECIFIED' | 'CLOUD_SQL_DB_CREDENTIALS' | 'ACCESS_KEY' | 'CERTIFICATE' | 'OTHER_DB_CREDENTIALS' | 'OTHER'

Optional. Immutable. This defines the type of the secret. Enforces certain structural requirements on the SecretVersions. For secret of type UNSPECIFIED, the SecretVersions can be of any type.

Response

Successful response