Skip to main content
Monitoring & Collection/Zaku

GetIngressTopology

Get topology of backend services for a Kubernetes ingress resource

GET/api/v1/zaku/ingresses/{ingressUuid}/topology

Operation ID

GetIngressTopology

Since

1.0.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

Path Parameters

  • ingressUuid
    StringRequired

    UUID of the Kubernetes ingress to retrieve topology for

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • ingress
    Object

    Ingress for this resource

    • uuid
      String

      Unique identifier of the ingress resource

      Example: ingress-001

    • name
      String

      Name of the Kubernetes ingress resource

      Example: main-ingress

    • namespace
      String

      Kubernetes namespace of the ingress

      Example: default

    • ingressClassName
      String

      Name of the ingress class handling this ingress

      Example: nginx

    • rules
      String

      JSON-serialized routing rules for the ingress

      Example: [{"host":"example.com"}]

    • defaultBackend
      String

      JSON-serialized default backend configuration

      Example: {"service":{"name":"nginx-service","port":{"number":80}}}

  • services
    List

    Services for this resource

    Example: (nested array)

    • uuid
      String

      Unique identifier of the service

      Example: svc-001

    • name
      String

      Name of the Kubernetes service

      Example: nginx-service

    • namespace
      String

      Kubernetes namespace of the service

      Example: default

    • type
      String

      Service type (ClusterIP, NodePort, LoadBalancer)

      Example: ClusterIP

    • clusterIp
      String

      Cluster-internal IP address assigned to the service

      Example: 10.96.0.10

    • ports
      String

      JSON-serialized port mappings for the service

      Example: [{"port":80,"targetPort":8080}]

    • selector
      String

      Label selector expression for backing pods

      Example: app=nginx