Skip to main content

Kubernetes Operators

Create Kubernetes Operator

Create a new Kubernetes Operator

Request

POST /kubernetes_operators

Example Request

Loading…

Parameters

NameTypeDescription
descriptionstringhuman-readable description of this Kubernetes Operator. optional, max 255 bytes.
metadatastringarbitrary user-defined machine-readable data of this Kubernetes Operator. optional, max 4096 bytes.
enabled_featuresList<string>features enabled for this Kubernetes Operator. a subset of "bindings", "ingress", and "gateway"
regionstringthe ngrok region in which the ingress for this operator is served. defaults to "global"
deploymentKubernetesOperatorDeploymentinformation about the deployment of this Kubernetes Operator
bindingKubernetesOperatorBindingCreateconfiguration for the Bindings feature of this Kubernetes Operator. set only if enabling the "bindings" feature

KubernetesOperatorDeployment parameters

NameTypeDescription
namestringthe deployment name
namespacestringthe namespace this Kubernetes Operator is deployed to
versionstringthe version of this Kubernetes Operator
cluster_namestringuser-given name for the cluster the Kubernetes Operator is deployed to

KubernetesOperatorBindingCreate parameters

NameTypeDescription
endpoint_selectorsList<string>the list of cel expressions that filter the k8s bound endpoints for this operator
csrstringCSR is supplied during initial creation to enable creating a mutual TLS secured connection between ngrok and the operator. This is an internal implementation detail and subject to change.
ingress_endpointstringthe public ingress endpoint for this Kubernetes Operator

Response

Returns a 201 response on success

Example Response

Loading…

Fields

NameTypeDescription
idstringunique identifier for this Kubernetes Operator
uristringURI of this Kubernetes Operator API resource
created_atstringtimestamp when the Kubernetes Operator was created. RFC 3339 format
updated_atstringtimestamp when the Kubernetes Operator was last updated. RFC 3339 format
descriptionstringhuman-readable description of this Kubernetes Operator. optional, max 255 bytes.
metadatastringarbitrary user-defined machine-readable data of this Kubernetes Operator. optional, max 4096 bytes.
principalRefthe principal who created this Kubernetes Operator
enabled_featuresList<string>features enabled for this Kubernetes Operator. a subset of "bindings", "ingress", and "gateway"
regionstringthe ngrok region in which the ingress for this operator is served. defaults to "global"
deploymentKubernetesOperatorDeploymentinformation about the deployment of this Kubernetes Operator
bindingKubernetesOperatorBindinginformation about the Bindings feature of this Kubernetes Operator, if enabled

Ref fields

NameTypeDescription
idstringa resource identifier
uristringa uri for locating a resource

KubernetesOperatorDeployment fields

NameTypeDescription
namestringthe deployment name
namespacestringthe namespace this Kubernetes Operator is deployed to
versionstringthe version of this Kubernetes Operator
cluster_namestringuser-given name for the cluster the Kubernetes Operator is deployed to

KubernetesOperatorBinding fields

NameTypeDescription
endpoint_selectorsList<string>the list of cel expressions that filter the k8s bound endpoints for this operator
certKubernetesOperatorCertthe binding certificate information
ingress_endpointstringthe public ingress endpoint for this Kubernetes Operator

KubernetesOperatorCert fields

NameTypeDescription
certstringthe public client certificate generated for this Kubernetes Operator from the CSR supplied when enabling the Bindings feature
not_beforestringtimestamp when the certificate becomes valid. RFC 3339 format
not_afterstringtimestamp when the certificate becomes invalid. RFC 3339 format

Update Kubernetes Operator

Update an existing Kubernetes operator by ID.

Request

PATCH /kubernetes_operators/{id}

Example Request

Loading…

Parameters

NameTypeDescription
idstringunique identifier for this Kubernetes Operator
descriptionstringhuman-readable description of this Kubernetes Operator. optional, max 255 bytes.
metadatastringarbitrary user-defined machine-readable data of this Kubernetes Operator. optional, max 4096 bytes.
enabled_featuresList<string>features enabled for this Kubernetes Operator. a subset of "bindings", "ingress", and "gateway"
regionstringthe ngrok region in which the ingress for this operator is served. defaults to "global"
bindingKubernetesOperatorBindingUpdateconfiguration for the Bindings feature of this Kubernetes Operator. set only if enabling the "bindings" feature
deploymentKubernetesOperatorDeploymentUpdateconfiguration for the Deployment info

KubernetesOperatorBindingUpdate parameters

