Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-132865105.6 KB
tagKeys

Creates a new TagKey. If another request with the same parameters is sent while the original request is in process, the second request will receive an error. A maximum of 1000 TagKeys can exist under a parent at any given time.

post/v3/tagKeys

Query parameters

validateOnlyboolean

Optional. Set to true to perform validations necessary for creating the resource, but not actually perform the action.

Request body

createTimestring google-datetime

Output only. Creation time.

namestring

Immutable. The resource name for a TagKey. Must be in the format tagKeys/{tag_key_id}, where tag_key_id is the generated numeric id for the TagKey.

updateTimestring google-datetime

Output only. Update time.

namespacedNamestring

Output only. Immutable. Namespaced name of the TagKey.

descriptionstring

Optional. User-assigned description of the TagKey. Must not exceed 256 characters. Read-write.

parentstring

Immutable. The resource name of the TagKey's parent. A TagKey can be parented by an Organization or a Project. For a TagKey parented by an Organization, its parent must be in the form organizations/{org_id}. For a TagKey parented by a Project, its parent can be in the form projects/{project_id} or projects/{project_number}.

etagstring

Optional. Entity tag which users can pass to prevent race conditions. This field is always set in server responses. See UpdateTagKeyRequest for details.

purpose'PURPOSE_UNSPECIFIED' | 'GCE_FIREWALL' | 'DATA_GOVERNANCE'

Optional. A purpose denotes that this Tag is intended for use in policies of a specific policy engine, and will involve that policy engine in management operations involving this Tag. A purpose does not grant a policy engine exclusive rights to the Tag, and it may be referenced by other policy engines. A purpose cannot be changed once set.

shortNamestring

Required. Immutable. The user friendly name for a TagKey. The short name should be unique for TagKeys within the same tag namespace. The short name must be 1-256 characters, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between.

allowedValuesRegexstring

Optional. Regular expression constraint for freeform tag values. If present, it implicitly allows freeform values (constrained by the regex).

purposeDataobject

Optional. Purpose data corresponds to the policy system that the tag is intended for. See documentation for Purpose for formatting of this field. Purpose data cannot be changed once set.

Response

Successful response