IngressClass

    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:

    • spec (IngressClassSpec)

      Spec is the desired state of the IngressClass. More info:

    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”. Field can be enabled with IngressClassNamespacedParams feature gate.

    IngressClassList is a collection of IngressClasses.

    • apiVersion: networking.k8s.io/v1

    • kind: IngressClassList

    • metadata (ListMeta)

      Standard list metadata.

    • items ([]), required

      Items is the list of IngressClasses.

    HTTP Request

    GET /apis/networking.k8s.io/v1/ingressclasses/{name}

    Parameters

    • name (in path): string, required

      name of the IngressClass

    • pretty (in query): string

      pretty

    Response

    200 (IngressClass): OK

    401: Unauthorized

    list list or watch objects of kind IngressClass

    HTTP Request

    GET /apis/networking.k8s.io/v1/ingressclasses

    Parameters

    • allowWatchBookmarks (in query): boolean

      allowWatchBookmarks

    • continue (in query): string

    • fieldSelector (in query): string

      fieldSelector

    • labelSelector (in query): string

    • limit (in query): integer

    • pretty (in query): string

      pretty

    • resourceVersion (in query): string

    • resourceVersionMatch (in query): string

      resourceVersionMatch

    • timeoutSeconds (in query): integer

    • watch (in query): boolean

      watch

    Response

    200 (IngressClassList): OK

    401: Unauthorized

    HTTP Request

    POST /apis/networking.k8s.io/v1/ingressclasses

    Parameters

    • body: , required

    • dryRun (in query): string

      dryRun

    • pretty (in query): string

    Response

    200 (): OK

    201 (IngressClass): Created

    202 (): Accepted

    401: Unauthorized

    update replace the specified IngressClass

    HTTP Request

    PUT /apis/networking.k8s.io/v1/ingressclasses/{name}

    Parameters

    • name (in path): string, required

      name of the IngressClass

    • body: , required

    • dryRun (in query): string

      dryRun

    • fieldManager (in query): string

    • pretty (in query): string

      pretty

    Response

    200 (IngressClass): OK

    201 (): Created

    401: Unauthorized

    HTTP Request

    PATCH /apis/networking.k8s.io/v1/ingressclasses/{name}

    Parameters

    • name (in path): string, required

      name of the IngressClass

    • body: Patch, required

    • dryRun (in query): string

    • fieldManager (in query): string

      fieldManager

    • pretty (in query): string

      pretty

    Response

    200 (IngressClass): OK

    201 (): Created

    401: Unauthorized

    delete an IngressClass

    HTTP Request

    DELETE /apis/networking.k8s.io/v1/ingressclasses/{name}

    Parameters

    • name (in path): string, required

      name of the IngressClass

    • body:

    • dryRun (in query): string

      dryRun

    • gracePeriodSeconds (in query): integer

    • pretty (in query): string

      pretty

    • propagationPolicy (in query): string

    Response

    200 (): OK

    202 (Status): Accepted

    401: Unauthorized

    HTTP Request

    DELETE /apis/networking.k8s.io/v1/ingressclasses

    Parameters

    • body:

    • continue (in query): string

      continue

    • dryRun (in query): string

    • fieldSelector (in query): string

      fieldSelector

    • gracePeriodSeconds (in query): integer

    • labelSelector (in query): string

      labelSelector

    • limit (in query): integer

    • pretty (in query): string

      pretty

    • propagationPolicy (in query): string

    • resourceVersion (in query): string

      resourceVersion

    • resourceVersionMatch (in query): string

    • timeoutSeconds (in query): integer

      timeoutSeconds

    Response

    200 (Status): OK

    401: Unauthorized