---
title: "Create an SFTP destination"
method: POST
path: "/v6/sftp-destinations"
tags: ["SFTP Servers"]
---

# Create an SFTP destination

`POST /v6/sftp-destinations`

Creates a new SFTP destination connection profile used for automated report file delivery. Returns the created destination with its server-assigned id.

## Request body

- union — Body of a `POST /v6/sftp-destinations` request.
  - object — External sftp destination create request.
    - `extole_key_id` string
    - `name` string
    - `partner_key_id` string
    - `type` 'EXTERNAL', required
    - `dropbox_path` string
    - `host` string, required
    - `key_id` string, required
    - `port` integer
    - `username` string, required
  - object — Extole local sftp destination create request.
    - `extole_key_id` string
    - `name` string
    - `partner_key_id` string
    - `type` 'LOCAL', required
    - `file_processing_enabled` boolean
    - `key_ids` string[], required
    - `username` string

## Response `200`

Successful response

- union
  - ExternalSftpDestinationResponse — External sftp destination response.
    - `created_date` string, required — [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds.
    - `dropbox_path` string, required
    - `extole_key_id` string, required
    - `host` string, required
    - `id` string, required
    - `name` string, required
    - `partner_key_id` string, nullable, required
    - `port` integer, required
    - `type` 'EXTERNAL', required
    - `updated_date` string, required — [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds.
    - `username` string, required
    - `key_id` string, required
  - LocalSftpDestinationResponse — Extole local sftp destination response.
    - `created_date` string, required — [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds.
    - `dropbox_path` string, required
    - `extole_key_id` string, required
    - `host` string, required
    - `id` string, required
    - `name` string, required
    - `partner_key_id` string, nullable, required
    - `port` integer, required
    - `type` 'LOCAL', required
    - `updated_date` string, required — [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds.
    - `username` string, required
    - `file_processing_enabled` boolean, required
    - `key_ids` string[], required

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `402` — Payment Required
- `403` — Forbidden
- `415` — Unsupported Media Type
- `429` — Too Many Requests

---

[API](https://skmtc.net/extole/apis/integration-api-server-to-extole.md) · [All operations](https://skmtc.net/extole/apis/integration-api-server-to-extole/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/extole/integration-api-server-to-extole/revisions/c16e62e66755/schema)