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

# Get SSH command for instance

> Generate a platform-specific SSH command to connect to a cluster instance.



## OpenAPI

````yaml https://engine.tensorpool.dev/openapi.json get /ssh/{instance_id}
openapi: 3.1.0
info:
  title: TensorPool API
  description: >
    TensorPool API


    All API endpoints (except `/healthz`) require authentication using your
    TensorPool API key.


    ### For REST Endpoints


    Include your API key in the `Authorization` header as a Bearer token:


    ```bash

    Authorization: Bearer YOUR_TENSORPOOL_KEY

    ```

    ### For WebSocket Endpoints


    Send your API key as the first message in JSON format:


    ```json

    {"TENSORPOOL_KEY": "YOUR_TENSORPOOL_KEY"}

    ```
  version: 0.1.0
servers: []
security: []
tags:
  - name: job
    description: >-
      GPU job execution and management. Run workloads on ephemeral clusters with
      automatic cleanup.
  - name: cluster
    description: >-
      GPU cluster provisioning and lifecycle management. Create persistent
      compute resources.
  - name: storage
    description: >-
      Shared storage volume management. Persistent storage that can be attached
      to eligible clusters.
  - name: object-storage
    description: S3-compatible object storage management.
  - name: ssh
    description: SSH key management for secure cluster access.
  - name: user
    description: >-
      User account management including balance, billing, and organization
      operations.
  - name: requests
    description: Cloud resource provisioning request tracking and status monitoring.
paths:
  /ssh/{instance_id}:
    get:
      tags:
        - ssh
      summary: Get SSH command for instance
      description: >-
        Generate a platform-specific SSH command to connect to a cluster
        instance.
      operationId: ssh_connect_ssh__instance_id__get
      parameters:
        - name: instance_id
          in: path
          required: true
          schema:
            type: string
            description: Instance ID or instance name
            title: Instance Id
          description: Instance ID or instance name
        - name: system
          in: query
          required: true
          schema:
            enum:
              - windows
              - linux
              - darwin
              - Windows
              - Linux
              - Darwin
            type: string
            description: Operating system type for SSH command generation
            title: System
          description: Operating system type for SSH command generation
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SSHCommandResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    SSHCommandResponse:
      properties:
        command:
          type: string
          title: Command
      type: object
      required:
        - command
      title: SSHCommandResponse
      description: Response model for SSH command endpoint.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````