Zuplo
The Zuplo Developer API, powered by Zuplo

Tunnel Services

Endpoint:https://dev.zuplo.com

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

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 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 operation.

Gets a provisioning status › Responses

The request has succeeded.

  • idstring · readOnly · required
    Example: pst_ezMUOh0xFqRWg84DPH5jVwgO
  • statusstring · enum · required
    Enum values:
    in-progress
    success
    error
    Example: success
  • messagestring
    Example: Successfully provisioned services.
  • 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 configuration › 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 service configuration › Responses

The request has succeeded.

  • versioninteger · uint8 · required

    The version of this configuration format.

    Example: 1
  • 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 services › 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.

Configures tunnel services › Request Body

  • versioninteger · uint8 · required

    The version of this configuration format.

    Example: 1
  • servicesobject[] · required

    A list of services that the tunnel will connect to.

Configures tunnel services › Responses

The request has succeeded.

  • idstring · readOnly · required
    Example: pst_ezMUOh0xFqRWg84DPH5jVwgO
  • statusstring · enum · required
    Enum values:
    in-progress
    success
    error
    Example: success
  • messagestring
    Example: Successfully provisioned services.
  • detailsstring
Metering - BucketsTunnels