Skip to main content
GET
/
connections
/
{connection_type}
/
{connection_id}
Get Connection Information
curl --request GET \
  --url https://api.xplenty.com/{account_id}/api/connections/{connection_type}/{connection_id} \
  --header 'Accept: <accept>' \
  --header 'Authorization: Basic <encoded-value>'
{
  "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
​
created_at
string<date-time>
​
updated_at
string<date-time>
​
url
string<uri>
Last modified on June 2, 2026