Universal Gateway
Traffic Policy
Secure Tunnels
Observability
SSH Certificates
Partners
Vaults & Secrets
Deprecated
curl --request GET \
--url https://api.ngrok.com/agent_ingresses \
--header 'Authorization: Bearer <token>' \
--header 'ngrok-version: <ngrok-version>'{
"ingresses": [
{
"id": "<string>",
"uri": "<string>",
"description": "<string>",
"metadata": "<string>",
"domain": "<string>",
"ns_targets": [
"<string>"
],
"region_domains": [
"<string>"
],
"created_at": "<string>",
"certificate_management_policy": {
"authority": "<string>",
"private_key_type": "<string>"
},
"certificate_management_status": {
"renews_at": "<string>",
"provisioning_job": {
"error_code": "<string>",
"msg": "<string>",
"started_at": "<string>",
"retries_at": "<string>"
}
}
}
],
"uri": "<string>",
"next_page_uri": "<string>"
}List
List all Agent Ingresses owned by this account
curl --request GET \
--url https://api.ngrok.com/agent_ingresses \
--header 'Authorization: Bearer <token>' \
--header 'ngrok-version: <ngrok-version>'{
"ingresses": [
{
"id": "<string>",
"uri": "<string>",
"description": "<string>",
"metadata": "<string>",
"domain": "<string>",
"ns_targets": [
"<string>"
],
"region_domains": [
"<string>"
],
"created_at": "<string>",
"certificate_management_policy": {
"authority": "<string>",
"private_key_type": "<string>"
},
"certificate_management_status": {
"renews_at": "<string>",
"provisioning_job": {
"error_code": "<string>",
"msg": "<string>",
"started_at": "<string>",
"retries_at": "<string>"
}
}
}
],
"uri": "<string>",
"next_page_uri": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Response
List all Agent Ingresses owned by this account
the list of Agent Ingresses owned by this account
Show child attributes
Show child attributes
unique Agent Ingress resource identifier
URI to the API resource of this Agent ingress
human-readable description of the use of this Agent Ingress. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this Agent Ingress. optional, max 4096 bytes
the domain that you own to be used as the base domain name to generate regional agent ingress domains.
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
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
timestamp when the Agent Ingress was created, RFC 3339 format
configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled
Show child attributes
Show child attributes
certificate authority to request certificates from. The only supported value is letsencrypt.
type of private key to use when requesting certificates. Defaults to rsa, can be either rsa or ecdsa.
status of the automatic certificate management for this domain, or null if automatic management is disabled
Show child attributes
Show child attributes
timestamp when the next renewal will be requested, RFC 3339 format
status of the certificate provisioning job, or null if the certificiate isn't being provisioned or renewed
Show child attributes
Show child attributes
if present, an error code indicating why provisioning is failing. It may be either a temporary condition (INTERNAL_ERROR), or a permanent one the user must correct (DNS_ERROR).
a message describing the current status or error
timestamp when the provisioning job started, RFC 3339 format
timestamp when the provisioning job will be retried
URI of the Agent Ingress list API resource
URI of the next page, or null if there is no next page
Was this page helpful?