> ## Documentation Index
> Fetch the complete documentation index at: https://altostrat.io/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Retrieve a transient port forward

> Retrieves the details of a single transient port forwarding rule.



## OpenAPI

````yaml /api/en/control-plane.yaml get /control-plane/{siteId}/transient-forward/{forwardId}
openapi: 3.0.3
info:
  title: Altostrat Control Plane API
  version: 1.0.0
  description: >-
    The Altostrat Control Plane API is the microservice responsible for managing
    the configuration, security policies, and on-demand access for individual
    MikroTik network sites.


    It serves as the central orchestration layer within the Altostrat SDX
    platform, translating high-level user configurations into actionable
    commands and secure access rules for managed network devices.


    This API allows you to programmatically manage:

    - **Policies:** Centralized firewall and service management rules that
    define how sites behave and what traffic is permitted.

    - **Transient Access:** Secure, time-limited SSH and Winbox connections to
    your devices for remote diagnostics and maintenance, without exposing them
    permanently to the internet.

    - **API Credentials:** The unique credentials used by the Altostrat platform
    to securely communicate with and manage each of your network sites.


    Developers use this API to automate network security configurations, manage
    device access policies, and create temporary, secure connections for remote
    operations.
servers:
  - url: https://v1.api.altostrat.io
    description: Production API Server
security:
  - bearerAuth: []
tags:
  - name: Policies
    description: Manage firewall and service access policies for sites.
  - name: Transient Access
    description: Create and manage temporary, secure administrative access to sites.
  - name: Transient Port Forwarding
    description: >-
      Create and manage temporary, secure port forwards to devices behind a
      site.
  - name: Site Operations
    description: Perform actions and manage configurations for specific sites.
  - name: Site Notes
    description: Read and update the note attached to a managed site.
paths:
  /control-plane/{siteId}/transient-forward/{forwardId}:
    parameters:
      - $ref: '#/components/parameters/SiteId'
      - $ref: '#/components/parameters/ForwardId'
    get:
      tags:
        - Transient Port Forwarding
      summary: Retrieve a transient port forward
      description: Retrieves the details of a single transient port forwarding rule.
      responses:
        '200':
          description: The transient port forward object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransientPort'
        '401':
          description: Unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found - The specified site or forwarding rule does not exist.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  parameters:
    SiteId:
      name: siteId
      in: path
      required: true
      description: The unique identifier for the site.
      schema:
        type: string
        format: uuid
        example: d290f1ee-6c54-4b01-90e6-d701748f0851
    ForwardId:
      name: forwardId
      in: path
      required: true
      description: The unique identifier for the transient port forward.
      schema:
        type: string
        format: uuid
        example: c4b3a291-8765-4fed-ba98-76543210fedc
  schemas:
    TransientPort:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: The unique identifier for the transient port forward.
          example: c4b3a291-8765-4fed-ba98-76543210fedc
        port:
          type: integer
          description: >-
            The public port on the Altostrat management server that forwards
            traffic.
          example: 52101
        revoked_early:
          type: boolean
          description: True if the forward was manually revoked before it expired.
          example: false
        allow_only_cidr:
          type: string
          description: >-
            The source CIDR that is exclusively allowed to connect to the
            forwarded port.
          example: 203.0.113.42/32
        expires_at:
          type: string
          format: date-time
          description: The timestamp when this port forward will automatically be removed.
          example: '2025-10-29T14:30:00Z'
        expired:
          type: boolean
          description: True if the port forward has expired or been revoked.
          example: false
        entry_point:
          type: string
          description: >-
            The hostname of the Altostrat management server where the port is
            open.
          example: edge-us-east-1a.ostrat.io
        dst_address:
          type: string
          format: ipv4
          description: >-
            The destination private IP address on the site's LAN to forward
            traffic to.
          example: 192.168.88.10
        dst_port:
          type: integer
          description: The destination port on the private device.
          example: 3389
        time_to_expire:
          type: string
          description: >-
            A human-readable string indicating how long until the forward
            expires.
          example: 30 minutes from now
    ErrorResponse:
      type: object
      properties:
        type:
          type: string
          description: A broad category for the error (e.g., 'invalid_request_error').
          example: invalid_request_error
        code:
          type: string
          description: A short, unique string identifying the specific error.
          example: parameter_missing
        message:
          type: string
          description: A human-readable description of what went wrong.
          example: The 'name' parameter is required for this request.
        doc_url:
          type: string
          description: >-
            A direct link to the documentation page for this specific error
            code.
          example: https://docs.altostrat.io/errors/parameter_missing
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Enter your JWT bearer token.

````