Update file share

Rename file share, update tags or set share specific properties

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

Python

Python

import os
from gcore import Gcore

client = Gcore(
    api_key=os.environ.get("GCORE_API_KEY"),  # This is the default and can be omitted
)
task_id_list = client.cloud.file_shares.update(
    file_share_id="bd8c47ee-e565-4e26-8840-b537e6827b08",
    project_id=1,
    region_id=1,
)
print(task_id_list.tasks)

200

{
  "tasks": [
    "d478ae29-dedc-4869-82f0-96104425f565"
  ]
}

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

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.

Example:

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

Response

200 - application/json

OK

tasks · string[] · required

List of task IDs representing asynchronous operations. Use these IDs to monitor operation progress:

• GET /v1/tasks/{task_id} - Check individual task status and details Poll task status until completion (FINISHED/ERROR) before proceeding with dependent operations.

Example:

["d478ae29-dedc-4869-82f0-96104425f565"]