Get pipeline
curl --request GET \
--url https://api.sftpsync.io/pipelines/{id} \
--header 'x-api-key: <api-key>'import requests
url = "https://api.sftpsync.io/pipelines/{id}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sftpsync.io/pipelines/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sftpsync.io/pipelines/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.sftpsync.io/pipelines/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.sftpsync.io/pipelines/{id}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sftpsync.io/pipelines/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"mappings": {
"fieldMappings": [
{
"target": "<string>",
"source": "<string>",
"transform": "<string>",
"value": "<string>",
"sources": [
"<string>"
],
"delimiter": " "
}
],
"options": {},
"validations": {}
},
"isActive": true,
"clientId": "<string>",
"schemaId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"direction": "inbound",
"webhooks": [
{
"id": "<string>",
"name": "<string>",
"url": "<string>"
}
]
}{
"message": "<string>",
"statusCode": 123,
"error": "<string>"
}Pipelines
Get pipeline
GET
/
pipelines
/
{id}
Get pipeline
curl --request GET \
--url https://api.sftpsync.io/pipelines/{id} \
--header 'x-api-key: <api-key>'import requests
url = "https://api.sftpsync.io/pipelines/{id}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sftpsync.io/pipelines/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sftpsync.io/pipelines/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.sftpsync.io/pipelines/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.sftpsync.io/pipelines/{id}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sftpsync.io/pipelines/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"mappings": {
"fieldMappings": [
{
"target": "<string>",
"source": "<string>",
"transform": "<string>",
"value": "<string>",
"sources": [
"<string>"
],
"delimiter": " "
}
],
"options": {},
"validations": {}
},
"isActive": true,
"clientId": "<string>",
"schemaId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"direction": "inbound",
"webhooks": [
{
"id": "<string>",
"name": "<string>",
"url": "<string>"
}
]
}{
"message": "<string>",
"statusCode": 123,
"error": "<string>"
}Authorizations
Path Parameters
Response
Pipeline
The mapping definition the API expects. Field mappings live under fieldMappings; not a bare array.
Show child attributes
Show child attributes
Connection id this pipeline is bound to.
Pipeline direction. Outbound pipelines accept data via the Outbound Uploads API.
Available options:
inbound, outbound Webhooks linked to this pipeline. Present and non-empty only when the pipeline has associated webhooks.
Show child attributes
Show child attributes
⌘I