Skip to content
Changelog

Report a bug

Ngrok integration: operations for AI agents

Ngrok connects to Type.com as an integration. This page lists the 251 operations documented for Claude and Codex in Type.com: 98 read, 70 write, 83 destructive.

About Ngrok

Ngrok creates secure tunnels to locally hosted applications, enabling developers to share and test webhooks or services without configuring complex network settings

Categories: Developer Tools & IT

How to connect Ngrok to Type.com

Access
Organization connection: one shared account for the workspace.

To add the connection, follow the steps in Space connections.

Documented operations

251 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.

251 operations listed.

Abuse Reports

  • Read

    Get

    Get the detailed status of abuse report by ID.

  • Write

    Create

    Creates a new abuse report which will be reviewed by our system and abuse response team. This API is only available to authorized accounts. Contact abuse@ngrok.com to request access

Agent Ingresses

  • Read

    List

    List all Agent Ingresses owned by this account

  • Read

    Get

    Get the details of an Agent Ingress by ID.

  • Write

    Create

    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.

  • Write

    Update

    Update attributes of an Agent Ingress by ID.

  • Destructive

    Delete

    Delete an Agent Ingress by ID

AIGateway Provider Keys

  • Read

    List

    List AI Gateway Provider Keys

  • Read

    Get

    Get an AI Gateway Provider Key by ID

  • Write

    Create

    Create a new AI Gateway Provider Key

  • Write

    Update

    Update an existing AI Gateway Provider Key by ID

  • Destructive

    Delete

    Delete an AI Gateway Provider Key

AIGateway APIKeys

  • Read

    List

    List all AI Gateway API Keys owned by account

  • Read

    Get

    Get an AI Gateway API Key by ID

  • Write

    Create

    Create a new AI Gateway API Key

  • Write

    Update

    Update an existing AI Gateway API Key by ID

  • Destructive

    Delete

    Delete an AI Gateway API Key

APIKeys

  • Read

    List

    List all API keys owned by this account

  • Read

    Get

    Get the details of an API key by ID.

  • Write

    Create

    Create a new API key. The generated API key can be used to authenticate to the ngrok API.

  • Write

    Update

    Update attributes of an API key by ID.

  • Destructive

    Delete

    Delete an API key by ID

Application Sessions

  • Read

    List

    List all application sessions for this account.

  • Read

    Get

    Get an application session by ID.

  • Destructive

    Delete

    Delete an application session by ID.

Application Users

  • Read

    List

    List all application users for this account.

  • Read

    Get

    Get an application user by ID.

  • Destructive

    Delete

    Delete an application user by ID.

Tunnel Sessions

  • Read

    List

    List all online tunnel sessions running on this account.

  • Read

    Get

    Get the detailed status of a tunnel session by ID

  • Write

    Restart

    Issues a command instructing the ngrok agent to restart. The agent restarts itself by calling exec() on platforms that support it. This operation is notably not supported on Windows. When an agent restarts, it reconnects with a new tunnel session ID.

  • Write

    Stop

    Issues a command instructing the ngrok agent that started this tunnel session to exit.

  • Write

    Update

    Issues a command instructing the ngrok agent to update itself to the latest version. After this call completes successfully, the ngrok agent will be in the update process.

Failover Backends

  • Read

    List

    List all Failover backends on this account

  • Read

    Get

    Get detailed information about a Failover backend by ID

  • Write

    Create

    Create a new Failover backend

  • Write

    Update

    Update Failover backend by ID

  • Destructive

    Delete

    Delete a Failover backend by ID.

HTTPResponse Backends

  • Read

    List

    GET /backends/http_response

  • Read

    Get

    GET /backends/http_response/{id}

  • Write

    Create

    POST /backends/http_response

  • Write

    Update

    PATCH /backends/http_response/{id}

  • Destructive

    Delete

    DELETE /backends/http_response/{id}

Static Backends

  • Read

    List

    List all static backends on this account

  • Read

    Get

    Get detailed information about a static backend by ID

  • Write

    Create

    Create a new static backend

  • Write

    Update

    Update static backend by ID

  • Destructive

    Delete

    Delete a static backend by ID.

