> ## 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 access session

> Retrieves the details of a single transient access session.



## OpenAPI

````yaml /api/en/control-plane.yaml get /control-plane/{siteId}/transient-accesses/{accessId}
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-accesses/{accessId}:
    parameters:
      - $ref: '#/components/parameters/SiteId'
      - $ref: '#/components/parameters/AccessId'
    get:
      tags:
        - Transient Access
      summary: Retrieve a transient access session
      description: Retrieves the details of a single transient access session.
      responses:
        '200':
          description: The transient access object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransientAccess'
        '401':
          description: Unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found - The specified site or access session 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
    AccessId:
      name: accessId
      in: path
      required: true
      description: The unique identifier for the transient access session.
      schema:
        type: string
        format: uuid
        example: f0e9d8c7-b6a5-4f3e-2d1c-0b9a8e7f6d5c
  schemas:
    TransientAccess:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: The unique identifier for the transient access session.
          example: f0e9d8c7-b6a5-4f3e-2d1c-0b9a8e7f6d5c
        username:
          type: string
          description: The temporary username for this session.
          example: transient-user-abc123
        password:
          type: string
          description: The temporary password for this session.
          example: P@ssw0rdABC123XYZ
        port:
          type: integer
          description: The public port on the Altostrat management server to connect to.
          example: 45821
        type:
          type: string
          description: The type of access protocol.
          enum:
            - winbox
            - ssh
          example: winbox
        full_access:
          type: boolean
          description: Whether the session has full administrative privileges.
          example: true
        allow_rfc1918:
          type: boolean
          description: Whether access is allowed from private (RFC1918) IP ranges.
          example: false
        allow_only_cidr:
          type: string
          description: The source CIDR that is exclusively allowed to connect.
          example: 198.51.100.10/32
        revoked_early:
          type: boolean
          description: True if the session was manually revoked before it expired.
          example: false
        expires_at:
          type: string
          format: date-time
          description: The timestamp when this session will automatically expire.
          example: '2025-10-29T12:15:49Z'
        expired:
          type: boolean
          description: True if the session has expired or been revoked.
          example: false
        entry_point:
          type: string
          description: The hostname of the Altostrat management server to connect to.
          example: edge-us-east-1a.ostrat.io
        time_to_expire:
          type: string
          description: >-
            A human-readable string indicating how long until the session
            expires.
          example: 15 minutes from now
        onclick:
          type: string
          description: A Winbox connection string for easy one-click access.
          example: >-
            winbox://edge-us-east-1a.ostrat.io:45821?username=transient-user-abc123&password=P@ssw0rdABC123XYZ
    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.

````