Skip to content
OpenRelay is in early access, and the /v1 API is stable. New capabilities ship in the changelog.
Skip to Content
PricingDashboard
GuidesAPI ReferenceCLI
API ReferenceComputeSandboxes

Stop exposing a port of a sandbox

Stops traffic to an exposed sandbox port and invalidates its public and signed URLs within 5 seconds. Repeating the call is safe. A port that is not exposed answers the same. Exposing the port again makes new URLs: none signed before opens it.

Required permission

Requires the sandboxes.exec permission. See Permissions for the roles and API key permissions that include it.

Command line

The orl CLI wraps this endpoint:

Guided workflow: orl sandbox port unexpose

orl sandbox port unexpose <sandbox-id> <port>
DELETE
/v1/sandboxes/{sandboxId}/ports/{port}

Authorization

apiKey
headerAuthorizationBearer <token>

OpenRelay API key. Send it as Authorization: Bearer or_… (legacy vl_… keys still work).

Path Parameters

sandboxId*string
port*integer
Range1 <= value <= 65535

Response Body

The port is not exposed

Example Request
curl -X DELETE 'https://api.openrelay.inc/v1/sandboxes/string/ports/1'
Example Response
Empty

Expose a port of a sandbox at a public URL POST

Allows traffic to a port in the sandbox and answers the URL that reaches it. Exposing a public port again answers the same URL. With access signed, only a URL that carries a signature the router made reaches the port, and the answer is such a URL, valid for expiresInSeconds (default 3600) and never past the sandbox's end. Exposing a signed port again answers a fresh signed URL, and the URLs answered before keep working until their expiry or until the port is unexposed. Without the organization's signed previews, access signed is refused with 400.

Answer a fresh signed URL for a signed port POST

Issues a fresh signed URL for an exposed signed port. Its validity defaults to 3600 seconds and cannot extend past the sandbox's end. Set expiresInSeconds to choose its validity. A port that is not exposed answers 404 PORT_NOT_EXPOSED, and a public one answers 400.