Agent Ingresses
Create Agent Ingress
Create a new Agent Ingress. The ngrok agent can be configured to connect to ngrok via the new set of addresses on the returned Agent Ingress.
Request
POST /agent_ingresses
Example Request
curl \
-X POST \
-H "Authorization: Bearer {API_KEY}" \
-H "Content-Type: application/json" \
-H "Ngrok-Version: 2" \
-d '{"description":"acme devices","domain":"connect.acme.com"}' \
https://api.ngrok.com/agent_ingresses
Parameters
description | string | human-readable description of the use of this Agent Ingress. optional, max 255 bytes. |
metadata | string | arbitrary user-defined machine-readable data of this Agent Ingress. optional, max 4096 bytes |
domain | string | the domain that you own to be used as the base domain name to generate regional agent ingress domains. |
Response
Returns a 201 response on success
Example Response
{
"id": "agin_2NTVHbcf9IpYGHRvSdiuGs2sKJy",
"uri": "https://api.ngrok.com/agent_ingresses/agin_2NTVHbcf9IpYGHRvSdiuGs2sKJy",
"description": "acme devices",
"domain": "connect.acme.com",
"ns_targets": [
"1.kube-dns.kube-system.svc.cluster.local.",
"2.kube-dns.kube-system.svc.cluster.local.",
"3.kube-dns.kube-system.svc.cluster.local.",
"4.kube-dns.kube-system.svc.cluster.local."
],
"region_domains": [
"tunnel.us.connect.acme.com"
],
"created_at": "2023-03-24T19:59:31Z"
}
Fields
id | string | unique Agent Ingress resource identifier |
uri | string | URI to the API resource of this Agent ingress |
description | string | human-readable description of the use of this Agent Ingress. optional, max 255 bytes. |
metadata | string | arbitrary user-defined machine-readable data of this Agent Ingress. optional, max 4096 bytes |
domain | string | the domain that you own to be used as the base domain name to generate regional agent ingress domains. |
ns_targets | List<string> | a list of target values to use as the values of NS records for the domain property these values will delegate control over the domain to ngrok |
region_domains | List<string> | a list of regional agent ingress domains that are subdomains of the value of domain this value may increase over time as ngrok adds more regions |
created_at | string | timestamp when the Agent Ingress was created, RFC 3339 format |
Delete Agent Ingress
Delete an Agent Ingress by ID
Request
DELETE /agent_ingresses/{id}
Example Request
curl \
-X DELETE \
-H "Authorization: Bearer {API_KEY}" \
-H "Ngrok-Version: 2" \
https://api.ngrok.com/agent_ingresses/agin_2NTVHbcf9IpYGHRvSdiuGs2sKJy
Response
Returns a 204 response with no body on success
Get Agent Ingress
Get the details of an Agent Ingress by ID.
Request
GET /agent_ingresses/{id}
Example Request
curl \
-X GET \
-H "Authorization: Bearer {API_KEY}" \
-H "Ngrok-Version: 2" \
https://api.ngrok.com/agent_ingresses/agin_2NTVHbcf9IpYGHRvSdiuGs2sKJy
Response
Returns a 200 response on success
Example Response
{
"id": "agin_2NTVHbcf9IpYGHRvSdiuGs2sKJy",
"uri": "https://api.ngrok.com/agent_ingresses/agin_2NTVHbcf9IpYGHRvSdiuGs2sKJy",
"description": "ACME Co. Device Ingress",
"metadata": "{\"device_sku\": \"824JS4RZ1F8X\"}",
"domain": "connect.acme.com",
"ns_targets": [
"1.kube-dns.kube-system.svc.cluster.local.",
"2.kube-dns.kube-system.svc.cluster.local.",
"3.kube-dns.kube-system.svc.cluster.local.",
"4.kube-dns.kube-system.svc.cluster.local."
],
"region_domains": [
"tunnel.us.connect.acme.com"
],
"created_at": "2023-03-24T19:59:31Z"
}
Fields
id | string | unique Agent Ingress resource identifier |
uri | string | URI to the API resource of this Agent ingress |
description | string | human-readable description of the use of this Agent Ingress. optional, max 255 bytes. |
metadata | string | arbitrary user-defined machine-readable data of this Agent Ingress. optional, max 4096 bytes |
domain | string | the domain that you own to be used as the base domain name to generate regional agent ingress domains. |
ns_targets | List<string> | a list of target values to use as the values of NS records for the domain property these values will delegate control over the domain to ngrok |
region_domains | List<string> | a list of regional agent ingress domains that are subdomains of the value of domain this value may increase over time as ngrok adds more regions |
created_at | string | timestamp when the Agent Ingress was created, RFC 3339 format |
List Agent Ingresses
List all Agent Ingresses owned by this account
Request
GET /agent_ingresses
Example Request
curl \
-X GET \
-H "Authorization: Bearer {API_KEY}" \
-H "Ngrok-Version: 2" \
https://api.ngrok.com/agent_ingresses
Response
Returns a 200 response on success
Example Response
{
"ingresses": [
{
"id": "agin_2NTVHbcf9IpYGHRvSdiuGs2sKJy",
"uri": "https://api.ngrok.com/agent_ingresses/agin_2NTVHbcf9IpYGHRvSdiuGs2sKJy",
"description": "acme devices",
"domain": "connect.acme.com",
"ns_targets": [
"1.kube-dns.kube-system.svc.cluster.local.",
"2.kube-dns.kube-system.svc.cluster.local.",
"3.kube-dns.kube-system.svc.cluster.local.",
"4.kube-dns.kube-system.svc.cluster.local."
],
"region_domains": [
"tunnel.us.connect.acme.com"
],
"created_at": "2023-03-24T19:59:31Z"
}
],
"uri": "https://api.ngrok.com/agent_ingresses",
"next_page_uri": null
}
Fields
ingresses | AgentIngress | the list of Agent Ingresses owned by this account |
uri | string | URI of the Agent Ingress list API resource |
next_page_uri | string | URI of the next page, or null if there is no next page |
AgentIngress fields
id | string | unique Agent Ingress resource identifier |
uri | string | URI to the API resource of this Agent ingress |
description | string | human-readable description of the use of this Agent Ingress. optional, max 255 bytes. |
metadata | string | arbitrary user-defined machine-readable data of this Agent Ingress. optional, max 4096 bytes |
domain | string | the domain that you own to be used as the base domain name to generate regional agent ingress domains. |
ns_targets | List<string> | a list of target values to use as the values of NS records for the domain property these values will delegate control over the domain to ngrok |
region_domains | List<string> | a list of regional agent ingress domains that are subdomains of the value of domain this value may increase over time as ngrok adds more regions |
created_at | string | timestamp when the Agent Ingress was created, RFC 3339 format |
Update Agent Ingress
Update attributes of an Agent Ingress by ID.
Request
PATCH /agent_ingresses/{id}
Example Request
curl \
-X PATCH \
-H "Authorization: Bearer {API_KEY}" \
-H "Content-Type: application/json" \
-H "Ngrok-Version: 2" \
-d '{"description":"ACME Co. Device Ingress","metadata":"{\"device_sku\": \"824JS4RZ1F8X\"}"}' \
https://api.ngrok.com/agent_ingresses/agin_2NTVHbcf9IpYGHRvSdiuGs2sKJy
Parameters
id | string | |
description | string | human-readable description of the use of this Agent Ingress. optional, max 255 bytes. |
metadata | string | arbitrary user-defined machine-readable data of this Agent Ingress. optional, max 4096 bytes |
Response
Returns a 200 response on success
Example Response
{
"id": "agin_2NTVHbcf9IpYGHRvSdiuGs2sKJy",
"uri": "https://api.ngrok.com/agent_ingresses/agin_2NTVHbcf9IpYGHRvSdiuGs2sKJy",
"description": "ACME Co. Device Ingress",
"metadata": "{\"device_sku\": \"824JS4RZ1F8X\"}",
"domain": "connect.acme.com",
"ns_targets": [
"1.kube-dns.kube-system.svc.cluster.local.",
"2.kube-dns.kube-system.svc.cluster.local.",
"3.kube-dns.kube-system.svc.cluster.local.",
"4.kube-dns.kube-system.svc.cluster.local."
],
"region_domains": [
"tunnel.us.connect.acme.com"
],
"created_at": "2023-03-24T19:59:31Z"
}
Fields
id | string | unique Agent Ingress resource identifier |
uri | string | URI to the API resource of this Agent ingress |
description | string | human-readable description of the use of this Agent Ingress. optional, max 255 bytes. |
metadata | string | arbitrary user-defined machine-readable data of this Agent Ingress. optional, max 4096 bytes |
domain | string | the domain that you own to be used as the base domain name to generate regional agent ingress domains. |
ns_targets | List<string> | a list of target values to use as the values of NS records for the domain property these values will delegate control over the domain to ngrok |
region_domains | List<string> | a list of regional agent ingress domains that are subdomains of the value of domain this value may increase over time as ngrok adds more regions |
created_at | string | timestamp when the Agent Ingress was created, RFC 3339 format |