v33

latestOpenAPI 3.1.0raw.githubusercontent.com2026-04-175267122.5 KB

Create ingress

post/ingresses

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
      }
    }
  ],
  "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
      }
    }
  ],
  "created_at": "2025-01-15T10:00:00Z"
}