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

# Test SFTP connection

> **Deprecated** — use `POST /connections/{id}/test-connection` instead.



## OpenAPI

````yaml /api-reference/openapi.json post /clients/{id}/test-connection
openapi: 3.0.3
info:
  title: FileFeed API
  version: '2026-05-25'
  description: >-
    Official FileFeed REST API for connections, pipelines, schemas, pipeline
    runs, webhooks, outbound uploads, documents, files, and notifications.
    Date-based API versioning is controlled by the `FileFeed-Version` request
    header (default `2024-09-01`; latest `2026-05-25`); this document describes
    the `2026-05-25` shape.
servers:
  - url: https://api.sftpsync.io
security:
  - ApiKeyAuth: []
tags:
  - name: Connections
  - name: Pipelines
  - name: Schemas
  - name: Pipeline Runs
  - name: Webhooks
  - name: Outbound Uploads
  - name: Documents
  - name: Files
  - name: Notifications
  - name: Clients (deprecated)
paths:
  /clients/{id}/test-connection:
    post:
      tags:
        - Clients (deprecated)
      summary: Test SFTP connection
      description: '**Deprecated** — use `POST /connections/{id}/test-connection` instead.'
      operationId: testClientConnection
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Connection result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestConnectionResponse'
              example:
                success: true
                message: Connected
      deprecated: true
components:
  schemas:
    TestConnectionResponse:
      type: object
      properties:
        success:
          type: boolean
        message:
          type: string
      required:
        - success
        - message
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key

````