import os
from gcore import Gcore
client = Gcore(
api_key=os.environ.get("GCORE_API_KEY"), # This is the default and can be omitted
)
sftp_storage_created = client.storage.sftp_storages.update(
storage_id=0,
)
print(sftp_storage_created.id)package main
import (
"context"
"fmt"
"github.com/G-Core/gcore-go"
"github.com/G-Core/gcore-go/option"
"github.com/G-Core/gcore-go/storage"
)
func main() {
client := gcore.NewClient(
option.WithAPIKey("My API Key"),
)
sftpStorageCreated, err := client.Storage.SftpStorages.Update(
context.TODO(),
0,
storage.SftpStorageUpdateParams{},
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", sftpStorageCreated.ID)
}
curl --request PATCH \
--url https://api.gcore.com/storage/v4/sftp_storages/{storage_id} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"expires": "2 years 6 months",
"has_custom_config_file": false,
"is_http_disabled": false,
"password": "Xy9$mN2p!qR8",
"password_mode": "auto",
"server_alias": "my-storage.example.com",
"ssh_key_ids": [
1,
2,
3
]
}
'const options = {
method: 'PATCH',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
expires: '2 years 6 months',
has_custom_config_file: false,
is_http_disabled: false,
password: 'Xy9$mN2p!qR8',
password_mode: 'auto',
server_alias: 'my-storage.example.com',
ssh_key_ids: [1, 2, 3]
})
};
fetch('https://api.gcore.com/storage/v4/sftp_storages/{storage_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.gcore.com/storage/v4/sftp_storages/{storage_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'expires' => '2 years 6 months',
'has_custom_config_file' => false,
'is_http_disabled' => false,
'password' => 'Xy9$mN2p!qR8',
'password_mode' => 'auto',
'server_alias' => 'my-storage.example.com',
'ssh_key_ids' => [
1,
2,
3
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}HttpResponse<String> response = Unirest.patch("https://api.gcore.com/storage/v4/sftp_storages/{storage_id}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"expires\": \"2 years 6 months\",\n \"has_custom_config_file\": false,\n \"is_http_disabled\": false,\n \"password\": \"Xy9$mN2p!qR8\",\n \"password_mode\": \"auto\",\n \"server_alias\": \"my-storage.example.com\",\n \"ssh_key_ids\": [\n 1,\n 2,\n 3\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gcore.com/storage/v4/sftp_storages/{storage_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"expires\": \"2 years 6 months\",\n \"has_custom_config_file\": false,\n \"is_http_disabled\": false,\n \"password\": \"Xy9$mN2p!qR8\",\n \"password_mode\": \"auto\",\n \"server_alias\": \"my-storage.example.com\",\n \"ssh_key_ids\": [\n 1,\n 2,\n 3\n ]\n}"
response = http.request(request)
puts response.read_body{
"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"
}{
"detail": "<string>",
"error": "<string>",
"request_id": "8f1c9a2e4d6b4f0e9a1b3c5d7e9f0a1b",
"status": 123,
"title": "<string>",
"type": "validation-error",
"context": {
"allowed_methods": [
"<string>"
],
"blocking_count": 123,
"blocking_resources": [
{
"resource_id": "123",
"resource_name": "my-storage",
"resource_type": "object_storages"
}
],
"client_id": 123,
"operation": "<string>",
"project_id": 123,
"quotas": [
{
"available": 123,
"limit": 123,
"name": "access_keys",
"overflow": 123,
"region_id": 123,
"requested": 123,
"resulting_usage": 123,
"scope": "<string>",
"unit": "<string>",
"usage": 123
}
],
"reason": "region",
"region_id": 123,
"resource_id": "123",
"resource_status": "<string>",
"resource_type": "object_storages",
"retry_after": 123
},
"errors": [
{
"code": "missing",
"ctx": {},
"detail": "<string>",
"loc": [
"body",
"name"
]
}
],
"hint": "<string>",
"trace_id": "4bf92f3577b34da6a3ce929d0e0e4736"
}{
"detail": "<string>",
"error": "<string>",
"request_id": "8f1c9a2e4d6b4f0e9a1b3c5d7e9f0a1b",
"status": 123,
"title": "<string>",
"type": "validation-error",
"context": {
"allowed_methods": [
"<string>"
],
"blocking_count": 123,
"blocking_resources": [
{
"resource_id": "123",
"resource_name": "my-storage",
"resource_type": "object_storages"
}
],
"client_id": 123,
"operation": "<string>",
"project_id": 123,
"quotas": [
{
"available": 123,
"limit": 123,
"name": "access_keys",
"overflow": 123,
"region_id": 123,
"requested": 123,
"resulting_usage": 123,
"scope": "<string>",
"unit": "<string>",
"usage": 123
}
],
"reason": "region",
"region_id": 123,
"resource_id": "123",
"resource_status": "<string>",
"resource_type": "object_storages",
"retry_after": 123
},
"errors": [
{
"code": "missing",
"ctx": {},
"detail": "<string>",
"loc": [
"body",
"name"
]
}
],
"hint": "<string>",
"trace_id": "4bf92f3577b34da6a3ce929d0e0e4736"
}{
"detail": "<string>",
"error": "<string>",
"request_id": "8f1c9a2e4d6b4f0e9a1b3c5d7e9f0a1b",
"status": 123,
"title": "<string>",
"type": "validation-error",
"context": {
"allowed_methods": [
"<string>"
],
"blocking_count": 123,
"blocking_resources": [
{
"resource_id": "123",
"resource_name": "my-storage",
"resource_type": "object_storages"
}
],
"client_id": 123,
"operation": "<string>",
"project_id": 123,
"quotas": [
{
"available": 123,
"limit": 123,
"name": "access_keys",
"overflow": 123,
"region_id": 123,
"requested": 123,
"resulting_usage": 123,
"scope": "<string>",
"unit": "<string>",
"usage": 123
}
],
"reason": "region",
"region_id": 123,
"resource_id": "123",
"resource_status": "<string>",
"resource_type": "object_storages",
"retry_after": 123
},
"errors": [
{
"code": "missing",
"ctx": {},
"detail": "<string>",
"loc": [
"body",
"name"
]
}
],
"hint": "<string>",
"trace_id": "4bf92f3577b34da6a3ce929d0e0e4736"
}Update SFTP storage
Updates SFTP storage configuration and/or credentials including password and SSH key management.
Supports JSON merge patch semantics: an absent field is left unchanged.
The password is changed through “password_mode”: “auto” regenerates it and returns it once,
“set” uses the “password” field and returns it once, “none” removes it. “password” is only
read when password_mode is “set” and must be omitted otherwise. “ssh_key_ids”: [] clears all keys.
import os
from gcore import Gcore
client = Gcore(
api_key=os.environ.get("GCORE_API_KEY"), # This is the default and can be omitted
)
sftp_storage_created = client.storage.sftp_storages.update(
storage_id=0,
)
print(sftp_storage_created.id)package main
import (
"context"
"fmt"
"github.com/G-Core/gcore-go"
"github.com/G-Core/gcore-go/option"
"github.com/G-Core/gcore-go/storage"
)
func main() {
client := gcore.NewClient(
option.WithAPIKey("My API Key"),
)
sftpStorageCreated, err := client.Storage.SftpStorages.Update(
context.TODO(),
0,
storage.SftpStorageUpdateParams{},
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", sftpStorageCreated.ID)
}
curl --request PATCH \
--url https://api.gcore.com/storage/v4/sftp_storages/{storage_id} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"expires": "2 years 6 months",
"has_custom_config_file": false,
"is_http_disabled": false,
"password": "Xy9$mN2p!qR8",
"password_mode": "auto",
"server_alias": "my-storage.example.com",
"ssh_key_ids": [
1,
2,
3
]
}
'const options = {
method: 'PATCH',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
expires: '2 years 6 months',
has_custom_config_file: false,
is_http_disabled: false,
password: 'Xy9$mN2p!qR8',
password_mode: 'auto',
server_alias: 'my-storage.example.com',
ssh_key_ids: [1, 2, 3]
})
};
fetch('https://api.gcore.com/storage/v4/sftp_storages/{storage_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.gcore.com/storage/v4/sftp_storages/{storage_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'expires' => '2 years 6 months',
'has_custom_config_file' => false,
'is_http_disabled' => false,
'password' => 'Xy9$mN2p!qR8',
'password_mode' => 'auto',
'server_alias' => 'my-storage.example.com',
'ssh_key_ids' => [
1,
2,
3
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}HttpResponse<String> response = Unirest.patch("https://api.gcore.com/storage/v4/sftp_storages/{storage_id}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"expires\": \"2 years 6 months\",\n \"has_custom_config_file\": false,\n \"is_http_disabled\": false,\n \"password\": \"Xy9$mN2p!qR8\",\n \"password_mode\": \"auto\",\n \"server_alias\": \"my-storage.example.com\",\n \"ssh_key_ids\": [\n 1,\n 2,\n 3\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gcore.com/storage/v4/sftp_storages/{storage_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"expires\": \"2 years 6 months\",\n \"has_custom_config_file\": false,\n \"is_http_disabled\": false,\n \"password\": \"Xy9$mN2p!qR8\",\n \"password_mode\": \"auto\",\n \"server_alias\": \"my-storage.example.com\",\n \"ssh_key_ids\": [\n 1,\n 2,\n 3\n ]\n}"
response = http.request(request)
puts response.read_body{
"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"
}{
"detail": "<string>",
"error": "<string>",
"request_id": "8f1c9a2e4d6b4f0e9a1b3c5d7e9f0a1b",
"status": 123,
"title": "<string>",
"type": "validation-error",
"context": {
"allowed_methods": [
"<string>"
],
"blocking_count": 123,
"blocking_resources": [
{
"resource_id": "123",
"resource_name": "my-storage",
"resource_type": "object_storages"
}
],
"client_id": 123,
"operation": "<string>",
"project_id": 123,
"quotas": [
{
"available": 123,
"limit": 123,
"name": "access_keys",
"overflow": 123,
"region_id": 123,
"requested": 123,
"resulting_usage": 123,
"scope": "<string>",
"unit": "<string>",
"usage": 123
}
],
"reason": "region",
"region_id": 123,
"resource_id": "123",
"resource_status": "<string>",
"resource_type": "object_storages",
"retry_after": 123
},
"errors": [
{
"code": "missing",
"ctx": {},
"detail": "<string>",
"loc": [
"body",
"name"
]
}
],
"hint": "<string>",
"trace_id": "4bf92f3577b34da6a3ce929d0e0e4736"
}{
"detail": "<string>",
"error": "<string>",
"request_id": "8f1c9a2e4d6b4f0e9a1b3c5d7e9f0a1b",
"status": 123,
"title": "<string>",
"type": "validation-error",
"context": {
"allowed_methods": [
"<string>"
],
"blocking_count": 123,
"blocking_resources": [
{
"resource_id": "123",
"resource_name": "my-storage",
"resource_type": "object_storages"
}
],
"client_id": 123,
"operation": "<string>",
"project_id": 123,
"quotas": [
{
"available": 123,
"limit": 123,
"name": "access_keys",
"overflow": 123,
"region_id": 123,
"requested": 123,
"resulting_usage": 123,
"scope": "<string>",
"unit": "<string>",
"usage": 123
}
],
"reason": "region",
"region_id": 123,
"resource_id": "123",
"resource_status": "<string>",
"resource_type": "object_storages",
"retry_after": 123
},
"errors": [
{
"code": "missing",
"ctx": {},
"detail": "<string>",
"loc": [
"body",
"name"
]
}
],
"hint": "<string>",
"trace_id": "4bf92f3577b34da6a3ce929d0e0e4736"
}{
"detail": "<string>",
"error": "<string>",
"request_id": "8f1c9a2e4d6b4f0e9a1b3c5d7e9f0a1b",
"status": 123,
"title": "<string>",
"type": "validation-error",
"context": {
"allowed_methods": [
"<string>"
],
"blocking_count": 123,
"blocking_resources": [
{
"resource_id": "123",
"resource_name": "my-storage",
"resource_type": "object_storages"
}
],
"client_id": 123,
"operation": "<string>",
"project_id": 123,
"quotas": [
{
"available": 123,
"limit": 123,
"name": "access_keys",
"overflow": 123,
"region_id": 123,
"requested": 123,
"resulting_usage": 123,
"scope": "<string>",
"unit": "<string>",
"usage": 123
}
],
"reason": "region",
"region_id": 123,
"resource_id": "123",
"resource_status": "<string>",
"resource_type": "object_storages",
"retry_after": 123
},
"errors": [
{
"code": "missing",
"ctx": {},
"detail": "<string>",
"loc": [
"body",
"name"
]
}
],
"hint": "<string>",
"trace_id": "4bf92f3577b34da6a3ce929d0e0e4736"
}Authorizations
Headers
Body
Field absent → no change Field present with value → set to that value "ssh_key_ids": [] → clear all SSH keys
Response
SFTPStorageWithPasswordV4
SFTPStorageWithPasswordV4 SFTP storage as returned by create and update, which are the only operations that can hand back a password. Identical to SFTPStorageItemV4 otherwise.
Read-only internal full name of the storage, composed as "{client_id}-{name}".
Used by the SFTP backend as the login username. Clients should use this value when connecting
but should continue to identify the storage by name in their own configuration.
"696-my-sftp-storage"
Was this page helpful?