Update file share

Rename file share or update tags

Deprecated: Use PATCH /v3/file_shares/// instead

PATCH /cloud/v1/file_shares/{project_id}/{region_id}/{file_share_id}

Update file share

cURL

curl --request PATCH \
  --url https://api.gcore.com/cloud/v1/file_shares/{project_id}/{region_id}/{file_share_id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "some_name",
  "share_settings": {
    "allowed_characters": "LCD",
    "path_length": "LCD",
    "root_squash": true
  },
  "tags": {
    "my-tag": "my-tag-value",
    "my-tag-to-remove": null
  }
}
'

import requests

url = "https://api.gcore.com/cloud/v1/file_shares/{project_id}/{region_id}/{file_share_id}"

payload = {
    "name": "some_name",
    "share_settings": {
        "allowed_characters": "LCD",
        "path_length": "LCD",
        "root_squash": True
    },
    "tags": {
        "my-tag": "my-tag-value",
        "my-tag-to-remove": None
    }
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'some_name',
    share_settings: {allowed_characters: 'LCD', path_length: 'LCD', root_squash: true},
    tags: {'my-tag': 'my-tag-value', 'my-tag-to-remove': null}
  })
};

fetch('https://api.gcore.com/cloud/v1/file_shares/{project_id}/{region_id}/{file_share_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/cloud/v1/file_shares/{project_id}/{region_id}/{file_share_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([
    'name' => 'some_name',
    'share_settings' => [
        'allowed_characters' => 'LCD',
        'path_length' => 'LCD',
        'root_squash' => true
    ],
    'tags' => [
        'my-tag' => 'my-tag-value',
        'my-tag-to-remove' => null
    ]
  ]),
  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;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.gcore.com/cloud/v1/file_shares/{project_id}/{region_id}/{file_share_id}"

	payload := strings.NewReader("{\n  \"name\": \"some_name\",\n  \"share_settings\": {\n    \"allowed_characters\": \"LCD\",\n    \"path_length\": \"LCD\",\n    \"root_squash\": true\n  },\n  \"tags\": {\n    \"my-tag\": \"my-tag-value\",\n    \"my-tag-to-remove\": null\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.gcore.com/cloud/v1/file_shares/{project_id}/{region_id}/{file_share_id}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"some_name\",\n  \"share_settings\": {\n    \"allowed_characters\": \"LCD\",\n    \"path_length\": \"LCD\",\n    \"root_squash\": true\n  },\n  \"tags\": {\n    \"my-tag\": \"my-tag-value\",\n    \"my-tag-to-remove\": null\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gcore.com/cloud/v1/file_shares/{project_id}/{region_id}/{file_share_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  \"name\": \"some_name\",\n  \"share_settings\": {\n    \"allowed_characters\": \"LCD\",\n    \"path_length\": \"LCD\",\n    \"root_squash\": true\n  },\n  \"tags\": {\n    \"my-tag\": \"my-tag-value\",\n    \"my-tag-to-remove\": null\n  }\n}"

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

200

{
  "connection_point": "10.254.0.43:/shares/share-7c14ca01-ea5e-4d85-a6e2-c104fe6b561a",
  "created_at": "2023-04-25T11:06:49.226920",
  "creator_task_id": "6ab1ead7-8640-4ae9-9e20-9e0bafcd2eca",
  "id": "bd8c47ee-e565-4e26-8840-b537e6827b08",
  "name": "test-sfs",
  "network_id": "e72fd98e-32fa-474d-b0a3-bca11c3064ff",
  "network_name": "File_share_test-sfs",
  "project_id": 1337,
  "protocol": "NFS",
  "region": "Luxembourg 1",
  "region_id": 7,
  "share_network_name": "File_share_test-sfs_network",
  "share_settings": {
    "type_name": "<string>"
  },
  "size": 10,
  "subnet_id": "ac601bb9-4d77-4356-96de-66ab29711815",
  "subnet_name": "subnet_test-sfs",
  "tags": [
    {
      "key": "my-tag",
      "read_only": false,
      "value": "my-tag-value"
    }
  ],
  "task_id": "22b1eau7-8641-4ae9-9n20-9e0b5fcd2gca"
}

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

Path Parameters

project_id · integer · required

Project ID

Example:

1

region_id · integer · required

Region ID

Example:

1

file_share_id · string<uuid4> · required

File Share ID

Example:

"bd8c47ee-e565-4e26-8840-b537e6827b08"

Body

application/json

name · string

Name

Pattern: ^[a-zA-Z0-9][a-zA-Z 0-9._\-]{1,61}[a-zA-Z0-9._]$

Example:

"some_name"

share_settings · VastFileShareSettingsInputSerializer · object

Configuration settings for the share

Show child attributes

tags · UpdateTagsSerializer · object | null

Update key-value tags using JSON Merge Patch semantics (RFC 7386). Provide key-value pairs to add or update tags. Set tag values to null to remove tags. Unspecified tags remain unchanged. Read-only tags are always preserved and cannot be modified.

Examples:

• Add/update tags: {'tags': {'environment': 'production', 'team': 'backend'}} adds new tags or updates existing ones.
• Delete tags: {'tags': {'old_tag': null}} removes specific tags.
• Remove all tags: {'tags': null} removes all user-managed tags (read-only tags are preserved).
• Partial update: {'tags': {'environment': 'staging'}} only updates specified tags.
• Mixed operations: {'tags': {'environment': 'production', 'cost_center': 'engineering', 'deprecated_tag': null}} adds/updates 'environment' and 'cost_center' while removing 'deprecated_tag', preserving other existing tags.
• Replace all: first delete existing tags with null values, then add new ones in the same request.

Show child attributes

Example:

{
  "my-tag": "my-tag-value",
  "my-tag-to-remove": null
}

Response

200 - application/json

OK

connection_point · string | null · required

Connection point. Can be null during File share creation

Example:

"10.254.0.43:/shares/share-7c14ca01-ea5e-4d85-a6e2-c104fe6b561a"

created_at · string · required

Datetime when the file share was created

Example:

"2023-04-25T11:06:49.226920"

creator_task_id · string<uuid4> · required

Task that created this entity

Example:

"6ab1ead7-8640-4ae9-9e20-9e0bafcd2eca"

id · string<uuid4> · required

File share ID

Example:

"bd8c47ee-e565-4e26-8840-b537e6827b08"

name · string · required

File share name

Example:

"test-sfs"

network_id · string<uuid4> · required

Network ID.

Example:

"e72fd98e-32fa-474d-b0a3-bca11c3064ff"

network_name · string · required

Network name.

Example:

"File_share_test-sfs"

project_id · integer · required

Project ID

Example:

1337

protocol · string · required

File share protocol

Example:

"NFS"

region · string · required

Region name

Example:

"Luxembourg 1"

region_id · integer · required

Region ID

Example:

7

share_network_name · string | null · required

Share network name. May be null if the file share was created with volume type VAST

Example:

"File_share_test-sfs_network"

share_settings · StandardShareSettingsOutputSerializer · object · required

Share settings specific to the file share type

StandardShareSettingsOutputSerializer

VastShareSettingsOutputSerializer

Show child attributes

size · integer · required

File share size in GiB

Required range: x >= 1

Example:

10

status · enum<string> · required

File share status

Available options: available, awaiting_transfer, backup_creating, backup_restoring, backup_restoring_error, creating, creating_from_snapshot, deleted, deleting, ensuring, error, error_deleting, extending, extending_error, inactive, manage_error, manage_starting, migrating, migrating_to, replication_change, reverting, reverting_error, shrinking, shrinking_error, shrinking_possible_data_loss_error, unmanage_error, unmanage_starting, unmanaged

Example:

"available"

subnet_id · string<uuid4> · required

Subnet ID.

Example:

"ac601bb9-4d77-4356-96de-66ab29711815"

subnet_name · string · required

Subnet name.

Example:

"subnet_test-sfs"

tags · TagSerializer · object[] · required

List of key-value tags associated with the resource. A tag is a key-value pair that can be associated with a resource, enabling efficient filtering and grouping for better organization and management. Some tags are read-only and cannot be modified by the user. Tags are also integrated with cost reports, allowing cost data to be filtered based on tag keys or values.

Show child attributes

Example:

[
  {
    "key": "my-tag",
    "read_only": false,
    "value": "my-tag-value"
  }
]

task_id · string<uuid4> | null · required

The UUID of the active task that currently holds a lock on the resource. This lock prevents concurrent modifications to ensure consistency. If null, the resource is not locked.

Example:

"22b1eau7-8641-4ae9-9n20-9e0b5fcd2gca"

type_name · enum<string> · required

File share type name

Available options: standard, vast

Example:

"standard"

volume_type · enum<string> · required · deprecated

Deprecated. Use type_name instead. File share disk type

Available options: default_share_type, vast_share_type

Example:

"default_share_type"