Agent Ingresses

Create Agent Ingress

Create a new Agent . The ngrok agent can be configured to connect to ngrok via the new set of addresses on the returned Agent

Request

POST /agent_ingresses

Example Request

Loading…

Parameters

Name	Type	Description
`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.
`certificate_management_policy`	AgentIngressCertPolicy	configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional.

AgentIngressCertPolicy parameters

Name	Type	Description
`authority`	string	certificate authority to request certificates from. The only supported value is letsencrypt.
`private_key_type`	string	type of private key to use when requesting certificates. Defaults to rsa, can be either rsa or ecdsa.

Response

Returns a 201 response on success

Example Response

Loading…

Fields

Name	Type	Description
`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
`certificate_management_policy`	AgentIngressCertPolicy	configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled
`certificate_management_status`	AgentIngressCertStatus	status of the automatic certificate management for this domain, or null if automatic management is disabled

AgentIngressCertPolicy fields

Name	Type	Description
`authority`	string	certificate authority to request certificates from. The only supported value is letsencrypt.
`private_key_type`	string	type of private key to use when requesting certificates. Defaults to rsa, can be either rsa or ecdsa.

AgentIngressCertStatus fields

Name	Type	Description
`renews_at`	string	timestamp when the next renewal will be requested, RFC 3339 format
`provisioning_job`	AgentIngressCertJob	status of the certificate provisioning job, or null if the certificiate isn't being provisioned or renewed

AgentIngressCertJob fields

Name	Type	Description
`error_code`	string	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).
`msg`	string	a message describing the current status or error
`started_at`	string	timestamp when the provisioning job started, RFC 3339 format
`retries_at`	string	timestamp when the provisioning job will be retried

Delete Agent Ingress

Delete an Agent Ingress by ID

Request

DELETE /agent_ingresses/{id}

Example Request

Loading…

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

Loading…

Response

Returns a 200 response on success

Example Response

Loading…

Fields

Name	Type	Description
`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
`certificate_management_policy`	AgentIngressCertPolicy	configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled
`certificate_management_status`	AgentIngressCertStatus	status of the automatic certificate management for this domain, or null if automatic management is disabled

AgentIngressCertPolicy fields

Name	Type	Description
`authority`	string	certificate authority to request certificates from. The only supported value is letsencrypt.
`private_key_type`	string	type of private key to use when requesting certificates. Defaults to rsa, can be either rsa or ecdsa.

AgentIngressCertStatus fields

Name	Type	Description
`renews_at`	string	timestamp when the next renewal will be requested, RFC 3339 format
`provisioning_job`	AgentIngressCertJob	status of the certificate provisioning job, or null if the certificiate isn't being provisioned or renewed

AgentIngressCertJob fields

Name	Type	Description
`error_code`	string	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).
`msg`	string	a message describing the current status or error
`started_at`	string	timestamp when the provisioning job started, RFC 3339 format
`retries_at`	string	timestamp when the provisioning job will be retried

List Agent Ingresses

List all Agent Ingresses owned by this account

Request

GET /agent_ingresses

Example Request

Loading…

Response

Returns a 200 response on success

Example Response

Loading…

Fields

Name	Type	Description
`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

Name	Type	Description
`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
`certificate_management_policy`	AgentIngressCertPolicy	configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled
`certificate_management_status`	AgentIngressCertStatus	status of the automatic certificate management for this domain, or null if automatic management is disabled

AgentIngressCertPolicy fields

Name	Type	Description
`authority`	string	certificate authority to request certificates from. The only supported value is letsencrypt.
`private_key_type`	string	type of private key to use when requesting certificates. Defaults to rsa, can be either rsa or ecdsa.

AgentIngressCertStatus fields

Name	Type	Description
`renews_at`	string	timestamp when the next renewal will be requested, RFC 3339 format
`provisioning_job`	AgentIngressCertJob	status of the certificate provisioning job, or null if the certificiate isn't being provisioned or renewed

AgentIngressCertJob fields

Name	Type	Description
`error_code`	string	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).
`msg`	string	a message describing the current status or error
`started_at`	string	timestamp when the provisioning job started, RFC 3339 format
`retries_at`	string	timestamp when the provisioning job will be retried

Update Agent Ingress

Update attributes of an Agent Ingress by ID.

Request

PATCH /agent_ingresses/{id}

Example Request

Loading…

Parameters

Name	Type	Description
`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
`certificate_management_policy`	AgentIngressCertPolicy	configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional.

