Skip to content

ulams file

Generated from front/cli (ulams schema)

Delete given file.

Kind: destructive (idempotent). Stability: stable. MCP tool: file_delete. Scopes: courses:write.

Endpoints: DELETE /api/admin/file/delete.

Flag Type Required Description
--url string yes
Terminal window
# Delete given file
ulams file delete --url text --json
Input JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"url": {
"type": "string"
}
},
"required": [
"url"
],
"additionalProperties": {}
}

Lists files found by name.

Kind: read (idempotent). Stability: stable. MCP tool: file_find. Scopes: courses:read.

Endpoints: GET /api/admin/file/find.

Flag Type Required Description
--directory string
--name string yes
--page integer
--per-page integer
Terminal window
# Lists files found by name
ulams file find --name Example --json
Input JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"directory": {
"type": "string"
},
"name": {
"type": "string"
},
"page": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"perPage": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"name"
],
"additionalProperties": {}
}

Lists files prefixed by given directory name.

Kind: read (idempotent). Stability: stable. MCP tool: file_list. Scopes: courses:read.

Endpoints: GET /api/admin/file/list.

Flag Type Required Description
--directory string
--page integer
--per-page integer
Terminal window
# Lists files prefixed by given directory name
ulams file list --json
Input JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"directory": {
"type": "string"
},
"page": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"perPage": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"additionalProperties": {}
}

Move the file from one path to another.

Kind: write. Stability: stable. MCP tool: file_move. Scopes: courses:write.

Endpoints: POST /api/admin/file/move.

Flag Type Required Description
--destination-url string yes
--source-url string yes
Terminal window
# Move the file from one path to another
ulams file move --destination-url text --source-url text --json
Input JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"destination_url": {
"type": "string"
},
"source_url": {
"type": "string"
}
},
"required": [
"destination_url",
"source_url"
],
"additionalProperties": {}
}

Upload files using multipart form-data.

Kind: write. Stability: stable. MCP tool: file_upload. Scopes: courses:write.

Endpoints: POST /api/admin/file/upload.

Flag Type Required Description
--file[] array yes
--target string yes
Terminal window
# Upload files using multipart form-data
ulams file upload --file[] text --target text --json
Input JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"file[]": {
"type": "array",
"items": {
"type": "string"
}
},
"target": {
"type": "string"
}
},
"required": [
"file[]",
"target"
],
"additionalProperties": {}
}