Zuplo
The Zuplo Developer API, powered by Zuplo

Tunnels

Endpoint:https://dev.zuplo.com

Lists tunnels

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

Lists tunnels › path Parameters

  • accountNamestring · required

Lists tunnels › Responses

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

Creates a tunnel

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

Creates a tunnel › path Parameters

  • accountNamestring · required

Creates a tunnel › Request Body

  • tunnelIdstring · readOnly · required
    Example: tnl_JcHFzTcJ9y4GU69lKBOaxFYU
  • namestring · pattern: ^[a-zA-Z0-9-]{3,24}$ · required
    Example: api-service-tunnel
  • tokenstring · readOnly · required
    Example: eyJhIjoiODJh[..]m89In0=

Creates a tunnel › Responses

  • tunnelIdstring · readOnly · required
    Example: tnl_JcHFzTcJ9y4GU69lKBOaxFYU
  • namestring · pattern: ^[a-zA-Z0-9-]{3,24}$ · required
    Example: api-service-tunnel
  • tokenstring · readOnly · required
    Example: eyJhIjoiODJh[..]m89In0=

Gets a tunnel

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

Gets a tunnel › path Parameters

  • accountNamestring · required
  • tunnelIdstring · required

Gets a tunnel › Responses

  • tunnelIdstring · readOnly · required
    Example: tnl_JcHFzTcJ9y4GU69lKBOaxFYU
  • namestring · pattern: ^[a-zA-Z0-9-]{3,24}$ · required
    Example: api-service-tunnel
  • tokenstring · readOnly · required
    Example: eyJhIjoiODJh[..]m89In0=

Deletes a tunnel

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

Deletes a tunnel › path Parameters

  • accountNamestring · required
  • tunnelIdstring · required

Deletes a tunnel › Responses

  • 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 › path Parameters

  • accountNamestring · required
  • tunnelIdstring · required

Rotates the token › Responses

  • tunnelIdstring · readOnly · required
    Example: tnl_JcHFzTcJ9y4GU69lKBOaxFYU
  • namestring · pattern: ^[a-zA-Z0-9-]{3,24}$ · required
    Example: api-service-tunnel
  • tokenstring · readOnly · required
    Example: eyJhIjoiODJh[..]m89In0=

Gets a teardown status

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

Gets a teardown status › path Parameters

  • accountNamestring · required
  • tunnelIdstring · required
  • operationIdstring · required

Gets a teardown status › Responses

  • 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