NameTypeDescription
endpoint_selectorsList<string>the list of cel expressions that filter the k8s bound endpoints for this operator
csrstringCSR is supplied during initial creation to enable creating a mutual TLS secured connection between ngrok and the operator. This is an internal implementation detail and subject to change.
ingress_endpointstringthe public ingress endpoint for this Kubernetes Operator

KubernetesOperatorDeploymentUpdate parameters

NameTypeDescription
namestringthe deployment name
versionstringthe version of this Kubernetes Operator

Response

Returns a 200 response on success

Example Response

Loading…

Fields

NameTypeDescription
idstringunique identifier for this Kubernetes Operator
uristringURI of this Kubernetes Operator API resource
created_atstringtimestamp when the Kubernetes Operator was created. RFC 3339 format
updated_atstringtimestamp when the Kubernetes Operator was last updated. RFC 3339 format
descriptionstringhuman-readable description of this Kubernetes Operator. optional, max 255 bytes.
metadatastringarbitrary user-defined machine-readable data of this Kubernetes Operator. optional, max 4096 bytes.
principalRefthe principal who created this Kubernetes Operator
enabled_featuresList<string>features enabled for this Kubernetes Operator. a subset of "bindings", "ingress", and "gateway"
regionstringthe ngrok region in which the ingress for this operator is served. defaults to "global"
deploymentKubernetesOperatorDeploymentinformation about the deployment of this Kubernetes Operator
bindingKubernetesOperatorBindinginformation about the Bindings feature of this Kubernetes Operator, if enabled

Ref fields

NameTypeDescription
idstringa resource identifier
uristringa uri for locating a resource

KubernetesOperatorDeployment fields

NameTypeDescription
namestringthe deployment name
namespacestringthe namespace this Kubernetes Operator is deployed to
versionstringthe version of this Kubernetes Operator
cluster_namestringuser-given name for the cluster the Kubernetes Operator is deployed to

KubernetesOperatorBinding fields

NameTypeDescription
endpoint_selectorsList<string>the list of cel expressions that filter the k8s bound endpoints for this operator
certKubernetesOperatorCertthe binding certificate information
ingress_endpointstringthe public ingress endpoint for this Kubernetes Operator

KubernetesOperatorCert fields

NameTypeDescription
certstringthe public client certificate generated for this Kubernetes Operator from the CSR supplied when enabling the Bindings feature
not_beforestringtimestamp when the certificate becomes valid. RFC 3339 format
not_afterstringtimestamp when the certificate becomes invalid. RFC 3339 format

Delete Kubernetes Operator

Delete a Kubernetes Operator

Request

DELETE /kubernetes_operators/{id}

Example Request

Loading…

Response

Returns a 204 response with no body on success

Get Kubernetes Operator

Get of a Kubernetes Operator

Request

GET /kubernetes_operators/{id}

Example Request

Loading…

Response

Returns a 200 response on success

Example Response

Loading…

Fields

NameTypeDescription
idstringunique identifier for this Kubernetes Operator
uristringURI of this Kubernetes Operator API resource
created_atstringtimestamp when the Kubernetes Operator was created. RFC 3339 format
updated_atstringtimestamp when the Kubernetes Operator was last updated. RFC 3339 format
descriptionstringhuman-readable description of this Kubernetes Operator. optional, max 255 bytes.
metadatastringarbitrary user-defined machine-readable data of this Kubernetes Operator. optional, max 4096 bytes.
principalRefthe principal who created this Kubernetes Operator
enabled_featuresList<string>features enabled for this Kubernetes Operator. a subset of "bindings", "ingress", and "gateway"
regionstringthe ngrok region in which the ingress for this operator is served. defaults to "global"
deploymentKubernetesOperatorDeploymentinformation about the deployment of this Kubernetes Operator
bindingKubernetesOperatorBindinginformation about the Bindings feature of this Kubernetes Operator, if enabled

Ref fields

NameTypeDescription
idstringa resource identifier
uristringa uri for locating a resource

KubernetesOperatorDeployment fields

NameTypeDescription
namestringthe deployment name
namespacestringthe namespace this Kubernetes Operator is deployed to
versionstringthe version of this Kubernetes Operator
cluster_namestringuser-given name for the cluster the Kubernetes Operator is deployed to

KubernetesOperatorBinding fields

NameTypeDescription
endpoint_selectorsList<string>the list of cel expressions that filter the k8s bound endpoints for this operator
certKubernetesOperatorCertthe binding certificate information
ingress_endpointstringthe public ingress endpoint for this Kubernetes Operator

KubernetesOperatorCert fields

NameTypeDescription
certstringthe public client certificate generated for this Kubernetes Operator from the CSR supplied when enabling the Bindings feature
not_beforestringtimestamp when the certificate becomes valid. RFC 3339 format
not_afterstringtimestamp when the certificate becomes invalid. RFC 3339 format

