jupyter-fsspec API (0.4.0)

Download OpenAPI specification:

List all source filesystems in configuration file

Responses

Response samples

200
400
500

Content type

application/json

{"sources": [{"name": "string",
"path": "string",
"protocol": "string",
"args": [ ],
"kwargs": { }
}
]
}

List content at the specified path of the {key} fi

List content at the specified path of the {key} filesystem

query Parameters

key

required

string

Unique name identifying the filesystem

Request Body schema: application/json

key required	string (Filesystem name) Unique identifier given as the filesystem 'name' in the config file
item_path required	string (Path) Acting path in filesystem
	RequestType (string) or Type of GET request (null) (Type of GET request) Default: "default" Either a 'range' GET request for file or 'default' for normal GET

Responses

Request samples

Payload

Content type

application/json

{"key": "string",
"item_path": "string",
"type": "default"
}

Response samples

200
400
500

Content type

application/json

{"status": "success",
"description": "string",
"content": [{ }
]
}

Update existing file

Request Body schema: application/json

key required	string (Filesystem name) Unique identifier given as the filesystem 'name' in the config file
item_path required	string (Path) Acting path in filesystem
	(File content or file/directory name (string)) or (File content or file/directory name (null)) (File content or file/directory name) Content to be created upon request
	RequestAction"move" (string) or (Move or copy action indicator (null)) (Move or copy action indicator) Specify 'move' action when calling action handler, default treated as copy
	Base64 content payload (boolean) or Base64 content payload (null) (Base64 content payload) Default: false Indicate base64 content in request payload

Responses

Request samples

Payload

Content type

application/json

{"key": "string",
"item_path": "string",
"content": "string",
"action": "move",
"base64": false
}

Response samples

200
400
500

Content type

application/json

{"status": "success",
"description": "string",
"content": [{ }
]
}

Create a file or directory based on provided conte

Create a file or directory based on provided content

Request Body schema: application/json

key required	string (Filesystem name) Unique identifier given as the filesystem 'name' in the config file
item_path required	string (Path) Acting path in filesystem
	(File content or file/directory name (string)) or (File content or file/directory name (null)) (File content or file/directory name) Content to be created upon request
	RequestAction"move" (string) or (Move or copy action indicator (null)) (Move or copy action indicator) Specify 'move' action when calling action handler, default treated as copy
	Base64 content payload (boolean) or Base64 content payload (null) (Base64 content payload) Default: false Indicate base64 content in request payload

Responses

Request samples

Payload

Content type

application/json

{"key": "string",
"item_path": "string",
"content": "string",
"action": "move",
"base64": false
}

Response samples

200
400
500

Content type

application/json

{"status": "success",
"description": "string",
"content": [{ }
]
}

Delete the file or directory specified by path

Request Body schema: application/json

key required	string (Filesystem name) Unique identifier given as the filesystem 'name' in the config file
item_path required	string (Path) Acting path in filesystem

Responses

Request samples

Payload

Content type

application/json

{"key": "string",
"item_path": "string"
}

Response samples

200
400
500

Content type

application/json

{"status": "success",
"description": "string",
"content": [{ }
]
}

Move or, by default, copy path to destination

Request Body schema: application/json

key required	string (Filesystem name) Unique identifier given as the filesystem 'name' in the config file
item_path required	string (Path) Acting path in filesystem
	(File content or file/directory name (string)) or (File content or file/directory name (null)) (File content or file/directory name) Content to be created upon request
	RequestAction"move" (string) or (Move or copy action indicator (null)) (Move or copy action indicator) Specify 'move' action when calling action handler, default treated as copy
	Base64 content payload (boolean) or Base64 content payload (null) (Base64 content payload) Default: false Indicate base64 content in request payload

Responses

Request samples

Payload

Content type

application/json

{"key": "string",
"item_path": "string",
"content": "string",
"action": "move",
"base64": false
}

Response samples

200
400
500

Content type

application/json

{"status": "success",
"description": "string",
"content": [{ }
]
}

Rename path to content provided

Request Body schema: application/json

key required	string (Filesystem name) Unique identifier given as the filesystem 'name' in the config file
item_path required	string (Path) Acting path in filesystem
	(File content or file/directory name (string)) or (File content or file/directory name (null)) (File content or file/directory name) Content to be created upon request
	RequestAction"move" (string) or (Move or copy action indicator (null)) (Move or copy action indicator) Specify 'move' action when calling action handler, default treated as copy
	Base64 content payload (boolean) or Base64 content payload (null) (Base64 content payload) Default: false Indicate base64 content in request payload

Responses

Request samples

Payload

Content type

application/json

{"key": "string",
"item_path": "string",
"content": "string",
"action": "move",
"base64": false
}

Response samples

200
400
500

Content type

application/json

{"status": "success",
"description": "string",
"content": [{ }
]
}

Upload or download file(s) source path to destinat

Upload or download file(s) source path to destination path

Request Body schema: application/json

key required	string (Source filesystem name) Unique identifier given as the filesystem 'name' in the config file
destination_key required	string (Destination filesystem name) Unique identifier given as the filesystem 'name' in the config file
local_path required	string (Local Path)
remote_path required	string (Remote Path)
action required	string (Transfer direction) Enum: "upload" "download" Can be 'upload' or 'download for local to remote or remote to local respectively

Responses

Request samples

Payload

Content type

application/json

{"key": "string",
"destination_key": "string",
"local_path": "string",
"remote_path": "string",
"action": "upload"
}

Response samples

200
400
500

Content type

application/json

{"status": "success",
"description": "string",
"content": [{ }
]
}