---
title: "returns detailed information about Ingress"
method: GET
path: "/api/v1/ingress/{namespace}/{name}"
---

# returns detailed information about Ingress

`GET /api/v1/ingress/{namespace}/{name}`

## Path parameters

- `namespace` string, required
- `name` string, required

## Query parameters

- `filterBy` string
- `sortBy` string
- `itemsPerPage` string
- `page` string
- `metricNames` string
- `aggregations` string

## Response `200`

OK

- IngressIngressDetail
  - `endpoints` CommonEndpoint[], required
    - `host` string, required
    - `ports` CommonServicePort[], required
      - `nodePort` integer, required
      - `port` integer, required
      - `protocol` string, required
  - `errors` Error[], required
    - unknown
  - `hosts` string[], required
  - `objectMeta` TypesObjectMeta, required
    - `annotations` object
    - `creationTimestamp` V1Time
      - `Time` string, date-time, required
    - `labels` object
    - `name` string
    - `namespace` string
    - `uid` string
  - `spec` V1IngressSpec, required — IngressSpec describes the Ingress the user wishes to exist.
    - `defaultBackend` V1IngressBackend — IngressBackend describes all endpoints for a given service and port.
      - `resource` V1TypedLocalObjectReference — TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace.
        - `apiGroup` string, required — 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.
        - `kind` string, required — Kind is the type of resource being referenced
        - `name` string, required — Name is the name of resource being referenced
      - `service` V1IngressServiceBackend — IngressServiceBackend references a Kubernetes Service as a Backend.
        - `name` string, required — name is the referenced service. The service must exist in the same namespace as the Ingress object.
        - `port` V1ServiceBackendPort — ServiceBackendPort is the service port being referenced.
          - `name` string — name is the name of the port on the Service. This is a mutually exclusive setting with "Number".
          - `number` integer — number is the numerical port number (e.g. 80) on the Service. This is a mutually exclusive setting with "Name".
    - `ingressClassName` string — ingressClassName is the name of an IngressClass cluster resource. Ingress controller implementations use this field to know whether they should be serving this Ingress resource, by a transitive connection (controller -> IngressClass -> Ingress resource). Although the `kubernetes.io/ingress.class` annotation (simple constant name) was never formally defined, it was widely supported by Ingress controllers to create a direct binding between Ingress controller and Ingress resources. Newly created Ingress resources should prefer using the field. However, even though the annotation is officially deprecated, for backwards compatibility reasons, ingress controllers should still honor that annotation if present.
    - `rules` V1IngressRule[] — rules is a list of host rules used to configure the Ingress. If unspecified, or no rule matches, all traffic is sent to the default backend.
      - `host` string — host is the fully qualified domain name of a network host, as defined by RFC 3986. Note the following deviations from the "host" part of the URI as defined in RFC 3986: 1. IPs are not allowed. Currently an IngressRuleValue can only apply to the IP in the Spec of the parent Ingress. 2. The `:` delimiter is not respected because ports are not allowed. Currently the port of an Ingress is implicitly :80 for http and :443 for https. Both these may change in the future. Incoming requests are matched against the host before the IngressRuleValue. If the host is unspecified, the Ingress routes all traffic based on the specified IngressRuleValue. host can be "precise" which is a domain name without the terminating dot of a network host (e.g. "foo.bar.com") or "wildcard", which is a domain name prefixed with a single wildcard label (e.g. "*.foo.com"). The wildcard character '*' must appear by itself as the first DNS label and matches only a single label. You cannot have a wildcard label by itself (e.g. Host == "*"). Requests will be matched against the Host field in the following way: 1. If host is precise, the request matches this rule if the http host header is equal to Host. 2. If host is a wildcard, then the request matches this rule if the http host header is to equal to the suffix (removing the first label) of the wildcard rule.
      - `http` V1HTTPIngressRuleValue — HTTPIngressRuleValue is a list of http selectors pointing to backends. In the example: http://<host>/<path>?<searchpart> -> backend where where parts of the url correspond to RFC 3986, this resource will be used to match against everything after the last '/' and before the first '?' or '#'.
        - `paths` V1HTTPIngressPath[], required — paths is a collection of paths that map requests to backends.
          - `backend` V1IngressBackend, required — IngressBackend describes all endpoints for a given service and port.
            - `resource` V1TypedLocalObjectReference — TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace.
              - …
            - `service` V1IngressServiceBackend — IngressServiceBackend references a Kubernetes Service as a Backend.
              - …
          - `path` string — path is matched against the path of an incoming request. Currently it can contain characters disallowed from the conventional "path" part of a URL as defined by RFC 3986. Paths must begin with a '/' and must be present when using PathType with value "Exact" or "Prefix".
          - `pathType` string, required — pathType determines the interpretation of the path matching. PathType can be one of the following values: * Exact: Matches the URL path exactly. * Prefix: Matches based on a URL path prefix split by '/'. Matching is done on a path element by element basis. A path element refers is the list of labels in the path split by the '/' separator. A request is a match for path p if every p is an element-wise prefix of p of the request path. Note that if the last element of the path is a substring of the last element in request path, it is not a match (e.g. /foo/bar matches /foo/bar/baz, but does not match /foo/barbaz). * ImplementationSpecific: Interpretation of the Path matching is up to the IngressClass. Implementations can treat this as a separate PathType or treat it identically to Prefix or Exact path types. Implementations are required to support all path types.
    - `tls` V1IngressTLS[] — tls represents the TLS configuration. Currently the Ingress only supports a single TLS port, 443. If multiple members of this list specify different hosts, they will be multiplexed on the same port according to the hostname specified through the SNI TLS extension, if the ingress controller fulfilling the ingress supports SNI.
      - `hosts` string[] — hosts is a list of hosts included in the TLS certificate. The values in this list must match the name/s used in the tlsSecret. Defaults to the wildcard host setting for the loadbalancer controller fulfilling this Ingress, if left unspecified.
      - `secretName` string — secretName is the name of the secret used to terminate TLS traffic on port 443. Field is left optional to allow TLS routing based on SNI hostname alone. If the SNI host in a listener conflicts with the "Host" header field used by an IngressRule, the SNI host is used for termination and value of the "Host" header is used for routing.
  - `status` V1IngressStatus, required — IngressStatus describe the current state of the Ingress.
    - `loadBalancer` V1IngressLoadBalancerStatus — IngressLoadBalancerStatus represents the status of a load-balancer.
      - `ingress` V1IngressLoadBalancerIngress[] — ingress is a list containing ingress points for the load-balancer.
        - `hostname` string — hostname is set for load-balancer ingress points that are DNS based.
        - `ip` string — ip is set for load-balancer ingress points that are IP based.
        - `ports` V1IngressPortStatus[] — ports provides information about the ports exposed by this LoadBalancer.
          - `error` string — error is to record the problem with the service port The format of the error shall comply with the following rules: - built-in error values shall be specified in this file and those shall use CamelCase names - cloud provider specific error values must have names that comply with the format foo.example.com/CamelCase.
          - `port` integer, required — port is the port number of the ingress port.
          - `protocol` string, required — protocol is the protocol of the ingress port. The supported values are: "TCP", "UDP", "SCTP"
  - `typeMeta` TypesTypeMeta, required
    - `kind` string
    - `restartable` boolean
    - `scalable` boolean

---

[API](https://skmtc.net/karmada-io/apis/kubernetes-dashboard-api.md) · [All operations](https://skmtc.net/karmada-io/apis/kubernetes-dashboard-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/karmada-io/kubernetes-dashboard-api/versions/8521b53800a7/schema)