apiVersion: networking.k8s.io/v1
import "k8s.io/api/networking/v1"
IngressClass 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/v1
kind: IngressClass
metadata (ObjectMeta)
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
spec (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-status
IngressClassSpec 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), required
Kind is the type of resource being referenced.
parameters.name (string), required
Name 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".
IngressClassList is a collection of IngressClasses.
apiVersion: networking.k8s.io/v1
kind: IngressClassList
metadata (ListMeta)
Standard list metadata.
items ([]IngressClass), required
Items is the list of IngressClasses.
get read the specified IngressClassGET /apis/networking.k8s.io/v1/ingressclasses/{name}
name (in path): string, required
name of the IngressClass
pretty (in query): string
200 (IngressClass): OK
401: Unauthorized
list list or watch objects of kind IngressClassGET /apis/networking.k8s.io/v1/ingressclasses
allowWatchBookmarks (in query): boolean
continue (in query): string
fieldSelector (in query): string
labelSelector (in query): string
limit (in query): integer
pretty (in query): string
resourceVersion (in query): string
resourceVersionMatch (in query): string
timeoutSeconds (in query): integer
watch (in query): boolean
200 (IngressClassList): OK
401: Unauthorized
create create an IngressClassPOST /apis/networking.k8s.io/v1/ingressclasses
body: IngressClass, required
dryRun (in query): string
fieldManager (in query): string
fieldValidation (in query): string
pretty (in query): string
200 (IngressClass): OK
201 (IngressClass): Created
202 (IngressClass): Accepted
401: Unauthorized
update replace the specified IngressClassPUT /apis/networking.k8s.io/v1/ingressclasses/{name}
name (in path): string, required
name of the IngressClass
body: IngressClass, required
dryRun (in query): string
fieldManager (in query): string
fieldValidation (in query): string
pretty (in query): string
200 (IngressClass): OK
201 (IngressClass): Created
401: Unauthorized
patch partially update the specified IngressClassPATCH /apis/networking.k8s.io/v1/ingressclasses/{name}
name (in path): string, required
name of the IngressClass
body: Patch, required
dryRun (in query): string
fieldManager (in query): string
fieldValidation (in query): string
force (in query): boolean
pretty (in query): string
200 (IngressClass): OK
201 (IngressClass): Created
401: Unauthorized
delete delete an IngressClassDELETE /apis/networking.k8s.io/v1/ingressclasses/{name}
name (in path): string, required
name of the IngressClass
body: DeleteOptions
dryRun (in query): string
gracePeriodSeconds (in query): integer
pretty (in query): string
propagationPolicy (in query): string
200 (Status): OK
202 (Status): Accepted
401: Unauthorized
deletecollection delete collection of IngressClassDELETE /apis/networking.k8s.io/v1/ingressclasses
body: DeleteOptions
continue (in query): string
dryRun (in query): string
fieldSelector (in query): string
gracePeriodSeconds (in query): integer
labelSelector (in query): string
limit (in query): integer
pretty (in query): string
propagationPolicy (in query): string
resourceVersion (in query): string
resourceVersionMatch (in query): string
timeoutSeconds (in query): integer
200 (Status): OK
401: Unauthorized
© 2022 The Kubernetes Authors
Documentation Distributed under CC BY 4.0.
https://kubernetes.io/docs/reference/kubernetes-api/service-resources/ingress-class-v1/