Skip to main content
API Explorer|API Explorer
Monitoring & Collection/Zaku
GETZakuSince 1.0SynchronousAuth Required

GetIngressTopology

Get topology of backend services for a Kubernetes ingress resource

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Path Parameters

Request Inputs

Path Parameters

  • ingressUuidStringRequired

    UUID of the Kubernetes ingress to retrieve topology for

Responses

200 OK

On success, this API returns the following response structure.

  • ingressObject

    Ingress for this resource

    • uuidString

      Unique identifier of the ingress resource

      Example: ingress-001

    • nameString

      Name of the Kubernetes ingress resource

      Example: main-ingress

    • namespaceString

      Kubernetes namespace of the ingress

      Example: default

    • ingressClassNameString

      Name of the ingress class handling this ingress

      Example: nginx

    • rulesString

      JSON-serialized routing rules for the ingress

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

    • defaultBackendString

      JSON-serialized default backend configuration

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

  • servicesList

    Services for this resource

    Example: (nested array)

    • uuidString

      Unique identifier of the service

      Example: svc-001

    • nameString

      Name of the Kubernetes service

      Example: nginx-service

    • namespaceString

      Kubernetes namespace of the service

      Example: default

    • typeString

      Service type (ClusterIP, NodePort, LoadBalancer)

      Example: ClusterIP

    • clusterIpString

      Cluster-internal IP address assigned to the service

      Example: 10.96.0.10

    • portsString

      JSON-serialized port mappings for the service

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

    • selectorString

      Label selector expression for backing pods

      Example: app=nginx

Endpoint

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

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

Operation ID

GetIngressTopology

Permalink

Request Example

curl -X GET '{host}/api/v1/zaku/ingresses/{ingressUuid}/topology' -H 'Authorization: Bearer {token}'

Response Example

200
{
  "ingress": {},
  "services": [
    {}
  ]
}

Change History

This API has no change history records yet.

View all change history