> ## Documentation Index > Fetch the complete documentation index at: https://gcore.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Update file share > Rename file share, update tags or set share specific properties ## OpenAPI ````yaml /api-reference/services_documented/cloud_api.yaml patch /cloud/v3/file_shares/{project_id}/{region_id}/{file_share_id} openapi: 3.1.0 info: title: Gcore OpenAPI – Cloud API description: >- This OpenAPI is an aggregated OpenAPI specification that unifies all Gcore products into a single file. It covers Cloud, CDN, DNS, WAAP, DDoS Protection, Object Storage, Streaming, and FastEdge services. version: '2026-05-15T06:37:28.230198+00:00' servers: - url: https://api.gcore.com security: - APIKey: [] tags: - name: Bare Metal x-displayName: Bare Metal - name: Container as a Service x-displayName: Container as a Service - name: Cost Reports x-displayName: Cost Reports - name: DDoS Protection x-displayName: DDoS Protection - name: Everywhere Inference x-displayName: Everywhere Inference - name: Everywhere Inference Apps x-displayName: Everywhere Inference Apps - name: File Shares x-displayName: File Shares - name: Floating IPs x-displayName: Floating IPs - name: Function as a Service x-displayName: Function as a Service - name: GPU Bare Metal x-displayName: GPU Bare Metal - name: GPU Virtual x-displayName: GPU Virtual - name: IP Ranges x-displayName: IP Ranges - name: Images x-displayName: Images - name: Instances x-displayName: Instances - name: Load Balancers x-displayName: Load Balancers - name: Logging x-displayName: Logging - name: Managed Kubernetes x-displayName: Managed Kubernetes - name: Managed PostgreSQL x-displayName: Managed PostgreSQL - name: Networks x-displayName: Networks - name: Placement Groups x-displayName: Placement Groups - name: Projects x-displayName: Projects - name: Quotas x-displayName: Quotas - name: Regions x-displayName: Regions - name: Registry x-displayName: Registry - name: Reservations x-displayName: Reservations - name: Reserved IPs x-displayName: Reserved IPs - name: Routers x-displayName: Routers - name: SSH Keys x-displayName: SSH Keys - name: Secrets x-displayName: Secrets - name: Security Groups x-displayName: Security Groups - name: Snapshot Schedules x-displayName: Snapshot Schedules - name: Snapshots x-displayName: Snapshots - name: Tasks x-displayName: Tasks - name: User Actions x-displayName: User Actions - name: User Role Assignments x-displayName: User Role Assignments - name: Volumes x-displayName: Volumes paths: /cloud/v3/file_shares/{project_id}/{region_id}/{file_share_id}: patch: tags: - File Shares summary: Update file share description: Rename file share, update tags or set share specific properties operationId: SfsShareViewSet.patch parameters: - in: path name: project_id required: true description: Project ID schema: description: Project ID example: 1 examples: - 1 title: Project Id type: integer - in: path name: region_id required: true description: Region ID schema: description: Region ID example: 1 examples: - 1 title: Region Id type: integer - in: path name: file_share_id required: true description: File Share ID schema: description: File Share ID example: bd8c47ee-e565-4e26-8840-b537e6827b08 examples: - bd8c47ee-e565-4e26-8840-b537e6827b08 format: uuid4 title: File Share Id type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateFileShareSerializer' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/TaskIDsSerializer' x-codeSamples: - lang: Python source: |- 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) - lang: Go source: "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/G-Core/gcore-go\"\n\t\"github.com/G-Core/gcore-go/cloud\"\n\t\"github.com/G-Core/gcore-go/option\"\n)\n\nfunc main() {\n\tclient := gcore.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\ttaskIDList, err := client.Cloud.FileShares.Update(\n\t\tcontext.TODO(),\n\t\t\"bd8c47ee-e565-4e26-8840-b537e6827b08\",\n\t\tcloud.FileShareUpdateParams{\n\t\t\tProjectID: gcore.Int(1),\n\t\t\tRegionID: gcore.Int(1),\n\t\t},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", taskIDList.Tasks)\n}\n" components: schemas: UpdateFileShareSerializer: properties: name: description: Name example: some_name examples: - some_name pattern: ^[a-zA-Z0-9][a-zA-Z 0-9._\-]{1,61}[a-zA-Z0-9._]$ title: Name type: string share_settings: $ref: '#/components/schemas/VastFileShareSettingsInputSerializer' description: Configuration settings for the share tags: anyOf: - $ref: '#/components/schemas/UpdateTagsSerializer' - type: 'null' description: >- 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. examples: - my-tag: my-tag-value my-tag-to-remove: null title: UpdateFileShareSerializer type: object TaskIDsSerializer: properties: tasks: description: >- 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 examples: - - d478ae29-dedc-4869-82f0-96104425f565 items: type: string title: Tasks type: array required: - tasks title: TaskIDsSerializer type: object VastFileShareSettingsInputSerializer: additionalProperties: false properties: allowed_characters: description: >- Determines which characters are allowed in file names. Choose between: - Lowest Common Denominator (LCD), allows only characters allowed by all VAST Cluster-supported protocols - Native Protocol Limit (NPL), imposes no limitation beyond that of the client protocol. enum: - LCD - NPL example: LCD examples: - LCD title: Allowed Characters type: string x-stainless-terraform-configurability: computed_optional path_length: description: >- Affects the maximum limit of file path component name length. Choose between: - Lowest Common Denominator (LCD), imposes the lowest common denominator file length limit of all VAST Cluster-supported protocols. With this (default) option, the limitation on the length of a single component of the path is 255 characters - Native Protocol Limit (NPL), imposes no limitation beyond that of the client protocol. enum: - LCD - NPL example: LCD examples: - LCD title: Path Length type: string x-stainless-terraform-configurability: computed_optional root_squash: default: true description: >- Enables or disables root squash for NFS clients. - If `true` (default), root squash is enabled: the root user is mapped to nobody for all file and folder management operations on the export. - If `false`, root squash is disabled: the NFS client `root` user retains root privileges. Use this option if you trust the root user not to perform operations that will corrupt data. example: true examples: - true title: Root Squash type: boolean title: VastFileShareSettingsInputSerializer type: object UpdateTagsSerializer: patternProperties: ^[^\s=]+$: anyOf: - maxLength: 255 minLength: 1 pattern: ^[^ \t\n\r\f\v]([^\t\n\r\f\v]*[^ \t\n\r\f\v])?$ type: string - type: 'null' description: >- Tag value. Maximum 255 characters. Cannot contain tabs, newlines, empty string or start/end with whitespace. Set to `null` in order to delete this tag. examples: - my-tag-value propertyNames: description: >- Tag key. Maximum 255 characters. Cannot contain spaces, tabs, newlines, empty string or '=' character. examples: - my-tag maxLength: 255 minLength: 1 title: UpdateTagsSerializer type: object securitySchemes: APIKey: description: >- API key for authentication. Make sure to include the word `apikey`, followed by a single space and then your token. Example: `apikey 1234$abcdef` type: apiKey in: header name: Authorization ````