Files

Specification

{
  "name": "<String>",
  "installedFileName": "<String>",
  "extension": "<String>",
  "description": "<String>",
  "mimeType": "<String>"
}

Structure values

Field Name	Type	Description	Required	Default
name	String	Metadata reference name. The name to use when referring to the file in other metadata commands.	Required
installedFileName	String	The name the file is installed under on a cluster — useful for files (e.g. wheels) that need a specific name to install correctly. A supplied or inferred name ending in .<extension> (case-insensitive) has that one suffix stripped when the file is created, so the installed name doesn't end up with the extension doubled.	Optional	The uploaded file's own name; if that's unavailable, falls back to name.
extension	String	The file extension. Never inferred from the uploaded file's name — always taken from this field.	Required
description	String	Description of the file	Optional	None
mimeType	String	MIME type of the file	Optional	None

A name that is exactly .<extension> — a dotfile, like .bashrc with extension bashrc — strips to an empty stem and installs as .<extension>, rather than being rejected.

Example

{
  "name": "bootstrap-deps",
  "installedFileName": "pandas-2.1.0-py3-none-any.whl",
  "extension": "whl",
  "description": "Custom pandas wheel to be installed on cluster startup",
  "mimeType": "application/octet-stream"
}