Tunnel Group Backends

  • Read

    List

    List all TunnelGroup backends on this account

  • Read

    Get

    Get detailed information about a TunnelGroup backend by ID

  • Write

    Create

    Create a new TunnelGroup backend

  • Write

    Update

    Update TunnelGroup backend by ID

  • Destructive

    Delete

    Delete a TunnelGroup backend by ID.

Weighted Backends

  • Read

    List

    List all Weighted backends on this account

  • Read

    Get

    Get detailed information about a Weighted backend by ID

  • Write

    Create

    Create a new Weighted backend

  • Write

    Update

    Update Weighted backend by ID

  • Destructive

    Delete

    Delete a Weighted backend by ID.

Bot Users

  • Read

    List

    List all bot users in this account.

  • Read

    Get

    Get the details of a Bot User by ID.

  • Write

    Create

    Create a new bot user

  • Write

    Update

    Update attributes of a bot user by ID.

  • Destructive

    Delete

    Delete a bot user by ID

Certificate Authorities

  • Read

    List

    List all Certificate Authority on this account

  • Read

    Get

    Get detailed information about a certificate authority

  • Write

    Create

    Upload a new Certificate Authority

  • Write

    Update

    Update attributes of a Certificate Authority by ID

  • Destructive

    Delete

    Delete a Certificate Authority

Credentials

  • Read

    List

    List all tunnel authtoken credentials on this account

  • Read

    Get

    Get detailed information about a tunnel authtoken credential

  • Write

    Create

    Create a new tunnel authtoken credential. This authtoken credential can be used to start a new tunnel session. The response to this API call is the only time the generated token is available. If you need it for future use, you must save it securely yourself.

  • Write

    Update

    Update attributes of an tunnel authtoken credential by ID

  • Destructive

    Delete

    Delete a tunnel authtoken credential by ID

Edges HTTPSRoutes

  • Read

    Get

    Get an HTTPS Edge Route by ID

  • Write

    Create

    Create an HTTPS Edge Route

  • Write

    Update

    Updates an HTTPS Edge Route by ID. If a module is not specified in the update, it will not be modified. However, each module configuration that is specified will completely replace the existing value.

  • Destructive

    Delete

    Delete an HTTPS Edge Route by ID

Edges HTTPS

  • Read

    List

    Returns a list of all HTTPS Edges on this account

  • Read

    Get

    Get an HTTPS Edge by ID

  • Write

    Create

    Create an HTTPS Edge

  • Write

    Update

    Updates an HTTPS Edge by ID. If a module is not specified in the update, it will not be modified. However, each module configuration that is specified will completely replace the existing value.

  • Destructive

    Delete

    Delete an HTTPS Edge by ID

HTTPSEdge Mutual TLSModule

  • Read

    Get

    GET /edges/https/{id}/mutual_tls

  • Destructive

    Replace

    PUT /edges/https/{id}/mutual_tls

  • Destructive

    Delete

    DELETE /edges/https/{id}/mutual_tls

HTTPSEdge TLSTermination Module

  • Read

    Get

    GET /edges/https/{id}/tls_termination

  • Destructive

    Replace

    PUT /edges/https/{id}/tls_termination

  • Destructive

    Delete

    DELETE /edges/https/{id}/tls_termination

Edge Route Backend Module

  • Read

    Get

    GET /edges/https/{edge_id}/routes/{id}/backend

  • Destructive

    Replace

    PUT /edges/https/{edge_id}/routes/{id}/backend

  • Destructive

    Delete

    DELETE /edges/https/{edge_id}/routes/{id}/backend

Edge Route IPRestriction Module

  • Read

    Get

    GET /edges/https/{edge_id}/routes/{id}/ip_restriction

  • Destructive

    Replace

    PUT /edges/https/{edge_id}/routes/{id}/ip_restriction

  • Destructive

    Delete

    DELETE /edges/https/{edge_id}/routes/{id}/ip_restriction

Edge Route Request Headers Module

  • Read

    Get

    GET /edges/https/{edge_id}/routes/{id}/request_headers

  • Destructive

    Replace

    PUT /edges/https/{edge_id}/routes/{id}/request_headers

  • Destructive

    Delete

    DELETE /edges/https/{edge_id}/routes/{id}/request_headers