List Kubernetes Operators

List all Kubernetes Operators owned by this account

Request

GET /kubernetes_operators

Example Request

Loading…

Response

Returns a 200 response on success

Example Response

Loading…

Fields

NameTypeDescription
operatorsKubernetesOperatorthe list of Kubernetes Operators for this account
uristring
next_page_uristringURI of the next page, or null if there is no next page

KubernetesOperator fields

NameTypeDescription
idstringunique identifier for this Kubernetes Operator
uristringURI of this Kubernetes Operator API resource
created_atstringtimestamp when the Kubernetes Operator was created. RFC 3339 format
updated_atstringtimestamp when the Kubernetes Operator was last updated. RFC 3339 format
descriptionstringhuman-readable description of this Kubernetes Operator. optional, max 255 bytes.
metadatastringarbitrary user-defined machine-readable data of this Kubernetes Operator. optional, max 4096 bytes.
principalRefthe principal who created this Kubernetes Operator
enabled_featuresList<string>features enabled for this Kubernetes Operator. a subset of "bindings", "ingress", and "gateway"
regionstringthe ngrok region in which the ingress for this operator is served. defaults to "global"
deploymentKubernetesOperatorDeploymentinformation about the deployment of this Kubernetes Operator
bindingKubernetesOperatorBindinginformation about the Bindings feature of this Kubernetes Operator, if enabled

Ref fields

NameTypeDescription
idstringa resource identifier
uristringa uri for locating a resource

KubernetesOperatorDeployment fields

NameTypeDescription
namestringthe deployment name
namespacestringthe namespace this Kubernetes Operator is deployed to
versionstringthe version of this Kubernetes Operator
cluster_namestringuser-given name for the cluster the Kubernetes Operator is deployed to

KubernetesOperatorBinding fields

NameTypeDescription
endpoint_selectorsList<string>the list of cel expressions that filter the k8s bound endpoints for this operator
certKubernetesOperatorCertthe binding certificate information
ingress_endpointstringthe public ingress endpoint for this Kubernetes Operator

KubernetesOperatorCert fields

NameTypeDescription
certstringthe public client certificate generated for this Kubernetes Operator from the CSR supplied when enabling the Bindings feature
not_beforestringtimestamp when the certificate becomes valid. RFC 3339 format
not_afterstringtimestamp when the certificate becomes invalid. RFC 3339 format

GetBoundEndpoints Kubernetes Operator

List Endpoints bound to a Kubernetes Operator

Request

GET /kubernetes_operators/{id}/bound_endpoints

Example Request

Loading…

Response

Returns a 200 response on success

Example Response

Loading…

Fields

NameTypeDescription
endpointsEndpointthe list of all active endpoints on this account
uristringURI of the endpoints list API resource
next_page_uristringURI of the next page, or null if there is no next page

Endpoint fields

NameTypeDescription
idstringunique endpoint resource identifier
regionstringidentifier of the region this endpoint belongs to
created_atstringtimestamp when the endpoint was created in RFC 3339 format
updated_atstringtimestamp when the endpoint was updated in RFC 3339 format
public_urlstringURL of the hostport served by this endpoint
protostringprotocol served by this endpoint. one of http, https, tcp, or tls
schemestring
hostportstringhostport served by this endpoint (hostname:port) -> soon to be deprecated
hoststring
portint64
typestringwhether the endpoint is ephemeral (served directly by an agent-initiated tunnel) or edge (served by an edge) or cloud (represents a cloud endpoint)
metadatastringuser-supplied metadata of the associated tunnel or edge object
descriptionstringuser-supplied description of the associated tunnel
domainRefthe domain reserved for this endpoint
tcp_addrRefthe address reserved for this endpoint
tunnelRefthe tunnel serving requests to this endpoint, if this is an ephemeral endpoint
edgeRefthe edge serving requests to this endpoint, if this is an edge endpoint
upstream_urlstringthe local address the tunnel forwards to
upstream_protocolstringthe protocol the agent uses to forward with
urlstringthe url of the endpoint
principalRefThe ID of the owner (bot or user) that owns this endpoint
traffic_policystringThe traffic policy attached to this endpoint
bindingsList<string>the bindings associated with this endpoint
tunnel_sessionRefThe tunnel session of the agent for this endpoint
uristringURI of the clep API resource
namestringuser supplied name for the endpoint
pooling_enabledbooleanwhether the endpoint allows pooling

Ref fields

NameTypeDescription
idstringa resource identifier
uristringa uri for locating a resource