Skip to main content
GET
/
sites
/
{siteId}
/
transient-forward
/
{forwardId}
Retrieve a transient port forward
curl --request GET \
  --url https://api.altostrat.io/sites/{siteId}/transient-forward/{forwardId} \
  --header 'Authorization: Bearer <token>'
{
  "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"

โ€‹
forwardId
string<uuid>
required

The unique identifier for the transient port forward.

Example:

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

Response

The 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"