API-001 Reference — GET /v1/ingresses

API-001: GET /v1/ingresses

  • Auth: Authorization: Bearer KEY (required)
  • Headers (request): If-None-Match (optional)
  • Produces: application/json

200 OK — Response Body (HostsList)

{
  "hosts": [
    {
      "host": "shop.example.com",
      "servicename": "shop-frontend",
      "user_group": "web",
      "description": "Customer storefront",
      "contact_information": "oncall@example.com",
      "missing_annotations": false,
      "paths": [
        { "path": "/", "pathType": "Prefix", "backendService": "shop-frontend", "reachability": "reachable" }
      ]
    }
  ]
}

Notes:

  • Deterministic ordering by (host, path).
  • Reachability values: reachable | unreachable | unknown.

304 Not Modified

  • No body. Returned when If-None-Match matches current ETag.

401 Unauthorized — Error

{ "message": "unauthorized", "code": "UNAUTHORIZED" }

500 Internal Server Error — Error

{ "message": "internal error", "code": "INTERNAL" }

Response Headers

  • ETag: Strong validator derived from resourceVersions
  • Cache-Control: no-store (deployment may override)

OpenAPI

  • OpenAPI JSON: /openapi.json
  • The OpenAPI includes a path for GET /v1/ingresses with HostsList schema.