Get Connection Information

Returns details for the specified connection.

GET /connections/{connection_type}/{connection_id}

Get Connection Information

cURL

curl --request GET \
  --url https://api.xplenty.com/{account_id}/api/connections/{connection_type}/{connection_id} \
  --header 'Accept: <accept>' \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://api.xplenty.com/{account_id}/api/connections/{connection_type}/{connection_id}"

headers = {
    "Accept": "<accept>",
    "Authorization": "Basic <encoded-value>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {Accept: '<accept>', Authorization: 'Basic <encoded-value>'}
};

fetch('https://api.xplenty.com/{account_id}/api/connections/{connection_type}/{connection_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.xplenty.com/{account_id}/api/connections/{connection_type}/{connection_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 => [
    "Accept: <accept>",
    "Authorization: Basic <encoded-value>"
  ],
]);

$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.xplenty.com/{account_id}/api/connections/{connection_type}/{connection_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Accept", "<accept>")
	req.Header.Add("Authorization", "Basic <encoded-value>")

	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.xplenty.com/{account_id}/api/connections/{connection_type}/{connection_id}")
  .header("Accept", "<accept>")
  .header("Authorization", "Basic <encoded-value>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.xplenty.com/{account_id}/api/connections/{connection_type}/{connection_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Accept"] = '<accept>'
request["Authorization"] = 'Basic <encoded-value>'

response = http.request(request)
puts response.read_body

200

{
  "id": 12345,
  "name": "Sample SFTP Connection",
  "unique_id": "SFTP_CONNECTION_12345",
  "created_at": "2026-01-01T00:00:00Z",
  "updated_at": "2026-01-01T00:00:00Z",
  "owner_id": 1000,
  "type": "sftp",
  "url": "https://api.xplenty.com/{account}/api/connections/sftp/12345",
  "port": 22,
  "auth_method": "password",
  "host": "sftp.example.com",
  "username": "your-username",
  "tunnel_type": "direct",
  "local_port": 12345
}

Authorizations

Authorization · string · header · required

Enter your API key as the username. Leave the password field blank. Example: curl -u YOUR_API_KEY: https://api.xplenty.com/...

Headers

Accept · string · default: application/vnd.xplenty+json; version=2 · required

API version header — required on all requests

Path Parameters

connection_type · string · required

The type of the connection (e.g., sftp, mysql, salesforce). Determines which connector schema the response is shaped against.

connection_id · integer · required

The numeric ID of the connection.

Response

200 - application/vnd.xplenty+json; version=2

Successful response

id · integer

name · string

type · string

connection_group_id · integer | null

ID of the connection group this connection belongs to, or null if ungrouped.

created_at · string<date-time>

updated_at · string<date-time>

url · string<uri>