Edge Route Response Headers Module

  • Read

    Get

    GET /edges/https/{edge_id}/routes/{id}/response_headers

  • Destructive

    Replace

    PUT /edges/https/{edge_id}/routes/{id}/response_headers

  • Destructive

    Delete

    DELETE /edges/https/{edge_id}/routes/{id}/response_headers

Edge Route Compression Module

  • Read

    Get

    GET /edges/https/{edge_id}/routes/{id}/compression

  • Destructive

    Replace

    PUT /edges/https/{edge_id}/routes/{id}/compression

  • Destructive

    Delete

    DELETE /edges/https/{edge_id}/routes/{id}/compression

Edge Route Circuit Breaker Module

  • Read

    Get

    GET /edges/https/{edge_id}/routes/{id}/circuit_breaker

  • Destructive

    Replace

    PUT /edges/https/{edge_id}/routes/{id}/circuit_breaker

  • Destructive

    Delete

    DELETE /edges/https/{edge_id}/routes/{id}/circuit_breaker

Edge Route Webhook Verification Module

  • Read

    Get

    GET /edges/https/{edge_id}/routes/{id}/webhook_verification

  • Destructive

    Replace

    PUT /edges/https/{edge_id}/routes/{id}/webhook_verification

  • Destructive

    Delete

    DELETE /edges/https/{edge_id}/routes/{id}/webhook_verification

Edge Route OAuth Module

  • Read

    Get

    GET /edges/https/{edge_id}/routes/{id}/oauth

  • Destructive

    Replace

    PUT /edges/https/{edge_id}/routes/{id}/oauth

  • Destructive

    Delete

    DELETE /edges/https/{edge_id}/routes/{id}/oauth

Edge Route SAMLModule

  • Read

    Get

    GET /edges/https/{edge_id}/routes/{id}/saml

  • Destructive

    Replace

    PUT /edges/https/{edge_id}/routes/{id}/saml

  • Destructive

    Delete

    DELETE /edges/https/{edge_id}/routes/{id}/saml

Edge Route OIDCModule

  • Read

    Get

    GET /edges/https/{edge_id}/routes/{id}/oidc

  • Destructive

    Replace

    PUT /edges/https/{edge_id}/routes/{id}/oidc

  • Destructive

    Delete

    DELETE /edges/https/{edge_id}/routes/{id}/oidc

Edge Route Websocket TCPConverter Module

  • Read

    Get

    GET /edges/https/{edge_id}/routes/{id}/websocket_tcp_converter

  • Destructive

    Replace

    PUT /edges/https/{edge_id}/routes/{id}/websocket_tcp_converter

  • Destructive

    Delete

    DELETE /edges/https/{edge_id}/routes/{id}/websocket_tcp_converter

Edge Route User Agent Filter Module

  • Read

    Get

    GET /edges/https/{edge_id}/routes/{id}/user_agent_filter

  • Destructive

    Replace

    PUT /edges/https/{edge_id}/routes/{id}/user_agent_filter

  • Destructive

    Delete

    DELETE /edges/https/{edge_id}/routes/{id}/user_agent_filter

Edge Route Traffic Policy Module

  • Read

    Get

    GET /edges/https/{edge_id}/routes/{id}/traffic_policy

  • Destructive

    Replace

    PUT /edges/https/{edge_id}/routes/{id}/traffic_policy

  • Destructive

    Delete

    DELETE /edges/https/{edge_id}/routes/{id}/traffic_policy

Edges TCP

  • Read

    List

    Returns a list of all TCP Edges on this account

  • Read

    Get

    Get a TCP Edge by ID

  • Write

    Create

    Create a TCP Edge

  • Write

    Update

    Updates a TCP Edge by ID. If a module is not specified in the update, it will not be modified. However, each module configuration that is specified will completely replace the existing value.

  • Destructive

    Delete

    Delete a TCP Edge by ID

TCPEdge Backend Module

  • Read

    Get

    GET /edges/tcp/{id}/backend

  • Destructive

    Replace

    PUT /edges/tcp/{id}/backend

  • Destructive

    Delete

    DELETE /edges/tcp/{id}/backend

TCPEdge IPRestriction Module

  • Read

    Get

    GET /edges/tcp/{id}/ip_restriction

  • Destructive

    Replace

    PUT /edges/tcp/{id}/ip_restriction

  • Destructive

    Delete

    DELETE /edges/tcp/{id}/ip_restriction

