Extole SFTP Servers API
The SFTP Servers API from Extole — 4 operation(s) for sftp servers.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/extole-sftp-servers-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
OpenAPI Specification
openapi: 3.2.0
info:
description: 'Consumer-to-Extole integration endpoints: consumer event submission, zone rendering, profile management, and SDK-backing operations for browser and native app environments.'
title: Integration API - Consumer to Extole Audiences SFTP Servers API
version: '1.0'
servers:
- description: Production
url: https://{brand}.extole.io
variables:
brand:
default: yourcompany
description: Your Extole client subdomain (e.g. 'mycompany' for mycompany.extole.io)
security:
- HEADER: []
- QUERY: []
- COOKIE: []
tags:
- name: SFTP Servers
paths:
/v6/sftp-destinations:
get:
description: Returns all SFTP destination connection profiles configured for the client.
operationId: listSftpDestinations
parameters:
- in: query
name: type
schema:
enum:
- EXTERNAL
- LOCAL
type: string
- in: query
name: name
schema:
type: string
- in: query
name: username
schema:
type: string
- in: query
name: host
schema:
type: string
- in: query
name: limit
schema:
format: int32
type: integer
- in: query
name: offset
schema:
format: int32
type: integer
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/SftpDestinationResponse'
type: array
description: Successful response
'400':
content:
application/json:
examples:
binding_error:
$ref: '#/components/examples/binding_error'
invalid_json:
$ref: '#/components/examples/invalid_json'
invalid_parameter:
$ref: '#/components/examples/invalid_parameter'
missing_request_body:
$ref: '#/components/examples/missing_request_body'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Bad Request
'401':
content:
application/json:
examples:
method_unauthorized:
$ref: '#/components/examples/method_unauthorized'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Unauthorized
'402':
content:
application/json:
examples:
payment_required:
$ref: '#/components/examples/payment_required'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Payment Required
'403':
content:
application/json:
examples:
access_denied:
$ref: '#/components/examples/access_denied'
method_unauthorized:
$ref: '#/components/examples/method_unauthorized'
missing_access_token:
$ref: '#/components/examples/missing_access_token'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Forbidden
'415':
content:
application/json:
examples:
unsupported_media_type:
$ref: '#/components/examples/unsupported_media_type'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Unsupported Media Type
'429':
content:
application/json:
examples:
too_many_requests:
$ref: '#/components/examples/too_many_requests'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Too Many Requests
summary: List SFTP destinations
tags:
- SFTP Servers
x-extole-bundle: integration-server-to-extole
x-extole-visibility: visible
post:
description: Creates a new SFTP destination connection profile used for automated report file delivery. Returns the created destination with its server-assigned id.
operationId: createSftpDestination
requestBody:
content:
application/json:
example:
dropbox_path: dropbox_path
extole_key_id: extole_key_id
host: host
key_id: key_id
name: name
partner_key_id: partner_key_id
port: 1
type: EXTERNAL
username: username
schema:
$ref: '#/components/schemas/SftpDestinationCreateRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SftpDestinationResponse'
description: Successful response
'400':
content:
application/json:
examples:
binding_error:
$ref: '#/components/examples/binding_error'
external_sftp_destination_invalid_username:
$ref: '#/components/examples/external_sftp_destination_invalid_username'
invalid_json:
$ref: '#/components/examples/invalid_json'
invalid_parameter:
$ref: '#/components/examples/invalid_parameter'
local_sftp_destination_invalid_username:
$ref: '#/components/examples/local_sftp_destination_invalid_username'
missing_request_body:
$ref: '#/components/examples/missing_request_body'
sftp_destination_client_key_not_found:
$ref: '#/components/examples/sftp_destination_client_key_not_found'
sftp_destination_duplicated_name:
$ref: '#/components/examples/sftp_destination_duplicated_name'
sftp_destination_duplicated_username:
$ref: '#/components/examples/sftp_destination_duplicated_username'
sftp_destination_invalid_dropbox_path:
$ref: '#/components/examples/sftp_destination_invalid_dropbox_path'
sftp_destination_invalid_host:
$ref: '#/components/examples/sftp_destination_invalid_host'
sftp_destination_invalid_key_content:
$ref: '#/components/examples/sftp_destination_invalid_key_content'
sftp_destination_invalid_key_type:
$ref: '#/components/examples/sftp_destination_invalid_key_type'
sftp_destination_invalid_name:
$ref: '#/components/examples/sftp_destination_invalid_name'
sftp_destination_invalid_port:
$ref: '#/components/examples/sftp_destination_invalid_port'
sftp_destination_missing_host:
$ref: '#/components/examples/sftp_destination_missing_host'
sftp_destination_missing_key_id:
$ref: '#/components/examples/sftp_destination_missing_key_id'
sftp_destination_missing_username:
$ref: '#/components/examples/sftp_destination_missing_username'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Bad Request
'401':
content:
application/json:
examples:
method_unauthorized:
$ref: '#/components/examples/method_unauthorized'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Unauthorized
'402':
content:
application/json:
examples:
payment_required:
$ref: '#/components/examples/payment_required'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Payment Required
'403':
content:
application/json:
examples:
access_denied:
$ref: '#/components/examples/access_denied'
method_unauthorized:
$ref: '#/components/examples/method_unauthorized'
missing_access_token:
$ref: '#/components/examples/missing_access_token'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Forbidden
'415':
content:
application/json:
examples:
unsupported_media_type:
$ref: '#/components/examples/unsupported_media_type'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Unsupported Media Type
'429':
content:
application/json:
examples:
too_many_requests:
$ref: '#/components/examples/too_many_requests'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Too Many Requests
summary: Create an SFTP destination
tags:
- SFTP Servers
x-extole-bundle: integration-server-to-extole
x-extole-visibility: visible
/v6/sftp-destinations/{sftpDestinationId}:
get:
description: Returns the SFTP destination for the specified id.
operationId: getSftpDestination
parameters:
- in: path
name: sftpDestinationId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SftpDestinationResponse'
description: Successful response
'400':
content:
application/json:
examples:
binding_error:
$ref: '#/components/examples/binding_error'
invalid_json:
$ref: '#/components/examples/invalid_json'
invalid_parameter:
$ref: '#/components/examples/invalid_parameter'
missing_request_body:
$ref: '#/components/examples/missing_request_body'
sftp_destination_not_found:
$ref: '#/components/examples/sftp_destination_not_found'
unsupported_operation:
$ref: '#/components/examples/unsupported_operation'
username_exists_on_sftp_server:
$ref: '#/components/examples/username_exists_on_sftp_server'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Bad Request
'401':
content:
application/json:
examples:
method_unauthorized:
$ref: '#/components/examples/method_unauthorized'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Unauthorized
'402':
content:
application/json:
examples:
payment_required:
$ref: '#/components/examples/payment_required'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Payment Required
'403':
content:
application/json:
examples:
access_denied:
$ref: '#/components/examples/access_denied'
method_unauthorized:
$ref: '#/components/examples/method_unauthorized'
missing_access_token:
$ref: '#/components/examples/missing_access_token'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Forbidden
'415':
content:
application/json:
examples:
unsupported_media_type:
$ref: '#/components/examples/unsupported_media_type'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Unsupported Media Type
'429':
content:
application/json:
examples:
too_many_requests:
$ref: '#/components/examples/too_many_requests'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Too Many Requests
summary: Get an SFTP destination
tags:
- SFTP Servers
x-extole-bundle: integration-server-to-extole
x-extole-visibility: visible
put:
description: Updates the SFTP destination connection profile. Only fields present in the request body are changed. Returns the updated destination.
operationId: updateSftpDestination
parameters:
- in: path
name: sftpDestinationId
required: true
schema:
type: string
requestBody:
content:
application/json:
example:
dropbox_path: dropbox_path
extole_key_id: extole_key_id
host: host
key_id: key_id
name: name
partner_key_id: partner_key_id
port: 1
type: EXTERNAL
username: username
schema:
$ref: '#/components/schemas/SftpDestinationUpdateRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SftpDestinationResponse'
description: Successful response
'400':
content:
application/json:
examples:
binding_error:
$ref: '#/components/examples/binding_error'
external_sftp_destination_invalid_username:
$ref: '#/components/examples/external_sftp_destination_invalid_username'
invalid_json:
$ref: '#/components/examples/invalid_json'
invalid_null:
$ref: '#/components/examples/invalid_null'
invalid_parameter:
$ref: '#/components/examples/invalid_parameter'
local_sftp_destination_invalid_username:
$ref: '#/components/examples/local_sftp_destination_invalid_username'
missing_request_body:
$ref: '#/components/examples/missing_request_body'
sftp_destination_client_key_not_found:
$ref: '#/components/examples/sftp_destination_client_key_not_found'
sftp_destination_duplicated_name:
$ref: '#/components/examples/sftp_destination_duplicated_name'
sftp_destination_duplicated_username:
$ref: '#/components/examples/sftp_destination_duplicated_username'
sftp_destination_invalid_dropbox_path:
$ref: '#/components/examples/sftp_destination_invalid_dropbox_path'
sftp_destination_invalid_host:
$ref: '#/components/examples/sftp_destination_invalid_host'
sftp_destination_invalid_key_content:
$ref: '#/components/examples/sftp_destination_invalid_key_content'
sftp_destination_invalid_key_type:
$ref: '#/components/examples/sftp_destination_invalid_key_type'
sftp_destination_invalid_name:
$ref: '#/components/examples/sftp_destination_invalid_name'
sftp_destination_invalid_port:
$ref: '#/components/examples/sftp_destination_invalid_port'
sftp_destination_missing_host:
$ref: '#/components/examples/sftp_destination_missing_host'
sftp_destination_missing_key_id:
$ref: '#/components/examples/sftp_destination_missing_key_id'
sftp_destination_missing_username:
$ref: '#/components/examples/sftp_destination_missing_username'
sftp_destination_not_found:
$ref: '#/components/examples/sftp_destination_not_found'
unsupported_operation:
$ref: '#/components/examples/unsupported_operation'
username_exists_on_sftp_server:
$ref: '#/components/examples/username_exists_on_sftp_server'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Bad Request
'401':
content:
application/json:
examples:
method_unauthorized:
$ref: '#/components/examples/method_unauthorized'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Unauthorized
'402':
content:
application/json:
examples:
payment_required:
$ref: '#/components/examples/payment_required'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Payment Required
'403':
content:
application/json:
examples:
access_denied:
$ref: '#/components/examples/access_denied'
method_unauthorized:
$ref: '#/components/examples/method_unauthorized'
missing_access_token:
$ref: '#/components/examples/missing_access_token'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Forbidden
'415':
content:
application/json:
examples:
unsupported_media_type:
$ref: '#/components/examples/unsupported_media_type'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Unsupported Media Type
'429':
content:
application/json:
examples:
too_many_requests:
$ref: '#/components/examples/too_many_requests'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Too Many Requests
summary: Update an SFTP destination
tags:
- SFTP Servers
x-extole-bundle: integration-server-to-extole
x-extole-visibility: visible
delete:
description: Removes the SFTP destination connection profile. Returns the deleted destination.
operationId: deleteSftpDestination
parameters:
- in: path
name: sftpDestinationId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SftpDestinationResponse'
description: Successful response
'400':
content:
application/json:
examples:
binding_error:
$ref: '#/components/examples/binding_error'
invalid_json:
$ref: '#/components/examples/invalid_json'
invalid_parameter:
$ref: '#/components/examples/invalid_parameter'
missing_request_body:
$ref: '#/components/examples/missing_request_body'
sftp_destination_not_found:
$ref: '#/components/examples/sftp_destination_not_found'
unsupported_operation:
$ref: '#/components/examples/unsupported_operation'
username_exists_on_sftp_server:
$ref: '#/components/examples/username_exists_on_sftp_server'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Bad Request
'401':
content:
application/json:
examples:
method_unauthorized:
$ref: '#/components/examples/method_unauthorized'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Unauthorized
'402':
content:
application/json:
examples:
payment_required:
$ref: '#/components/examples/payment_required'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Payment Required
'403':
content:
application/json:
examples:
access_denied:
$ref: '#/components/examples/access_denied'
method_unauthorized:
$ref: '#/components/examples/method_unauthorized'
missing_access_token:
$ref: '#/components/examples/missing_access_token'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Forbidden
'415':
content:
application/json:
examples:
unsupported_media_type:
$ref: '#/components/examples/unsupported_media_type'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Unsupported Media Type
'429':
content:
application/json:
examples:
too_many_requests:
$ref: '#/components/examples/too_many_requests'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Too Many Requests
summary: Delete an SFTP destination
tags:
- SFTP Servers
x-extole-bundle: integration-server-to-extole
x-extole-visibility: visible
/v6/sftp-destinations/{sftpDestinationId}/sync:
post:
description: Triggers an immediate synchronisation of the SFTP destination with its external server. Returns the updated destination after sync.
operationId: syncSftpDestination
parameters:
- in: path
name: sftpDestinationId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SftpDestinationResponse'
description: Successful response
'400':
content:
application/json:
examples:
binding_error:
$ref: '#/components/examples/binding_error'
invalid_json:
$ref: '#/components/examples/invalid_json'
invalid_parameter:
$ref: '#/components/examples/invalid_parameter'
missing_request_body:
$ref: '#/components/examples/missing_request_body'
sftp_destination_not_found:
$ref: '#/components/examples/sftp_destination_not_found'
unsupported_operation:
$ref: '#/components/examples/unsupported_operation'
username_exists_on_sftp_server:
$ref: '#/components/examples/username_exists_on_sftp_server'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Bad Request
'401':
content:
application/json:
examples:
method_unauthorized:
$ref: '#/components/examples/method_unauthorized'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Unauthorized
'402':
content:
application/json:
examples:
payment_required:
$ref: '#/components/examples/payment_required'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Payment Required
'403':
content:
application/json:
examples:
access_denied:
$ref: '#/components/examples/access_denied'
method_unauthorized:
$ref: '#/components/examples/method_unauthorized'
missing_access_token:
$ref: '#/components/examples/missing_access_token'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Forbidden
'415':
content:
application/json:
examples:
unsupported_media_type:
$ref: '#/components/examples/unsupported_media_type'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Unsupported Media Type
'429':
content:
application/json:
examples:
too_many_requests:
$ref: '#/components/examples/too_many_requests'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Too Many Requests
summary: Sync an SFTP destination
tags:
- SFTP Servers
x-extole-bundle: integration-server-to-extole
x-extole-visibility: visible
/v6/sftp-destinations/{sftpDestinationId}/validate:
post:
description: Validates the SFTP destination connection profile without persisting any changes. Returns any connectivity or configuration errors.
operationId: validateSftpDestination
parameters:
- in: path
name: sftpDestinationId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SftpDestinationValidationResponse'
description: Successful response
'400':
content:
application/json:
examples:
binding_error:
$ref: '#/components/examples/binding_error'
invalid_json:
$ref: '#/components/examples/invalid_json'
invalid_parameter:
$ref: '#/components/examples/invalid_parameter'
missing_request_body:
$ref: '#/components/examples/missing_request_body'
sftp_destination_not_found:
$ref: '#/components/examples/sftp_destination_not_found'
unsupported_operation:
$ref: '#/components/examples/unsupported_operation'
username_exists_on_sftp_server:
$ref: '#/components/examples/username_exists_on_sftp_server'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Bad Request
'401':
content:
application/json:
examples:
method_unauthorized:
$ref: '#/components/examples/method_unauthorized'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Unauthorized
'402':
content:
application/json:
examples:
payment_required:
$ref: '#/components/examples/payment_required'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Payment Required
'403':
content:
application/json:
examples:
access_denied:
$ref: '#/components/examples/access_denied'
method_unauthorized:
$ref: '#/components/examples/method_unauthorized'
missing_access_token:
$ref: '#/components/examples/missing_access_token'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Forbidden
'415':
content:
application/json:
examples:
unsupported_media_type:
$ref: '#/components/examples/unsupported_media_type'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Unsupported Media Type
'429':
content:
application/json:
examples:
too_many_requests:
$ref: '#/components/examples/too_many_requests'
schema:
$ref: '#/components/schemas/RestExceptionResponse'
description: Too Many Requests
summary: Validate an SFTP destination
tags:
- SFTP Servers
x-extole-bundle: integration-server-to-extole
x-extole-visibility: visible
components:
examples:
sftp_destination_duplicated_name:
summary: sftp_destination_duplicated_name
value:
code: sftp_destination_duplicated_name
http_status_code: 400
message: Sftp destination with such a name already exists
parameters: {}
unique_id: 00000000-0000-0000-0000-000000000000
sftp_destination_duplicated_username:
summary: sftp_destination_duplicated_username
value:
code: sftp_destination_duplicated_username
http_status_code: 400
message: Sftp destination with such username already exists
parameters: {}
unique_id: 00000000-0000-0000-0000-000000000000
sftp_destination_invalid_key_type:
summary: sftp_destination_invalid_key_type
value:
code: sftp_destination_invalid_key_type
http_status_code: 400
message: Invalid key type
parameters: {}
unique_id: 00000000-0000-0000-0000-000000000000
sftp_destination_invalid_name:
summary: sftp_destination_invalid_name
value:
code: sftp_destination_invalid_name
http_status_code: 400
message: Name is not valid. Name is valid if it has a length of max 255 characters and contains only ASCII printable characters.
parameters: {}
unique_id: 00000000-0000-0000-0000-000000000000
sftp_destination_invalid_host:
summary: sftp_destination_invalid_host
value:
code: sftp_destination_invalid_host
http_status_code: 400
message: Host is not a valid domain
parameters: {}
unique_id: 00000000-0000-0000-0000-000000000000
external_sftp_destination_invalid_username:
summary: external_sftp_destination_invalid_username
value:
code: external_sftp_destination_invalid_username
http_status_code: 400
message: Username is not valid for external sftp destination. A valid username must not be empty or blank, not longer than 255 characters and contain only ASCII printable characters
parameters: {}
unique_id: 00000000-0000-0000-0000-000000000000
invalid_parameter:
summary: invalid_parameter
value:
code: invalid_parameter
http_status_code: 400
message: Parameter is invalid.
parameters: {}
unique_id: 00000000-0000-0000-0000-000000000000
sftp_destination_invalid_key_content:
summary: sftp_destination_invalid_key_content
value:
code: sftp_destination_invalid_key_content
http_status_code: 400
message: Provided client key is not a valid ssh public key. It must start with "ssh-rsa" and be base64 encoded
parameters: {}
unique_id: 00000000-0000-0000-0000-000000000000
invalid_null:
summary: invalid_null
value:
code: invalid_null
http_status_code: 400
message: The attribute may be omitted but not nullified
parameters: {}
unique_id: 00000000-0000-0000-0000-000000000000
unsupported_operation:
summary: unsupported_operation
value:
code: unsupported_operation
http_status_code: 400
message: Operation is not supported for given sftp destination type
parameters: {}
unique_id: 00000000-0000-0000-0000-000000000000
sftp_destination_missing_key_id:
summary: sftp_destination_missing_key_id
value:
cod
# --- truncated at 32 KB (46 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/extole/refs/heads/main/openapi/extole-sftp-servers-api-openapi.yml