--- title: "POST /api/v2/constrainttemplates" method: POST path: "/api/v2/constrainttemplates" tags: ["constrainttemplates"] --- # POST /api/v2/constrainttemplates `POST /api/v2/constrainttemplates` ## Request - The document declares no server URL. - Auth: API key in header `Authorization` - TypeScript: (a function with typed inputs; its response is checked against the schema) Create constraint template ## Request body - CtBody - `name` string: Name of the constraint template - `spec` ConstraintTemplateSpec: ConstraintTemplateSpec is the object representing the gatekeeper constraint template spec and kubermatic related spec - `crd` CRD - `spec` CRDSpec - `names` Names - `kind` string - `shortNames` string[] - `validation` Validation - `legacySchema` boolean: +kubebuilder:default=true - `openAPIV3Schema` JSONSchemaProps - `$ref` string - `$schema` string - `additionalItems` JSONSchemaPropsOrBool: Defaults to true for the boolean property. - … - `additionalProperties` JSONSchemaPropsOrBool: Defaults to true for the boolean property. - … - `allOf` JSONSchemaProps[] - `anyOf` JSONSchemaProps[] - `default` JSON: These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil. - … - `definitions` JSONSchemaDefinitions - `dependencies` JSONSchemaDependencies - `description` string - `enum` JSON[] - … - `example` JSON: These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil. - … - `exclusiveMaximum` boolean - `exclusiveMinimum` boolean - `externalDocs` ExternalDocumentation - … - `format` string: format is an OpenAPI v3 format string. Unknown formats are ignored. The following formats are validated: bsonobjectid: a bson object ID, i.e. a 24 characters hex string uri: an URI as parsed by Golang net/url.ParseRequestURI email: an email address as parsed by Golang net/mail.ParseAddress hostname: a valid representation for an Internet host name, as defined by RFC 1034, section 3.1 [RFC1034]. ipv4: an IPv4 IP as parsed by Golang net.ParseIP ipv6: an IPv6 IP as parsed by Golang net.ParseIP cidr: a CIDR as parsed by Golang net.ParseCIDR mac: a MAC address as parsed by Golang net.ParseMAC uuid: an UUID that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$ uuid3: an UUID3 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?3[0-9a-f]{3}-?[0-9a-f]{4}-?[0-9a-f]{12}$ uuid4: an UUID4 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?4[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$ uuid5: an UUID5 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?5[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$ isbn: an ISBN10 or ISBN13 number string like "0321751043" or "978-0321751041" isbn10: an ISBN10 number string like "0321751043" isbn13: an ISBN13 number string like "978-0321751041" creditcard: a credit card number defined by the regex ^(?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|6(?:011|5[0-9][0-9])[0-9]{12}|3[47][0-9]{13}|3(?:0[0-5]|[68][0-9])[0-9]{11}|(?:2131|1800|35\\d{3})\\d{11})$ with any non digit characters mixed in ssn: a U.S. social security number following the regex ^\\d{3}[- ]?\\d{2}[- ]?\\d{4}$ hexcolor: an hexadecimal color code like "#FFFFFF: following the regex ^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$ rgbcolor: an RGB color code like rgb like "rgb(255,255,2559" byte: base64 encoded binary data password: any kind of string date: a date string like "2006-01-02" as defined by full-date in RFC3339 duration: a duration string like "22 ns" as parsed by Golang time.ParseDuration or compatible with Scala duration format datetime: a date time string like "2014-12-15T19:30:20.000Z" as defined by date-time in RFC3339. - `id` string - `items` JSONSchemaPropsOrArray: JSONSchemaPropsOrArray represents a value that can either be a JSONSchemaProps or an array of JSONSchemaProps. Mainly here for serialization purposes. - … - `maxItems` integer - `maxLength` integer - `maxProperties` integer - `maximum` number, double - `minItems` integer - `minLength` integer - `minProperties` integer - `minimum` number, double - `multipleOf` number, double - `not` JSONSchemaProps (recursive) - `nullable` boolean - `oneOf` JSONSchemaProps[] - `pattern` string - `patternProperties` object - `properties` object - `required` string[] - `title` string - `type` string - `uniqueItems` boolean - `x-kubernetes-embedded-resource` boolean: x-kubernetes-embedded-resource defines that the value is an embedded Kubernetes runtime.Object, with TypeMeta and ObjectMeta. The type must be object. It is allowed to further restrict the embedded object. kind, apiVersion and metadata are validated automatically. x-kubernetes-preserve-unknown-fields is allowed to be true, but does not have to be if the object is fully specified (up to kind, apiVersion, metadata). - `x-kubernetes-int-or-string` boolean: x-kubernetes-int-or-string specifies that this value is either an integer or a string. If this is true, an empty type is allowed and type as child of anyOf is permitted if following one of the following patterns: 1) anyOf: type: integer type: string 2) allOf: anyOf: type: integer type: string ... zero or more - `x-kubernetes-list-map-keys` string[]: x-kubernetes-list-map-keys annotates an array with the x-kubernetes-list-type `map` by specifying the keys used as the index of the map. This tag MUST only be used on lists that have the "x-kubernetes-list-type" extension set to "map". Also, the values specified for this attribute must be a scalar typed field of the child structure (no nesting is supported). The properties specified must either be required or have a default value, to ensure those properties are present for all list items. +optional - `x-kubernetes-list-type` string: x-kubernetes-list-type annotates an array to further describe its topology. This extension must only be used on lists and may have 3 possible values: 1) `atomic`: the list is treated as a single entity, like a scalar. Atomic lists will be entirely replaced when updated. This extension may be used on any type of list (struct, scalar, ...). 2) `set`: Sets are lists that must not have multiple items with the same value. Each value must be a scalar, an object with x-kubernetes-map-type `atomic` or an array with x-kubernetes-list-type `atomic`. 3) `map`: These lists are like maps in that their elements have a non-index key used to identify them. Order is preserved upon merge. The map tag must only be used on a list with elements of type object. Defaults to atomic for arrays. +optional - `x-kubernetes-map-type` string: x-kubernetes-map-type annotates an object to further describe its topology. This extension must only be used when type is object and may have 2 possible values: 1) `granular`: These maps are actual maps (key-value pairs) and each fields are independent from each other (they can each be manipulated by separate actors). This is the default behaviour for all maps. 2) `atomic`: the list is treated as a single entity, like a scalar. Atomic maps will be entirely replaced when updated. +optional - `x-kubernetes-preserve-unknown-fields` boolean: x-kubernetes-preserve-unknown-fields stops the API server decoding step from pruning fields which are not specified in the validation schema. This affects fields recursively, but switches back to normal pruning behaviour if nested properties or additionalProperties are specified in the schema. This can either be true or undefined. False is forbidden. - `selector` ConstraintTemplateSelector: ConstraintTemplateSelector is the object holding the cluster selection filters - `labelSelector` LabelSelector: A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. +structType=atomic - `matchExpressions` LabelSelectorRequirement[]: matchExpressions is a list of label selector requirements. The requirements are ANDed. +optional - `key` string: key is the label key that the selector applies to. +patchMergeKey=key +patchStrategy=merge - `operator` string - `values` string[]: values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. +optional - `matchLabels` object: matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. +optional - `providers` string[]: Providers is a list of cloud providers to which the Constraint Template applies to. Empty means all providers are selected. - `targets` Target[] - `libs` string[] - `rego` string - `target` string ## Response `200` ConstraintTemplate - ConstraintTemplate: ConstraintTemplate represents a gatekeeper ConstraintTemplate - `name` string - `spec` ConstraintTemplateSpec: ConstraintTemplateSpec is the object representing the gatekeeper constraint template spec and kubermatic related spec - `crd` CRD - `spec` CRDSpec - `names` Names - `kind` string - `shortNames` string[] - `validation` Validation - `legacySchema` boolean: +kubebuilder:default=true - `openAPIV3Schema` JSONSchemaProps - `$ref` string - `$schema` string - `additionalItems` JSONSchemaPropsOrBool: Defaults to true for the boolean property. - … - `additionalProperties` JSONSchemaPropsOrBool: Defaults to true for the boolean property. - … - `allOf` JSONSchemaProps[] - `anyOf` JSONSchemaProps[] - `default` JSON: These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil. - … - `definitions` JSONSchemaDefinitions - `dependencies` JSONSchemaDependencies - `description` string - `enum` JSON[] - … - `example` JSON: These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil. - … - `exclusiveMaximum` boolean - `exclusiveMinimum` boolean - `externalDocs` ExternalDocumentation - … - `format` string: format is an OpenAPI v3 format string. Unknown formats are ignored. The following formats are validated: bsonobjectid: a bson object ID, i.e. a 24 characters hex string uri: an URI as parsed by Golang net/url.ParseRequestURI email: an email address as parsed by Golang net/mail.ParseAddress hostname: a valid representation for an Internet host name, as defined by RFC 1034, section 3.1 [RFC1034]. ipv4: an IPv4 IP as parsed by Golang net.ParseIP ipv6: an IPv6 IP as parsed by Golang net.ParseIP cidr: a CIDR as parsed by Golang net.ParseCIDR mac: a MAC address as parsed by Golang net.ParseMAC uuid: an UUID that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$ uuid3: an UUID3 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?3[0-9a-f]{3}-?[0-9a-f]{4}-?[0-9a-f]{12}$ uuid4: an UUID4 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?4[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$ uuid5: an UUID5 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?5[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$ isbn: an ISBN10 or ISBN13 number string like "0321751043" or "978-0321751041" isbn10: an ISBN10 number string like "0321751043" isbn13: an ISBN13 number string like "978-0321751041" creditcard: a credit card number defined by the regex ^(?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|6(?:011|5[0-9][0-9])[0-9]{12}|3[47][0-9]{13}|3(?:0[0-5]|[68][0-9])[0-9]{11}|(?:2131|1800|35\\d{3})\\d{11})$ with any non digit characters mixed in ssn: a U.S. social security number following the regex ^\\d{3}[- ]?\\d{2}[- ]?\\d{4}$ hexcolor: an hexadecimal color code like "#FFFFFF: following the regex ^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$ rgbcolor: an RGB color code like rgb like "rgb(255,255,2559" byte: base64 encoded binary data password: any kind of string date: a date string like "2006-01-02" as defined by full-date in RFC3339 duration: a duration string like "22 ns" as parsed by Golang time.ParseDuration or compatible with Scala duration format datetime: a date time string like "2014-12-15T19:30:20.000Z" as defined by date-time in RFC3339. - `id` string - `items` JSONSchemaPropsOrArray: JSONSchemaPropsOrArray represents a value that can either be a JSONSchemaProps or an array of JSONSchemaProps. Mainly here for serialization purposes. - … - `maxItems` integer - `maxLength` integer - `maxProperties` integer - `maximum` number, double - `minItems` integer - `minLength` integer - `minProperties` integer - `minimum` number, double - `multipleOf` number, double - `not` JSONSchemaProps (recursive) - `nullable` boolean - `oneOf` JSONSchemaProps[] - `pattern` string - `patternProperties` object - `properties` object - `required` string[] - `title` string - `type` string - `uniqueItems` boolean - `x-kubernetes-embedded-resource` boolean: x-kubernetes-embedded-resource defines that the value is an embedded Kubernetes runtime.Object, with TypeMeta and ObjectMeta. The type must be object. It is allowed to further restrict the embedded object. kind, apiVersion and metadata are validated automatically. x-kubernetes-preserve-unknown-fields is allowed to be true, but does not have to be if the object is fully specified (up to kind, apiVersion, metadata). - `x-kubernetes-int-or-string` boolean: x-kubernetes-int-or-string specifies that this value is either an integer or a string. If this is true, an empty type is allowed and type as child of anyOf is permitted if following one of the following patterns: 1) anyOf: type: integer type: string 2) allOf: anyOf: type: integer type: string ... zero or more - `x-kubernetes-list-map-keys` string[]: x-kubernetes-list-map-keys annotates an array with the x-kubernetes-list-type `map` by specifying the keys used as the index of the map. This tag MUST only be used on lists that have the "x-kubernetes-list-type" extension set to "map". Also, the values specified for this attribute must be a scalar typed field of the child structure (no nesting is supported). The properties specified must either be required or have a default value, to ensure those properties are present for all list items. +optional - `x-kubernetes-list-type` string: x-kubernetes-list-type annotates an array to further describe its topology. This extension must only be used on lists and may have 3 possible values: 1) `atomic`: the list is treated as a single entity, like a scalar. Atomic lists will be entirely replaced when updated. This extension may be used on any type of list (struct, scalar, ...). 2) `set`: Sets are lists that must not have multiple items with the same value. Each value must be a scalar, an object with x-kubernetes-map-type `atomic` or an array with x-kubernetes-list-type `atomic`. 3) `map`: These lists are like maps in that their elements have a non-index key used to identify them. Order is preserved upon merge. The map tag must only be used on a list with elements of type object. Defaults to atomic for arrays. +optional - `x-kubernetes-map-type` string: x-kubernetes-map-type annotates an object to further describe its topology. This extension must only be used when type is object and may have 2 possible values: 1) `granular`: These maps are actual maps (key-value pairs) and each fields are independent from each other (they can each be manipulated by separate actors). This is the default behaviour for all maps. 2) `atomic`: the list is treated as a single entity, like a scalar. Atomic maps will be entirely replaced when updated. +optional - `x-kubernetes-preserve-unknown-fields` boolean: x-kubernetes-preserve-unknown-fields stops the API server decoding step from pruning fields which are not specified in the validation schema. This affects fields recursively, but switches back to normal pruning behaviour if nested properties or additionalProperties are specified in the schema. This can either be true or undefined. False is forbidden. - `selector` ConstraintTemplateSelector: ConstraintTemplateSelector is the object holding the cluster selection filters - `labelSelector` LabelSelector: A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. +structType=atomic - `matchExpressions` LabelSelectorRequirement[]: matchExpressions is a list of label selector requirements. The requirements are ANDed. +optional - `key` string: key is the label key that the selector applies to. +patchMergeKey=key +patchStrategy=merge - `operator` string - `values` string[]: values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. +optional - `matchLabels` object: matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. +optional - `providers` string[]: Providers is a list of cloud providers to which the Constraint Template applies to. Empty means all providers are selected. - `targets` Target[] - `libs` string[] - `rego` string - `target` string - `status` ConstraintTemplateStatus: ConstraintTemplateStatus defines the observed state of ConstraintTemplate - `byPod` ByPodStatus[] - `errors` CreateCRDError[] - `code` string - `location` string - `message` string - `id` string: a unique identifier for the pod that wrote the status - `observedGeneration` integer - `created` boolean ## Other responses - `401`: EmptyResponse is a empty response - `403`: EmptyResponse is a empty response - `default`: errorResponse --- [API](https://skmtc.dev/kubermatic/apis/kubermatic-kubernetes-platform-api.md) - [All operations](https://skmtc.dev/kubermatic/apis/kubermatic-kubernetes-platform-api/llms.txt) - [OpenAPI document](https://skmtc.dev/kubermatic/apis/kubermatic-kubernetes-platform-api/revisions/815b9bf19db5?raw)