TCPEdge Traffic Policy Module

  • Read

    Get

    GET /edges/tcp/{id}/traffic_policy

  • Destructive

    Replace

    PUT /edges/tcp/{id}/traffic_policy

  • Destructive

    Delete

    DELETE /edges/tcp/{id}/traffic_policy

Edges TLS

  • Read

    List

    Returns a list of all TLS Edges on this account

  • Read

    Get

    Get a TLS Edge by ID

  • Write

    Create

    Create a TLS Edge

  • Write

    Update

    Updates a TLS Edge by ID. If a module is not specified in the update, it will not be modified. However, each module configuration that is specified will completely replace the existing value.

  • Destructive

    Delete

    Delete a TLS Edge by ID

TLSEdge Backend Module

  • Read

    Get

    GET /edges/tls/{id}/backend

  • Destructive

    Replace

    PUT /edges/tls/{id}/backend

  • Destructive

    Delete

    DELETE /edges/tls/{id}/backend

TLSEdge IPRestriction Module

  • Read

    Get

    GET /edges/tls/{id}/ip_restriction

  • Destructive

    Replace

    PUT /edges/tls/{id}/ip_restriction

  • Destructive

    Delete

    DELETE /edges/tls/{id}/ip_restriction

TLSEdge Mutual TLSModule

  • Read

    Get

    GET /edges/tls/{id}/mutual_tls

  • Destructive

    Replace

    PUT /edges/tls/{id}/mutual_tls

  • Destructive

    Delete

    DELETE /edges/tls/{id}/mutual_tls

TLSEdge TLSTermination Module

  • Read

    Get

    GET /edges/tls/{id}/tls_termination

  • Destructive

    Replace

    PUT /edges/tls/{id}/tls_termination

  • Destructive

    Delete

    DELETE /edges/tls/{id}/tls_termination

TLSEdge Traffic Policy Module

  • Read

    Get

    GET /edges/tls/{id}/traffic_policy

  • Destructive

    Replace

    PUT /edges/tls/{id}/traffic_policy

  • Destructive

    Delete

    DELETE /edges/tls/{id}/traffic_policy

Endpoints

  • Read

    List

    List all active endpoints on the account

  • Read

    Get

    Get the status of an endpoint by ID

  • Write

    Create

    Create an endpoint, currently available only for cloud endpoints

  • Write

    Update

    Update an Endpoint by ID, currently available only for cloud endpoints

  • Destructive

    Delete

    Delete an Endpoint by ID, currently available only for cloud endpoints

Event Destinations

  • Read

    List

    List all Event Destinations on this account.

  • Read

    Get

    Get detailed information about an Event Destination by ID.

  • Write

    Create

    Create a new Event Destination. It will not apply to anything until it is associated with an Event Subscription.

  • Write

    Update

    Update attributes of an Event Destination.

  • Destructive

    Delete

    Delete an Event Destination. If the Event Destination is still referenced by an Event Subscription.

Event Subscriptions

  • Read

    List

    List this Account's Event Subscriptions.

  • Read

    Get

    Get an Event Subscription by ID.

  • Write

    Create

    Create an Event Subscription.

  • Write

    Update

    Update an Event Subscription.

  • Destructive

    Delete

    Delete an Event Subscription.

Event Sources

  • Read

    List

    List the types for which this event subscription will trigger

  • Read

    Get

    Get the details for a given type that triggers for the given event subscription

  • Write

    Create

    Add an additional type for which this event subscription will trigger

  • Write

    Update

    Update the type for which this event subscription will trigger

  • Destructive

    Delete

    Remove a type for which this event subscription will trigger

IPPolicies

  • Read

    List

    List all IP policies on this account

  • Read

    Get

    Get detailed information about an IP policy by ID.

  • Write

    Create

    Create a new IP policy. It will not apply to any traffic until you associate to a traffic source via an endpoint configuration or IP restriction.

  • Write

    Update

    Update attributes of an IP policy by ID

  • Destructive

    Delete

    Delete an IP policy. If the IP policy is referenced by another object for the purposes of traffic restriction it will be treated as if the IP policy remains but has zero rules.

