Skip to content

Create request tunnel

POST
/v1/requests/{id}/tunnel

Creates a tunnel for an active request environment and returns issued credentials

id
required
string

Request ID

Optional tunnel provider selection

object
provider
string
Allowed values: cloudflare ngrok

Created

object
data
object
issued_credentials
Array<object>
object
secret
string
type
string
username
string
tunnel
object
api_url
string
created_at
string
credentials
Array<object>
object
id
string
is_active
boolean
last_used_at
string
secret_preview
string
type
string
use_count
integer
username
string
edge_url
string
explorer_url
string
id
string
last_error
string
provider
string
public_url
string
sidecar_name
string
status
string
updated_at
string
usage_events
Array<object>
object
action_type
string
id
string
ip_address
string
metadata
timestamp
string
success
boolean

Bad Request

object
error
string
message
string
Example
Success
success
boolean
Example
true

Unauthorized

object
error
string
message
string
Example
Success
success
boolean
Example
true

Not Found

object
error
string
message
string
Example
Success
success
boolean
Example
true

Conflict

object
error
string
message
string
Example
Success
success
boolean
Example
true

Internal Server Error

object
error
string
message
string
Example
Success
success
boolean
Example
true

Service Unavailable

object
error
string
message
string
Example
Success
success
boolean
Example
true