Skip to main content
POST
/
sites
/
{siteId}
/
transient-forward
Create a transient port forward
curl --request POST \
  --url https://api.altostrat.io/sites/{siteId}/transient-forward \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "expire_after_minutes": 120,
  "allow_only_cidr": "203.0.113.42/32",
  "dst_address": "192.168.88.25",
  "dst_port": 8080
}'
{
  "id": "c4b3a291-8765-4fed-ba98-76543210fedc",
  "port": 52101,
  "revoked_early": false,
  "allow_only_cidr": "203.0.113.42/32",
  "expires_at": "2025-10-29T14:30:00Z",
  "expired": false,
  "entry_point": "edge-us-east-1a.ostrat.io",
  "dst_address": "192.168.88.10",
  "dst_port": 3389,
  "time_to_expire": "30 minutes from now"
}

Authorizations

​
Authorization
string
header
required

Enter your JWT bearer token.

Path Parameters

​
siteId
string<uuid>
required

The unique identifier for the site.

Example:

"d290f1ee-6c54-4b01-90e6-d701748f0851"

Body

application/json
​
expire_after_minutes
integer
required

The number of minutes until the port forward automatically expires.

Required range: 15 <= x <= 1440
Example:

120

​
allow_only_cidr
string
required

Restrict access to a single source IP address or CIDR range.

Example:

"203.0.113.42/32"

​
dst_address
string<ipv4>
required

The destination private IP address on the site's LAN.

Example:

"192.168.88.25"

​
dst_port
integer
required

The destination port on the private device.

Required range: 1 <= x <= 65535
Example:

8080

Response

The newly created transient port forward object.

​
id
string<uuid>

The unique identifier for the transient port forward.

Example:

"c4b3a291-8765-4fed-ba98-76543210fedc"

​
port
integer

The public port on the Altostrat management server that forwards traffic.

Example:

52101

​
revoked_early
boolean

True if the forward was manually revoked before it expired.

Example:

false

​
allow_only_cidr
string

The source CIDR that is exclusively allowed to connect to the forwarded port.

Example:

"203.0.113.42/32"

​
expires_at
string<date-time>

The timestamp when this port forward will automatically be removed.

Example:

"2025-10-29T14:30:00Z"

​
expired
boolean

True if the port forward has expired or been revoked.

Example:

false

​
entry_point
string

The hostname of the Altostrat management server where the port is open.

Example:

"edge-us-east-1a.ostrat.io"

​
dst_address
string<ipv4>

The destination private IP address on the site's LAN to forward traffic to.

Example:

"192.168.88.10"

​
dst_port
integer

The destination port on the private device.

Example:

3389

​
time_to_expire
string

A human-readable string indicating how long until the forward expires.

Example:

"30 minutes from now"