IPPolicy Rules

  • Read

    List

    List all IP policy rules on this account

  • Read

    Get

    Get detailed information about an IP policy rule by ID.

  • Write

    Create

    Create a new IP policy rule attached to an IP Policy.

  • Write

    Update

    Update attributes of an IP policy rule by ID

  • Destructive

    Delete

    Delete an IP policy rule.

IPRestrictions

  • Read

    List

    List all IP restrictions on this account

  • Read

    Get

    Get detailed information about an IP restriction

  • Write

    Create

    Create a new IP restriction

  • Write

    Update

    Update attributes of an IP restriction by ID

  • Destructive

    Delete

    Delete an IP restriction

Reserved Addrs

  • Read

    List

    List all reserved addresses on this account.

  • Read

    Get

    Get the details of a reserved address.

  • Write

    Create

    Create a new reserved address.

  • Write

    Update

    Update the attributes of a reserved address.

  • Destructive

    Delete

    Delete a reserved address.

Reserved Domains

  • Read

    List

    List all reserved domains on this account.

  • Read

    Get

    Get the details of a reserved domain.

  • Write

    Create

    Create a new reserved domain.

  • Write

    Update

    Update the attributes of a reserved domain.

  • Destructive

    Delete

    Delete a reserved domain.

  • Destructive

    DeleteCertificate

    Detach the certificate attached to a reserved domain.

  • Destructive

    DeleteCertificateManagementPolicy

    Detach the certificate management policy attached to a reserved domain.

Secrets

  • Read

    List

    List all Secrets owned by account

  • Read

    Get

    Get a Secret by ID

  • Write

    Create

    Create a new Secret

  • Write

    Update

    Update an existing Secret by ID

  • Destructive

    Delete

    Delete a Secret

Service Users

  • Read

    List

    List all service users in this account.

  • Read

    Get

    Get the details of a Bot User by ID.

  • Write

    Create

    Create a new service user

  • Write

    Update

    Update attributes of a service user by ID.

  • Destructive

    Delete

    Delete a service user by ID

SSHCertificate Authorities

  • Read

    List

    List all SSH Certificate Authorities on this account

  • Read

    Get

    Get detailed information about an SSH Certificate Authority

  • Write

    Create

    Create a new SSH Certificate Authority

  • Write

    Update

    Update an SSH Certificate Authority

  • Destructive

    Delete

    Delete an SSH Certificate Authority

SSHCredentials

  • Read

    List

    List all ssh credentials on this account

  • Read

    Get

    Get detailed information about an sshcredential

  • Write

    Create

    Create a new sshcredential from an uploaded public SSH key. This ssh credential can be used to start new tunnels via ngrok's SSH gateway.

  • Write

    Update

    Update attributes of an sshcredential by ID

  • Destructive

    Delete

    Delete an sshcredential by ID

SSHHost Certificates

  • Read

    List

    List all SSH Host Certificates issued on this account

  • Read

    Get

    Get detailed information about an SSH Host Certificate

  • Write

    Create

    Create a new SSH Host Certificate

  • Write

    Update

    Update an SSH Host Certificate

  • Destructive

    Delete

    Delete an SSH Host Certificate

SSHUser Certificates

  • Read

    List

    List all SSH User Certificates issued on this account

  • Read

    Get

    Get detailed information about an SSH User Certificate

  • Write

    Create

    Create a new SSH User Certificate

  • Write

    Update

    Update an SSH User Certificate

  • Destructive

    Delete

    Delete an SSH User Certificate

TLSCertificates

  • Read

    List

    List all TLS certificates on this account

  • Read

    Get

    Get detailed information about a TLS certificate

  • Write

    Create

    Upload a new TLS certificate

  • Write

    Update

    Update attributes of a TLS Certificate by ID

  • Destructive

    Delete

    Delete a TLS certificate

Tunnels

  • Read

    List

    List all online tunnels currently running on the account.

  • Read

    Get

    Get the status of a tunnel by ID

Vaults

  • Read

    List

    List all Vaults owned by account

  • Read

    Get

    Get a Vault by ID

  • Read

    GetSecretsByVault

    Get Secrets by Vault ID

  • Write

    Create

    Create a new Vault

  • Write

    Update

    Update an existing Vault by ID

  • Destructive

    Delete

    Delete a Vault

See How connections work for access and permissions, or browse all integrations.