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

# Get GPU cluster connections

> SSH for the primary node and every member, plus each node's address on the private interconnect. Empty until the cluster is running. Requires compute `manage` access.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/gpu/clusters/{clusterId}/connections
openapi: 3.0.3
info:
  title: AI Reserve Gateway API
  description: >-
    The AI Reserve API surface — OpenAI-compatible chat completions,
    Anthropic-compatible messages, Bedrock Converse, images, video, files,
    text-to-speech, realtime voice sessions, and provider-hidden GPU
    infrastructure — all behind one endpoint and one API key.
  version: 1.0.0
servers:
  - url: https://api.aireserve.com
security:
  - bearerAuth: []
tags:
  - name: Customers
    description: >-
      Per-end-customer usage, cost, and billable amounts for organizations that
      tag requests with their own customers.
  - name: GPU Infrastructure
    description: >-
      Provision and manage provider-hidden GPU instances. The recommended
      Instances API accepts workload requirements and an hourly price ceiling;
      AI Reserve handles provider placement internally. Every mutation is
      asynchronous and returns an operation to poll.
  - name: Customer keys
    description: >-
      Mint, list, and revoke API keys pinned to your own end customers (and
      their organizations), so spend splits per customer without per-request
      tagging.
paths:
  /v1/gpu/clusters/{clusterId}/connections:
    get:
      tags:
        - GPU Infrastructure
      summary: Get GPU cluster connections
      description: >-
        SSH for the primary node and every member, plus each node's address on
        the private interconnect. Empty until the cluster is running. Requires
        compute `manage` access.
      operationId: getGpuClusterConnections
      parameters:
        - name: clusterId
          in: path
          required: true
          schema:
            format: uuid
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  available:
                    type: boolean
                    description: True once the primary node accepts SSH.
                  primary:
                    nullable: true
                    description: >-
                      The rank-0 node: `MASTER_ADDR` host, Slurm controller or
                      Ray head.
                    type: object
                    properties:
                      rank:
                        type: number
                        enum:
                          - 0
                      ssh:
                        nullable: true
                        type: object
                        properties:
                          command:
                            type: string
                          user:
                            type: string
                          host:
                            type: string
                          port:
                            type: integer
                            minimum: -9007199254740991
                            maximum: 9007199254740991
                        required:
                          - command
                          - user
                          - host
                          - port
                        additionalProperties: false
                    required:
                      - rank
                      - ssh
                    additionalProperties: false
                  nodes:
                    type: array
                    items:
                      type: object
                      properties:
                        rank:
                          nullable: true
                          type: integer
                          minimum: -9007199254740991
                          maximum: 9007199254740991
                        role:
                          nullable: true
                          type: string
                        overlayIp:
                          nullable: true
                          type: string
                        ssh:
                          nullable: true
                          type: object
                          properties:
                            command:
                              type: string
                            user:
                              type: string
                            host:
                              type: string
                            port:
                              type: integer
                              minimum: -9007199254740991
                              maximum: 9007199254740991
                          required:
                            - command
                            - user
                            - host
                            - port
                          additionalProperties: false
                      required:
                        - rank
                        - role
                        - overlayIp
                        - ssh
                      additionalProperties: false
                  network:
                    nullable: true
                    description: The private interconnect's address block.
                    type: object
                    properties:
                      cidr:
                        type: string
                    required:
                      - cidr
                    additionalProperties: false
                required:
                  - available
                  - primary
                  - nodes
                  - network
                additionalProperties: false
                description: Where to connect. Empty until the cluster is running.
        '400':
          description: Invalid request, missing Idempotency-Key, or schema violation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComputeError'
        '401':
          description: Missing or invalid API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComputeError'
        '403':
          description: Key lacks the required compute access (`read` or `manage`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComputeError'
        '404':
          description: Resource not found or owned by another organization.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComputeError'
      security:
        - bearerAuth: []
        - apiKeyAuth: []
components:
  schemas:
    ComputeError:
      type: object
      properties:
        error:
          type: object
          properties:
            message:
              type: string
            type:
              type: string
              enum:
                - invalid_request_error
                - authentication_error
                - permission_error
                - server_error
            param:
              nullable: true
              type: string
            code:
              type: string
              description: >-
                Machine-readable Compute error code, e.g. `quote_expired`,
                `price_changed`, `operation_conflict`, `no_capacity`,
                `volume_in_use`, `insufficient_funds`,
                `compute_access_required`, `not_found`.
            details:
              description: >-
                Machine-readable context for some codes. For `no_capacity` see
                `ComputeNoCapacityDetails`.
              type: object
              additionalProperties: {}
          required:
            - message
            - type
            - param
            - code
          additionalProperties: false
      required:
        - error
      additionalProperties: false
      description: OpenAI-shaped error envelope returned on every 4xx/5xx.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Your AI Reserve API key (aireserve_api_…) from the API Keys page in the
        portal (https://portal.aireserve.com/keys).
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: The same API key sent as an `x-api-key` header.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.