Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Extole SFTP Servers API

The SFTP Servers API from Extole — 4 operation(s) for sftp servers.

Extole SFTP Servers API is one of 44 APIs that Extole publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include SFTP Servers. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 7 operations across 4 paths, and defines 15 schemas. It is described by OpenAPI 3.0.1, at version 1.0.

Requests are made against a single base URL, https://{brand}.extole.io.

7 operations 4 paths 15 schemas 1 DELETE2 GET3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://api.extole.io
Authentication
API Key, API Key, API Key
Resource Areas
1

Authentication & Security 3

Extole SFTP Servers API declares 3 security schemes for authenticating requests. An API key is passed in the cookie as extole_token (COOKIE). An API key is passed in the header as Authorization (HEADER). An API key is passed in the query as access_token (QUERY). By default, every request must be authenticated.

Paths & Operations 7

Across 4 paths, the API surfaces 7 operations — 1 DELETE, 2 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

SFTP Servers 7
GET
/v6/sftp-destinations
List SFTP destinations
listSftpDestinations 6 params → 200400401402403415429
POST
/v6/sftp-destinations
Create an SFTP destination
createSftpDestination body → 200400401402403415429
GET
/v6/sftp-destinations/{sftpDestinationId}
Get an SFTP destination
getSftpDestination 1 param → 200400401402403415429
PUT
/v6/sftp-destinations/{sftpDestinationId}
Update an SFTP destination
updateSftpDestination 1 param body → 200400401402403415429
DELETE
/v6/sftp-destinations/{sftpDestinationId}
Delete an SFTP destination
deleteSftpDestination 1 param → 200400401402403415429
POST
/v6/sftp-destinations/{sftpDestinationId}/sync
Sync an SFTP destination
syncSftpDestination 1 param → 200400401402403415429
POST
/v6/sftp-destinations/{sftpDestinationId}/validate
Validate an SFTP destination
validateSftpDestination 1 param → 200400401402403415429

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are SftpDestinationResponseBase (11 properties), RestExceptionResponse (5 properties), SftpDestinationUpdateRequestBase (4 properties), SftpDestinationCreateRequestBase (4 properties). Each schema is shown below with its type and property counts.

LocalSftpDestinationUpdateRequest
object
Extole local sftp destination update request.
1 required
ExternalSftpDestinationResponse
object
External sftp destination response.
12 required
LocalSftpDestinationResponse
object
Extole local sftp destination response.
13 required
ExternalSftpDestinationCreateRequest
object
External sftp destination create request.
4 required
LocalSftpDestinationCreateRequest
object
Extole local sftp destination create request.
2 required
SftpDestinationResponse
SftpDestinationResponseBase
object
11 properties
SftpDestinationCreateRequestBase
object
4 properties
ExternalSftpDestinationUpdateRequest
object
External sftp destination create request.
1 required
SftpDestinationCreateRequest
Body of a POST /v6/sftp-destinations request.
1 required
ZonedDateTime
string
[RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557section-4) date-time with a num…
RestExceptionResponse
object
Represents the API error response
5 properties 5 required
SftpDestinationUpdateRequest
Body of a PUT /v6/sftp-destinations/{sftpDestinationId} request.
1 required
SftpDestinationUpdateRequestBase
object
4 properties
SftpDestinationValidationResponse
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

extole-sftp-servers-api-openapi.yml Raw ↑

Other APIs Extole publishes across the network.

Extole Audiences API
Extole Authentication API
Extole Batch Jobs API
Extole Blocks API
Extole Campaign Controllers Actions API
Extole Campaign Controllers API
Extole Campaign Controllers Triggers API
Extole Campaign Flow Steps API
Extole Campaigns API
Extole Components API
Extole Components Grants API
Extole Components Settings API