# IngressClass

IngressClassIngressClass represents the class of the Ingress, referenced by the Ingress Spec.apiVersion: networking.k8s.io/v1import "k8s.io/api/networking/v1"IngressClassIngressClass represents the class of the Ingress, referenced by the Ingress Spec. The ingressclass.kubernetes.io/is-default-class annotation can be used to indicate that an IngressClass should be considered default. When a single IngressClass resource has this annotation set to true, new Ingress resources without a class specified will be assigned this default class.apiVersion: networking.k8s.io/v1kind: IngressClassmetadata (ObjectMeta)Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadataspec (IngressClassSpec)spec is the desired state of the IngressClass. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-statusIngressClassSpecIngressClassSpec provides information about the class of an Ingress.controller (string)controller refers to the name of the controller that should handle this class. This allows for different "flavors" that are controlled by the same controller. For example, you may have different parameters for the same implementing controller. This should be specified as a domain-prefixed path no more than 250 characters in length, e.g. "acme.io/ingress-controller". This field is immutable.parameters (IngressClassParametersReference)parameters is a link to a custom resource containing additional configuration for the controller. This is optional if the controller does not require extra parameters.IngressClassParametersReference identifies an API object. This can be used to specify a cluster or namespace-scoped resource.parameters.kind (string), requiredkind is the type of resource being referenced.parameters.name (string), requiredname is the name of resource being referenced.parameters.apiGroup (string)apiGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.parameters.namespace (string)namespace is the namespace of the resource being referenced. This field is required when scope is set to "Namespace" and must be unset when scope is set to "Cluster".parameters.scope (string)scope represents if this refers to a cluster or namespace scoped resource. This may be set to "Cluster" (default) or "Namespace".IngressClassListIngressClassList is a collection of IngressClasses.apiVersion: networking.k8s.io/v1kind: IngressClassListmetadata (ListMeta)Standard list metadata.items ([]IngressClass), requireditems is the list of IngressClasses.Operationsget read the specified IngressClassHTTP RequestGET /apis/networking.k8s.io/v1/ingressclasses/{name}Parametersname (in path): string, requiredname of the IngressClasspretty (in query): stringprettyResponse200 (IngressClass): OK401: Unauthorizedlist list or watch objects of kind IngressClassHTTP RequestGET /apis/networking.k8s.io/v1/ingressclassesParametersallowWatchBookmarks (in query): booleanallowWatchBookmarkscontinue (in query): stringcontinuefieldSelector (in query): stringfieldSelectorlabelSelector (in query): stringlabelSelectorlimit (in query): integerlimitpretty (in query): stringprettyresourceVersion (in query): stringresourceVersionresourceVersionMatch (in query): stringresourceVersionMatchsendInitialEvents (in query): booleansendInitialEventstimeoutSeconds (in query): integertimeoutSecondswatch (in query): booleanwatchResponse200 (IngressClassList): OK401: Unauthorizedcreate create an IngressClassHTTP RequestPOST /apis/networking.k8s.io/v1/ingressclassesParametersbody: IngressClass, requireddryRun (in query): stringdryRunfieldManager (in query): stringfieldManagerfieldValidation (in query): stringfieldValidationpretty (in query): stringprettyResponse200 (IngressClass): OK201 (IngressClass): Created202 (IngressClass): Accepted401: Unauthorizedupdate replace the specified IngressClassHTTP RequestPUT /apis/networking.k8s.io/v1/ingressclasses/{name}Parametersname (in path): string, requiredname of the IngressClassbody: IngressClass, requireddryRun (in query): stringdryRunfieldManager (in query): stringfieldManagerfieldValidation (in query): stringfieldValidationpretty (in query): stringprettyResponse200 (IngressClass): OK201 (IngressClass): Created401: Unauthorizedpatch partially update the specified IngressClassHTTP RequestPATCH /apis/networking.k8s.io/v1/ingressclasses/{name}Parametersname (in path): string, requiredname of the IngressClassbody: Patch, requireddryRun (in query): stringdryRunfieldManager (in query): stringfieldManagerfieldValidation (in query): stringfieldValidationforce (in query): booleanforcepretty (in query): stringprettyResponse200 (IngressClass): OK201 (IngressClass): Created401: Unauthorizeddelete delete an IngressClassHTTP RequestDELETE /apis/networking.k8s.io/v1/ingressclasses/{name}Parametersname (in path): string, requiredname of the IngressClassbody: DeleteOptionsdryRun (in query): stringdryRungracePeriodSeconds (in query): integergracePeriodSecondsignoreStoreReadErrorWithClusterBreakingPotential (in query): booleanignoreStoreReadErrorWithClusterBreakingPotentialpretty (in query): stringprettypropagationPolicy (in query): stringpropagationPolicyResponse200 (Status): OK202 (Status): Accepted401: Unauthorizeddeletecollection delete collection of IngressClassHTTP RequestDELETE /apis/networking.k8s.io/v1/ingressclassesParametersbody: DeleteOptionscontinue (in query): stringcontinuedryRun (in query): stringdryRunfieldSelector (in query): stringfieldSelectorgracePeriodSeconds (in query): integergracePeriodSecondsignoreStoreReadErrorWithClusterBreakingPotential (in query): booleanignoreStoreReadErrorWithClusterBreakingPotentiallabelSelector (in query): stringlabelSelectorlimit (in query): integerlimitpretty (in query): stringprettypropagationPolicy (in query): stringpropagationPolicyresourceVersion (in query): stringresourceVersionresourceVersionMatch (in query): stringresourceVersionMatchsendInitialEvents (in query): booleansendInitialEventstimeoutSeconds (in query): integertimeoutSecondsResponse200 (Status): OK401: UnauthorizedThis page is automatically generated.If you plan to report an issue with this page, mention that the page is auto-generated in your issue description. The fix may need to happen elsewhere in the Kubernetes project.