List SFTP storages

Returns a paginated list of SFTP storage instances for the authenticated client.

GET /storage/v4/sftp_storages

List SFTP storages

cURL

curl --request GET \
  --url https://api.gcore.com/storage/v4/sftp_storages \
  --header 'Authorization: <api-key>'

import requests

url = "https://api.gcore.com/storage/v4/sftp_storages"

headers = {"Authorization": "<api-key>"}

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.gcore.com/storage/v4/sftp_storages', 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.gcore.com/storage/v4/sftp_storages",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <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.gcore.com/storage/v4/sftp_storages"

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

	req.Header.Add("Authorization", "<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.gcore.com/storage/v4/sftp_storages")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gcore.com/storage/v4/sftp_storages")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

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

200

{
  "count": 1,
  "results": [
    {
      "address": "luxembourg-2.storage.example.com",
      "created_at": "2025-08-05T09:17:02Z",
      "expires": "2 years 6 months",
      "full_name": "696-my-sftp-storage",
      "has_custom_config_file": false,
      "has_password": true,
      "id": 1,
      "is_http_disabled": false,
      "location_name": "luxembourg-2",
      "name": "my-sftp-storage",
      "provisioning_status": "active",
      "server_alias": "my-storage.example.com",
      "ssh_key_ids": [
        1,
        2
      ],
      "password": "Xy9$mN2p!qR8"
    }
  ]
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

Authorizations

Authorization · string · header · required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234$abcdef

Query Parameters

id · string

Filter by storage ID

name · string

Filter by storage name

location_name · string

Filter by storage location/region

offset · integer<uint64>

Number of records to skip

Required range: x >= 0

limit · integer<uint64> · default: 10

Max number of records in response

Required range: 1 <= x <= 1000

order_by · string · default: created_at.desc

provisioning_status · enum<string>

Filter by provisioning status

Available options: active, creating, updating, deleting, deleted

show_deleted · boolean

Include deleted storages

Response

200

application/json

SFTPStorageListEndpointResV4

count · integer<int64> · required

Total number of SFTP storages matching the filter

Example:

1

results · SFTPStorageItemV4 SFTP storage with connection details and authentication config. Connect using address with SSH keys or password. · object[] · required

The list of SFTP storages

Show child attributes