Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zuplo Tunnel Services API

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

Zuplo Tunnel Services API is one of 13 APIs that Zuplo publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 4 JSON Schema definitions.

Tagged areas include Tunnel Services. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, and 4 JSON Schemas.

This API exposes 3 operations across 2 paths, and defines 6 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

Requests are made against a single base URL, https://dev.zuplo.com.

3 operations 2 paths 6 schemas 2 GET1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://dev.zuplo.com
Authentication
API Key
Contact
Terms of Service
Resource Areas
1

Authentication & Security 1

Zuplo Tunnel Services API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — API key authentication. Format: Bearer {api-key}

Paths & Operations 3

Across 2 paths, the API surfaces 3 operations — 2 GET, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Tunnel Services 3

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

GET
/v1/accounts/{accountName}/tunnels/{tunnelId}/provisioning-operations/{operationId}
Gets a Provisioning Status
TunneledServicesService_getProvisioningStatus 3 params → 200400401500
GET
/v1/accounts/{accountName}/tunnels/{tunnelId}/services-configuration
Gets a Service Configuration
TunneledServicesService_getServiceConfiguration 2 params → 200400401500
PUT
/v1/accounts/{accountName}/tunnels/{tunnelId}/services-configuration
Configures Tunnel Services
TunneledServicesService_putServiceConfiguration 2 params body → 200400401500

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are Zuplo.Tunnels.TunneledServicesProvisioningOperation (4 properties), Zuplo.Tunnels.TunneledServiceConfiguration (3 properties), Zuplo.Tunnels.TunneledServicesConfiguration (2 properties), Zuplo.HttpProblemDetails.BadRequestProblemResponse (2 properties). Each schema is shown below with its type and property counts.

Zuplo.Tunnels.TunneledServiceConfiguration
object
Tunnel service configuration.
3 properties 3 required
Zuplo.HttpProblemDetails.UnauthorizedProblemResponse
object
2 properties 2 required
Zuplo.HttpProblemDetails.InternalServerErrorProblemResponse
object
2 properties 2 required
Zuplo.Tunnels.TunneledServicesProvisioningOperation
object
4 properties 2 required
Zuplo.HttpProblemDetails.BadRequestProblemResponse
object
2 properties 2 required
Zuplo.Tunnels.TunneledServicesConfiguration
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zuplo-tunnel-services-api-openapi.yml Raw ↑

Other APIs Zuplo publishes across the network.

Zuplo API Keys - Buckets API
Zuplo API Keys - Consumers API
Zuplo API Keys - Keys API
Zuplo API Keys - Managers API
Zuplo Audit Logs API
Zuplo Custom Domains API
Zuplo Deployments API
Zuplo MCP Servers API
Zuplo Openapi API
Zuplo Tunnels API
Zuplo Variables API
Zuplo Who Am I API