Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-17471545.0 KB
Services

Forward a specific service

Start forwarding a specific Kubernetes service

post/v1/services

Request body

namespacestring required

Kubernetes namespace

serviceNamestring required

Name of the service to forward

contextstring

Kubernetes context (defaults to current context)

portsstring[]

Specific ports to forward (optional, forwards all if omitted)

localIPstring

Reserve a specific local IP address (optional)

Example request

{
  "namespace": "default",
  "serviceName": "postgres",
  "context": "minikube",
  "ports": [
    "5432"
  ],
  "localIP": "127.1.2.100"
}

Response

Service forwarding started

successboolean
dataobject

Example response

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Service not found"
  }
}