KEkernel

Create ingress

Changed on
post/ingresses

Request

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

Request body

namestring required

Human-readable name (lowercase letters, digits, and dashes only; cannot start or end with a dash)

tagsTags

User-defined key-value tags.

Example request

{
  "name": "my-api-ingress",
  "rules": [
    {
      "match": {
        "hostname": "{instance}.example.com",
        "port": 8080
      },
      "target": {
        "instance": "{instance}",
        "port": 8080
      },
      "request_header_auth": {
        "header": "X-Ingress-Verification",
        "value": "0123456789abcdef0123456789abcdef"
      }
    }
  ],
  "tags": {
    "team": "backend",
    "env": "staging"
  }
}

Response

Ingress created

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

  • 9787f2320a2eRevision changes
    • info

      added the non-success response with the status

  • b00eacfe26b2Revision changes
    • info

      added the new optional request property //

    • info

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