> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.xapi.to/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.xapi.to/_mcp/server.

# 获取端口访问地址

GET https://sandbox.xapi.to/v1/sandboxes/{id}/ports/{port}

实例内的服务必须已监听该端口，且 offering 声明 ports 能力。

Reference: https://docs.xapi.to/sandbox/api-reference/execution/get-port-url

## Authentication

- `XAPI-Key` header (required) — 在 xAPI Console 创建的 API Key。只会发送给 *.xapi.to。

## Servers

- `https://sandbox.xapi.to` (Production, default)
- `https://sandbox.test.xapi.to` (Test)

## Request

### Path parameters

- `id` (string, required) — xAPI Sandbox 实例 UUID。
- `port` (integer, required) — Sandbox 内应用实际监听的 TCP 端口号；获取 URL 不会替你启动该服务。

## Response

### 200

公网访问地址

- `port` (integer, required) — 映射的 Sandbox 内部端口。
- `url` (string, required) — 临时公网/代理访问地址；返回 URL 不保证应用、DNS 和 TLS 已就绪，应外部请求验证 marker。
- `token` (string, optional) — 访问该临时 URL 的短期令牌；属于敏感数据，不应写入日志或公开页面。
- `headers` (map from string to string, optional) — 访问 URL 时必须附带的 HTTP 请求头；可能包含敏感临时凭证。

## Examples

**Response**

```json
{
  "port": 8080,
  "url": "https://preview.example.invalid",
  "token": "REDACTED",
  "headers": {}
}
```

**SDK Code**

```python
import requests

url = "https://sandbox.xapi.to/v1/sandboxes/33333333-3333-4333-8333-333333333333/ports/8080"

headers = {"XAPI-Key": "<apiKey>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://sandbox.xapi.to/v1/sandboxes/33333333-3333-4333-8333-333333333333/ports/8080';
const options = {method: 'GET', headers: {'XAPI-Key': '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox.xapi.to/v1/sandboxes/33333333-3333-4333-8333-333333333333/ports/8080"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("XAPI-Key", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://sandbox.xapi.to/v1/sandboxes/33333333-3333-4333-8333-333333333333/ports/8080")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["XAPI-Key"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://sandbox.xapi.to/v1/sandboxes/33333333-3333-4333-8333-333333333333/ports/8080")
  .header("XAPI-Key", "<apiKey>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://sandbox.xapi.to/v1/sandboxes/33333333-3333-4333-8333-333333333333/ports/8080', [
  'headers' => [
    'XAPI-Key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://sandbox.xapi.to/v1/sandboxes/33333333-3333-4333-8333-333333333333/ports/8080");
var request = new RestRequest(Method.GET);
request.AddHeader("XAPI-Key", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["XAPI-Key": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://sandbox.xapi.to/v1/sandboxes/33333333-3333-4333-8333-333333333333/ports/8080")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```