Skip to main content
GET
/
sites
/
{site_id}
/
environments
/
{env_id}
/
ssh
/
config
Get SFTP/SSH connections config
curl --request GET \
  --url https://api.kinsta.com/v2/sites/{site_id}/environments/{env_id}/ssh/config \
  --header 'Authorization: Bearer <token>'
{
  "site": {
    "id": "<string>",
    "name": "<string>",
    "displayName": "<string>",
    "usr": "<string>",
    "environment": {
      "id": "<string>",
      "activeContainer": {
        "id": "<string>",
        "lxdSshPort": "<string>",
        "loadBalancer": {
          "id": "<string>",
          "extIP": "<string>"
        }
      }
    }
  },
  "port": "<string>",
  "name": "<string>",
  "host": "<string>",
  "user": "<string>",
  "ssh_command": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://api-docs.kinsta.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

Successfully found SFTP config

​
site
object
required
​
port
string
required
​
name
string
required
​
host
string
required
​
user
string
required
​
ssh_command
string
required