Zuplo
The Zuplo Developer API, powered by Zuplo

​Tunnels

List of endpoints available to perform operations on Tunnels.

Endpoint:https://developer-api-main-8600723.self.zuplo.com

​Lists tunnels

GET
https://developer-api-main-8600723.self.zuplo.com
/v1/accounts/{accountName}/tunnels

Lists all tunnels belonging to this account.

​Lists tunnels › path Parameters

  • accountName
    string · required

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

​Lists tunnels › Responses

    • data
      object[] · required
    • limit
      integer · uint32
    • offset
      integer · uint32
    • total
      integer · uint32

​Creates a tunnel

POST
https://developer-api-main-8600723.self.zuplo.com
/v1/accounts/{accountName}/tunnels

Creates a new tunnel for this account.

​Creates a tunnel › path Parameters

  • accountName
    string · required

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

​Creates a tunnel › Request Body

  • tunnelId
    string · readOnly · required
  • name
    string · pattern: ^[a-zA-Z0-9-]{3,24}$ · required

    A friendly name for the tunnel.

  • token
    string · readOnly · required

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

​Creates a tunnel › Responses

    • tunnelId
      string · readOnly · required
    • name
      string · pattern: ^[a-zA-Z0-9-]{3,24}$ · required

      A friendly name for the tunnel.

    • token
      string · readOnly · required

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

​Gets a tunnel

GET
https://developer-api-main-8600723.self.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

  • accountName
    string · required

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

  • tunnelId
    string · required

    The ID of the tunnel.

​Gets a tunnel › Responses

    • tunnelId
      string · readOnly · required
    • name
      string · pattern: ^[a-zA-Z0-9-]{3,24}$ · required

      A friendly name for the tunnel.

    • token
      string · readOnly · required

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

​Deletes a tunnel

DELETE
https://developer-api-main-8600723.self.zuplo.com
/v1/accounts/{accountName}/tunnels/{tunnelId}

Deletes a tunnel and any services that it has.

​Deletes a tunnel › path Parameters

  • accountName
    string · required

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

  • tunnelId
    string · required

    The ID of the tunnel.

​Deletes a tunnel › Responses

    • id
      string · readOnly · required
    • status
      string · enum · required
      Enum values:
      in-progress
      success
      error
    • message
      string
    • details
      string

​Rotates the token

POST
https://developer-api-main-8600723.self.zuplo.com
/v1/accounts/{accountName}/tunnels/{tunnelId}/$rotate-token

Rotates the token used to connect to the tunnel.

​Rotates the token › path Parameters

  • accountName
    string · required

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

  • tunnelId
    string · required

    The ID of the tunnel.

​Rotates the token › Responses

    • tunnelId
      string · readOnly · required
    • name
      string · pattern: ^[a-zA-Z0-9-]{3,24}$ · required

      A friendly name for the tunnel.

    • token
      string · readOnly · required

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

​Gets a teardown status

GET
https://developer-api-main-8600723.self.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

  • accountName
    string · required

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

  • tunnelId
    string · required

    The ID of the tunnel.

  • operationId
    string · required

    The ID of the deletion operation.

​Gets a teardown status › Responses

    • id
      string · readOnly · required
    • status
      string · enum · required
      Enum values:
      in-progress
      success
      error
    • message
      string
    • details
      string