> ## 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.

# Render rclone configuration

> Render an rclone config file for the caller's organization object storage credentials.



## OpenAPI

````yaml https://engine.tensorpool.dev/openapi.json get /object-storage/configure/rclone
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:
  /object-storage/configure/rclone:
    get:
      tags:
        - object-storage
      summary: Render rclone configuration
      description: >-
        Render an rclone config file for the caller's organization object
        storage credentials.
      operationId: configure_rclone_object_storage_configure_rclone_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectStorageRcloneConfigResponse'
      security:
        - HTTPBearer: []
components:
  schemas:
    ObjectStorageRcloneConfigResponse:
      properties:
        remote_name:
          type: string
          title: Remote Name
          description: Rclone remote name
        endpoint:
          type: string
          title: Endpoint
          description: S3 endpoint URL
        region:
          type: string
          title: Region
          description: S3 region
        rclone_config:
          type: string
          title: Rclone Config
          description: Rendered rclone config text
      type: object
      required:
        - remote_name
        - endpoint
        - region
        - rclone_config
      title: ObjectStorageRcloneConfigResponse
      description: Response model for rendered rclone configuration.
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````