Open Port
curl --request POST \
--url https://api.voyager.so/v1/machines/{machine}/ports \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"port": 32768
}'import requests
url = "https://api.voyager.so/v1/machines/{machine}/ports"
payload = { "port": 32768 }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({port: 32768})
};
fetch('https://api.voyager.so/v1/machines/{machine}/ports', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"port": 123,
"url": "<string>",
"expires_at": "<string>"
}{
"error": {
"type": "invalid_request",
"code": "invalid_request",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"retryable": true,
"retry_after_ms": 123,
"param": "<string>",
"details": {}
}
}{
"error": {
"type": "invalid_request",
"code": "invalid_request",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"retryable": true,
"retry_after_ms": 123,
"param": "<string>",
"details": {}
}
}{
"error": {
"type": "invalid_request",
"code": "invalid_request",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"retryable": true,
"retry_after_ms": 123,
"param": "<string>",
"details": {}
}
}{
"error": {
"type": "invalid_request",
"code": "invalid_request",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"retryable": true,
"retry_after_ms": 123,
"param": "<string>",
"details": {}
}
}{
"error": {
"type": "invalid_request",
"code": "invalid_request",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"retryable": true,
"retry_after_ms": 123,
"param": "<string>",
"details": {}
}
}{
"error": {
"type": "invalid_request",
"code": "invalid_request",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"retryable": true,
"retry_after_ms": 123,
"param": "<string>",
"details": {}
}
}{
"error": {
"type": "invalid_request",
"code": "invalid_request",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"retryable": true,
"retry_after_ms": 123,
"param": "<string>",
"details": {}
}
}{
"error": {
"type": "invalid_request",
"code": "invalid_request",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"retryable": true,
"retry_after_ms": 123,
"param": "<string>",
"details": {}
}
}Open Port
Serve a port on the machine at a public https://<id>.run.voyager.computer/ link (HTTP and WebSocket). Anyone
with the link can reach it while the machine runs.
POST
/
machines
/
{machine}
/
ports
Open Port
curl --request POST \
--url https://api.voyager.so/v1/machines/{machine}/ports \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"port": 32768
}'import requests
url = "https://api.voyager.so/v1/machines/{machine}/ports"
payload = { "port": 32768 }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({port: 32768})
};
fetch('https://api.voyager.so/v1/machines/{machine}/ports', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"port": 123,
"url": "<string>",
"expires_at": "<string>"
}{
"error": {
"type": "invalid_request",
"code": "invalid_request",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"retryable": true,
"retry_after_ms": 123,
"param": "<string>",
"details": {}
}
}{
"error": {
"type": "invalid_request",
"code": "invalid_request",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"retryable": true,
"retry_after_ms": 123,
"param": "<string>",
"details": {}
}
}{
"error": {
"type": "invalid_request",
"code": "invalid_request",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"retryable": true,
"retry_after_ms": 123,
"param": "<string>",
"details": {}
}
}{
"error": {
"type": "invalid_request",
"code": "invalid_request",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"retryable": true,
"retry_after_ms": 123,
"param": "<string>",
"details": {}
}
}{
"error": {
"type": "invalid_request",
"code": "invalid_request",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"retryable": true,
"retry_after_ms": 123,
"param": "<string>",
"details": {}
}
}{
"error": {
"type": "invalid_request",
"code": "invalid_request",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"retryable": true,
"retry_after_ms": 123,
"param": "<string>",
"details": {}
}
}{
"error": {
"type": "invalid_request",
"code": "invalid_request",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"retryable": true,
"retry_after_ms": 123,
"param": "<string>",
"details": {}
}
}{
"error": {
"type": "invalid_request",
"code": "invalid_request",
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>",
"retryable": true,
"retry_after_ms": 123,
"param": "<string>",
"details": {}
}
}Authorizations
API key from Settings > Developer > REST API
Path Parameters
Body
application/json
The port on the machine.
Required range:
1 <= x <= 65535