Skip to main content

​
Retrieving the Data Source

This data source can be retrieved by only ID.
Retrieve by ID
To retrieve by ID, fill in only the id field:
Tunnel represents a secure tunnel connection for applications. It enables connectivity between applications and external services within a parent.

​
Schema

​
Required

  • id (String) Identifier for the resource, unique for its resource type.

​
Read-Only

  • created_at (String) : Timestamp indicating when the resource was created. A string representing a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DDTHH:MM:SS.SSS±HH:MM
  • description (String) Arbitrary description of the tunnel provided by the user.
  • labels (Map of String) Labels associated with the resource.
  • metadata (Attributes) : Resource metadata containing identification and hierarchy information.

    ​
    Inner value description

    Common resource metadata. (see below for nested schema)
  • name (String) Human readable name for the resource.
  • parent_id (String) Identifier of the parent resource to which the resource belongs.
  • resource_version (Number) : Version of the resource for safe concurrent modifications and consistent reads. Positive and monotonically increases on each resource spec change (but not on each change of the resource’s container(s) or status). Service allows zero value or current.
  • status (Attributes) : Current status of the tunnel.

    ​
    Inner value description

    TunnelStatus represents the current state of the tunnel. (see below for nested schema)
  • title (String) Human-readable display name for the tunnel.
  • updated_at (String) : Timestamp indicating when the resource was last updated. A string representing a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DDTHH:MM:SS.SSS±HH:MM

​
Nested Schema for metadata

​
Nested Schema for status

Read-Only:
  • connection_state (String) : Whether any agent is connected to the tunnel now.

    ​
    Supported values

    ConnectionState reports whether the tunnel has an agent behind it. Values are prefixed because a top-level enum puts them in the package scope. Possible values:
    • CONNECTION_STATE_UNSPECIFIED: Proto3 zero value. A read of the tunnel never returns it; a mutation records it, because it reports the tunnel that was written.
    • CONNECTION_STATE_DISCONNECTED - No agent is connected. Nothing the tunnel exposes is reachable.
    • CONNECTION_STATE_CONNECTED - At least one agent is connected.
  • services (Attributes List) : Services reachable through the tunnel. A service is listed while at least one agent announces it, and follows the agents within about 30 seconds.

    ​
    Inner value description

    ServiceStatus is a service reachable through the tunnel. (see below for nested schema)
  • state (String) : Current lifecycle state of the tunnel.

    ​
    Supported values

    State represents the lifecycle state of the tunnel. Possible values:
    • UNSPECIFIED - Default unspecified state.
    • CREATED - The tunnel has been created and is active.
    • DELETED - The tunnel has been deleted.

​
Nested Schema for status.services

Read-Only:
  • endpoint (String) : Where to reach the service, as host:port. The tunnel terminates TLS, so a client connects over TLS and sends the host as SNI. What travels inside is whatever the service speaks, which the tunnel does not interpret. For example, “app-hy3wnb3wstpk7dz.tunnel.example.com:443”.
  • name (String) : Name of the service, as the agent announced it. 1-20 characters, lowercase letters and digits only: the hostname joins the name to the tunnel id with a dash, so a name may not contain one. For example, “app”.