Port Exposure

POST/v1/sandbox/{sessionId}/ports

POST/v1/sandbox/{'{sessionId}'}/ports

Base URL *

Your instance endpoint, shown on the instance page in the dashboard. Each instance has its own host; there is no shared API host.

Authorization (Bearer token)

sessionId (path) *

Request Body (JSON)

Parameters

Name	In	Type	Required	Description
`sessionId`	path	`string`	Yes

Request Body

Property	Type	Required
`tenantId`	`string`	No
`port`	`integer`	No
`protocol`	`string`	No

Responses

200 Expose a sandbox port via subdomain

Property	Type	Description
`mapping`	`object`

default An unexpected error response.

Property	Type	Description
`code`	`integer`
`message`	`string`
`details`	`object[]`

Request

curl -X POST "https://{instance}.{region}.everstack.ai/v1/sandbox/{sessionId}/ports" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"tenantId":"string","port":0,"protocol":"string"}'

const response = await fetch("https://{instance}.{region}.everstack.ai/v1/sandbox/{sessionId}/ports", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
  "tenantId": "string",
  "port": 0,
  "protocol": "string"
}),
});
const data = await response.json();

import requests

response = requests.post(
    "https://{instance}.{region}.everstack.ai/v1/sandbox/{sessionId}/ports",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Content-Type": "application/json",
    },
    json={
  "tenantId": "string",
  "port": 0,
  "protocol": "string"
},
)
data = response.json()

Response

{
  "mapping": {
    "id": "string",
    "sandboxId": "string",
    "port": 0,
    "protocol": "string",
    "subdomain": "string",
    "url": "string",
    "status": "string",
    "createdAt": "2024-01-01T00:00:00Z"
  }
}

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}