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

Answer a fresh signed URL for a signed port

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.

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 sign

orl sandbox port sign <sandbox-id> <port>
POST
/v1/sandboxes/{sandboxId}/ports/{port}/sign

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

Request Body

application/json
  1. body
expiresInSeconds?integer

The signed URL's life, cut to the sandbox's end.

Range1 <= value <= 86400
Default3600

Response Body

The signed URL

application/json
  1. response
port*integer
url*string
Formaturi
access?"signed"

signed on a signed port's answer; a public port's answer has no access.

Value in"signed"
expiresAt?string

When a signed URL stops opening the port.

Formatdate-time
Example Request
curl -X POST 'https://api.openrelay.inc/v1/sandboxes/string/ports/1/sign' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "port": 0,  "url": "http://example.com",  "access": "signed",  "expiresAt": "2019-08-24T14:15:22Z"}

Stop exposing a port of a sandbox DELETE

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.

Pause a sandbox POST

Saves a sandbox's memory and disk on its host, then stops it to release CPU and memory. Resume restores its files and processes. Answers once the snapshot is written. Open connections do not survive. While paused it is charged for neither CPU nor memory, its timeout still counts, and every call that needs it running answers 409 SANDBOX_PAUSED until resume; get, list and kill answer as usual. Pausing a paused sandbox answers it as it is, so a retry is safe.