The Zuplo Developer API, powered by Zuplo

Tunnel Services

List of endpoints available to manage services for a given tunnel.


Endpoint:https://dev.zuplo.com

Gets a provisioning status

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

This endpoint returns the status of the services that the tunnel is currently configured for. Provisioning the services is an asynchronous process so this endpoint allows you to poll the status.

Gets a provisioning statuspath 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 operation.

Gets a provisioning statusResponses

    • idstring · readOnly · required
    • statusstring · enum · required
      Enum values:
      in-progress
      success
      error
    • messagestring
    • detailsstring

Gets a service configuration

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

This endpoint returns a snapshot of the services that the tunnel is currently configured for.

Gets a service configurationpath 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 service configurationResponses

    • versioninteger · uint8 · required

      The version of this configuration format.

    • servicesobject[] · required

      A list of services that the tunnel will connect to.

Configures tunnel services

PUT
https://dev.zuplo.com
/v1/accounts/{accountName}/tunnels/{tunnelId}/services-configuration

This endpoint reads the request body and creates/updates/delete the services that the tunnel connects to.

Configures tunnel servicespath 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.

Configures tunnel servicesRequest Body

  • versioninteger · uint8 · required

    The version of this configuration format.

  • servicesobject[] · required

    A list of services that the tunnel will connect to.

Configures tunnel servicesResponses

    • idstring · readOnly · required
    • statusstring · enum · required
      Enum values:
      in-progress
      success
      error
    • messagestring
    • detailsstring