AgentIngressCertPolicy parameters

Name	Type	Description
`authority`	string	certificate authority to request certificates from. The only supported value is letsencrypt.
`private_key_type`	string	type of private key to use when requesting certificates. Defaults to rsa, can be either rsa or ecdsa.

Response

Returns a 200 response on success

Example Response

Loading…

Fields

Name	Type	Description
`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
`certificate_management_policy`	AgentIngressCertPolicy	configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled
`certificate_management_status`	AgentIngressCertStatus	status of the automatic certificate management for this domain, or null if automatic management is disabled

AgentIngressCertPolicy fields

Name	Type	Description
`authority`	string	certificate authority to request certificates from. The only supported value is letsencrypt.
`private_key_type`	string	type of private key to use when requesting certificates. Defaults to rsa, can be either rsa or ecdsa.

AgentIngressCertStatus fields

Name	Type	Description
`renews_at`	string	timestamp when the next renewal will be requested, RFC 3339 format
`provisioning_job`	AgentIngressCertJob	status of the certificate provisioning job, or null if the certificiate isn't being provisioned or renewed

AgentIngressCertJob fields

Name	Type	Description
`error_code`	string	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).
`msg`	string	a message describing the current status or error
`started_at`	string	timestamp when the provisioning job started, RFC 3339 format
`retries_at`	string	timestamp when the provisioning job will be retried

Create Agent Ingress​

Request​

Example Request​

Parameters​

AgentIngressCertPolicy parameters​

Response​

Example Response​

Fields​

AgentIngressCertPolicy fields​

AgentIngressCertStatus fields​

AgentIngressCertJob fields​

Delete Agent Ingress​

Request​

Example Request​

Response​

Get Agent Ingress​

Request​

Example Request​

Response​

Example Response​

Fields​

AgentIngressCertPolicy fields​

AgentIngressCertStatus fields​

AgentIngressCertJob fields​

List Agent Ingresses​

Request​

Example Request​

Response​

Example Response​

Fields​

AgentIngress fields​

AgentIngressCertPolicy fields​

AgentIngressCertStatus fields​

AgentIngressCertJob fields​

Update Agent Ingress​

Request​

Example Request​

Parameters​

AgentIngressCertPolicy parameters​

Response​

Example Response​

Fields​

AgentIngressCertPolicy fields​

AgentIngressCertStatus fields​

AgentIngressCertJob fields​

Create Agent Ingress

Request

Example Request

Parameters

AgentIngressCertPolicy parameters

Response

Example Response

Fields

AgentIngressCertPolicy fields

AgentIngressCertStatus fields

AgentIngressCertJob fields

Delete Agent Ingress

Request

Example Request

Response

Get Agent Ingress

Request

Example Request

Response

Example Response

Fields

AgentIngressCertPolicy fields

AgentIngressCertStatus fields

AgentIngressCertJob fields

List Agent Ingresses

Request

Example Request

Response

Example Response

Fields

AgentIngress fields

AgentIngressCertPolicy fields

AgentIngressCertStatus fields

AgentIngressCertJob fields

Update Agent Ingress

Request

Example Request

Parameters

AgentIngressCertPolicy parameters

Response

Example Response

Fields

AgentIngressCertPolicy fields

AgentIngressCertStatus fields

AgentIngressCertJob fields