Zuplo
The Zuplo Developer API, powered by Zuplo

Tunnels

Endpoint:https://dev.zuplo.com

List of endpoints available to perform operations on Tunnels.

Lists tunnels

GET
https://dev.zuplo.com
/v1/accounts/{accountName}/tunnels

Lists all tunnels belonging to this account.

Lists tunnels › path Parameters

  • accountNamestring · required

    The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.

Lists tunnels › Responses

The request has succeeded.

  • dataobject[] · required
  • limitinteger · uint32
    Example: 1000
  • offsetinteger · uint32
    Example: 0
  • totalinteger · uint32

Creates a tunnel

POST
https://dev.zuplo.com
/v1/accounts/{accountName}/tunnels

Creates a new tunnel for this account.

Creates a tunnel › path Parameters

  • accountNamestring · required

    The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.

Creates a tunnel › Request Body

  • tunnelIdstring · readOnly · required
    Example: tnl_JcHFzTcJ9y4GU69lKBOaxFYU
  • namestring · pattern: ^[a-zA-Z0-9-]{3,24}$ · required

    A friendly name for the tunnel.

    Example: api-service-tunnel
  • tokenstring · readOnly · required

    Set your TUNNEL_TOKEN to this value to connect to the tunnel.

    Example: eyJhIjoiODJh[..]m89In0=

Creates a tunnel › Responses

The request has succeeded and a new resource has been created as a result.

  • tunnelIdstring · readOnly · required
    Example: tnl_JcHFzTcJ9y4GU69lKBOaxFYU
  • namestring · pattern: ^[a-zA-Z0-9-]{3,24}$ · required

    A friendly name for the tunnel.

    Example: api-service-tunnel
  • tokenstring · readOnly · required

    Set your TUNNEL_TOKEN to this value to connect to the tunnel.

    Example: eyJhIjoiODJh[..]m89In0=

Gets a tunnel

GET
https://dev.zuplo.com
/v1/accounts/{accountName}/tunnels/{tunnelId}

Returns the details for a tunnel, including the token used to connect to the tunnel.

Gets a tunnel › path Parameters

  • accountNamestring · required

    The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.

  • tunnelIdstring · required

    The ID of the tunnel.

Gets a tunnel › Responses

The request has succeeded.

  • tunnelIdstring · readOnly · required
    Example: tnl_JcHFzTcJ9y4GU69lKBOaxFYU
  • namestring · pattern: ^[a-zA-Z0-9-]{3,24}$ · required

    A friendly name for the tunnel.

    Example: api-service-tunnel
  • tokenstring · readOnly · required

    Set your TUNNEL_TOKEN to this value to connect to the tunnel.

    Example: eyJhIjoiODJh[..]m89In0=

Deletes a tunnel

DELETE
https://dev.zuplo.com
/v1/accounts/{accountName}/tunnels/{tunnelId}

Deletes a tunnel and any services that it has.

Deletes a tunnel › path Parameters

  • accountNamestring · required

    The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.

  • tunnelIdstring · required

    The ID of the tunnel.

Deletes a tunnel › Responses

The request has succeeded.

  • idstring · readOnly · required
    Example: tst_1vmvAjaCun9Mfeosn3Og4ddD
  • statusstring · enum · required
    Enum values:
    in-progress
    success
    error
    Example: success
  • messagestring
    Example: Successfully torn down tunnel.
  • detailsstring

Rotates the token

POST
https://dev.zuplo.com
/v1/accounts/{accountName}/tunnels/{tunnelId}/$rotate-token

Rotates the token used to connect to the tunnel.

Rotates the token › path Parameters

  • accountNamestring · required

    The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.

  • tunnelIdstring · required

    The ID of the tunnel.

Rotates the token › Responses

The request has succeeded.

  • tunnelIdstring · readOnly · required
    Example: tnl_JcHFzTcJ9y4GU69lKBOaxFYU
  • namestring · pattern: ^[a-zA-Z0-9-]{3,24}$ · required

    A friendly name for the tunnel.

    Example: api-service-tunnel
  • tokenstring · readOnly · required

    Set your TUNNEL_TOKEN to this value to connect to the tunnel.

    Example: eyJhIjoiODJh[..]m89In0=

Gets a teardown status

GET
https://dev.zuplo.com
/v1/accounts/{accountName}/tunnels/{tunnelId}/teardown-operations/{operationId}

This endpoint returns the status of the deletion of the tunnel. Tearing down the tunnel is an asynchronous process so this endpoint allows you to poll the status.

Gets a teardown status › path Parameters

  • accountNamestring · required

    The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.

  • tunnelIdstring · required

    The ID of the tunnel.

  • operationIdstring · required

    The ID of the deletion operation.

Gets a teardown status › Responses

The request has succeeded.

  • idstring · readOnly · required
    Example: tst_1vmvAjaCun9Mfeosn3Og4ddD
  • statusstring · enum · required
    Enum values:
    in-progress
    success
    error
    Example: success
  • messagestring
    Example: Successfully torn down tunnel.
  • detailsstring
Tunnel ServicesDeployments