get/ingresses

Request

  • Base URL
    http://localhost:4973
  • URL
    http://localhost:4973/ingresses
  • Auth
    HTTP bearer

Query parameters

tagsTags

User-defined key-value tags.

Filter ingresses by tag key-value pairs.

{
  "team": "backend",
  "env": "staging"
}

Response

List of ingresses

idstring required

Auto-generated unique identifier

namestring required

Human-readable name

tagsTags

User-defined key-value tags.

created_atstring date-time required

Creation timestamp (RFC3339)

Example response

[
  {
    "id": "2OgJqXsP7j1qLVVYvGJDNiYVlPO",
    "name": "my-api-ingress",
    "tags": {
      "team": "backend",
      "env": "staging"
    },
    "rules": [
      {
        "match": {
          "hostname": "{instance}.example.com",
          "port": 8080
        },
        "target": {
          "instance": "{instance}",
          "port": 8080
        },
        "request_header_auth": {
          "header": "X-Ingress-Verification",
          "value": "0123456789abcdef0123456789abcdef"
        }
      }
    ],
    "created_at": "2025-01-15T10:00:00Z"
  }
]

Changes

    • info

      added the optional property /// to the response with the status

    • warning

      deleted the query request parameter metadata

    • warning

      removed the optional property / from the response with the status

    • info

      added the new optional query request parameter tags

    • info

      added the optional property / to the response with the status