> ## Documentation Index > Fetch the complete documentation index at: https://docs.everabyte.com/llms.txt > Use this file to discover all available pages before exploring further. # Update file metadata or retention > Updates a file's display name, visibility, retention period, or metadata. The body schema is strict: unknown keys are rejected. `name` excludes the extension. To change the extension you must upload a new version. Required scopes: `buckets:write` + `files:write`. ## OpenAPI ````yaml /api-reference/openapi.json put /files/update/{fileId} openapi: 3.1.0 info: title: Everabyte Storage API version: '2026.10' summary: Company-scoped storage API authenticated with API keys. description: >- The Everabyte storage API for company workspaces. Every operation here is reachable with an API key and has been verified against route registration and controller behavior. Authentication uses two headers: `X-Public-Key` and `X-Secret-Key`. API-key headers are not CORS-allowed, so this API is for server-side use only. Response shapes vary by layer. Success responses use `{status, message, data}`. Middleware errors use `{status, message, data, code}`. Controller errors use `{status, message, error}`. See the Conventions page for details. All examples are illustrative. Identifiers, sizes, and timestamps are placeholders, not production data. contact: name: Everabyte Support email: support@everabyte.com url: https://everabyte.com license: name: Proprietary servers: - url: https://api.everabyte.io/api description: Production security: - PublicKey: [] SecretKey: [] tags: - name: Files description: >- List, upload, download, update, move, copy, delete, restore, and version files. - name: Folders description: Browse and manage the folder tree inside a bucket. - name: Buckets description: Discover the buckets a key can reach and read their stored size. paths: /files/update/{fileId}: put: tags: - Files summary: Update file metadata or retention description: >- Updates a file's display name, visibility, retention period, or metadata. The body schema is strict: unknown keys are rejected. `name` excludes the extension. To change the extension you must upload a new version. Required scopes: `buckets:write` + `files:write`. operationId: updateFile parameters: - $ref: '#/components/parameters/FileId' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/FileUpdateRequest' responses: '200': description: Updated file. content: application/json: schema: type: object required: - status - message - data properties: status: type: integer example: 200 message: type: string example: File updated data: $ref: '#/components/schemas/FileSummary' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/PaymentRequired' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/RateLimited' '500': $ref: '#/components/responses/ServerError' components: parameters: FileId: name: fileId in: path required: true description: File identifier. schema: type: string format: uuid schemas: FileUpdateRequest: type: object description: Strict schema. Unknown keys are rejected. properties: name: type: string minLength: 1 maxLength: 255 description: Display name, without the extension. visibility: type: string enum: - private - public retentionPeriod: type: string enum: - 30d - 45d - 90d - 120d - 180d - 1Y - 2Y - 3Y - 5Y metadata: type: object additionalProperties: true description: >- Free-form metadata object. Tags are managed through dedicated dashboard flows. version: type: integer minimum: 1 description: >- Client-side optimistic-concurrency token. Accepted but not trusted for writes. additionalProperties: false FileSummary: type: object description: >- File record. Additional fields may be present; undocumented fields are not a stable contract. required: - id - name properties: id: type: string format: uuid name: type: string description: Display name without the extension. extFile: type: string description: Lowercased extension without a leading dot. sizeByte: type: integer readableSize: type: string description: Human-readable size string. bucketId: type: string format: uuid folderId: type: - string - 'null' format: uuid visibility: type: string enum: - private - public type: type: string example: file createdAt: type: string format: date-time updatedAt: type: string format: date-time downloadUrl: type: string tags: type: array items: type: string sharedUsersCount: type: integer sharedLink: type: - object - 'null' additionalProperties: true description: Active shared link, when one exists and the file is public. additionalProperties: true ErrorEnvelope: type: object description: >- Error shape varies by layer. Middleware errors include `code`; controller errors include `error`; framework errors may use `statusCode`. properties: status: type: integer statusCode: type: integer message: type: string error: type: - string - object - 'null' code: type: string data: type: - object - array - 'null' additionalProperties: true responses: BadRequest: description: Validation or request error. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' Unauthorized: description: Missing, malformed, revoked, or expired credentials. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' PaymentRequired: description: >- Billing state or storage capacity prevents the operation. May include `SUBSCRIPTION_REQUIRED`. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' Forbidden: description: >- Authorization failure. Stable codes include `API_COMPANY_ONLY`, `API_KEY_SURFACE_DENIED`, `API_BUCKET_SCOPE_DENIED`, `TRIAL_API_LIMIT_REACHED`, and `DEVICE_BLOCKED`. A missing scope usually returns no code. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' NotFound: description: Resource not found or not visible to this key. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' RateLimited: description: >- Request rate exceeded. Stable code `API_KEY_RATE_LIMITED`. No `Retry-After` header is documented; use exponential backoff with jitter. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' ServerError: description: Unexpected server error. Messages are sanitized in production. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' securitySchemes: PublicKey: type: apiKey in: header name: X-Public-Key description: >- Public half of the company API key. Format: `pk_` followed by 64 hexadecimal characters. SecretKey: type: apiKey in: header name: X-Secret-Key description: >- Secret half of the company API key. Format: `sk_` followed by 64 hexadecimal characters. Stored as a hash server-side and shown only at creation or rotation. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.