Generated from
@teamgrid/cli@1.0.6at Developer Platform commite6f6b47fa223. Runnode scripts/sync-cli-reference.mjs --checkto detect drift; do not edit this page manually.
create and complete direct file uploads.
Global options
Global options can be placed before the command group.
| Option | Description | Required | Choices | Default |
|---|---|---|---|---|
-V, --version |
output the version number | No | — | — |
-o, --output <format> |
output format | No | table, json, jsonl |
table |
--profile <name> |
credential profile | No | — | — |
--base-url <url> |
override the regional API v1 base URL | No | — | — |
--timeout <milliseconds> |
request timeout | No | — | 30000 |
--retries <count> |
safe-request retry count (0–5) | No | — | 2 |
Commands
teamgrid file-upload-intents create— Reserve and create a private file upload intent.teamgrid file-upload-intents finalize— Finalize a file upload intent.teamgrid file-upload-intents cancel— Cancel a file upload intent.
teamgrid file-upload-intents create
Reserve and create a private file upload intent.
Syntax
teamgrid file-upload-intents create [options]API operation and scope
| Operation | HTTP | Scope | API reference |
|---|---|---|---|
createFileUploadIntent |
POST /file-upload-intents |
files:write |
Reserve and create a private file upload intent |
Command options
| Option | Description | Required | Choices | Default |
|---|---|---|---|---|
--data <json|@file|-> |
file upload intent JSON | Yes | — | — |
--idempotency-key <key> |
stable retry key | No | — | — |
The global options and implicit -h, --help option also apply.
Output
The command uses the global output mode: human-readable table by default, or machine-readable json/jsonl.
Example
teamgrid file-upload-intents create --data @request.jsonExit codes
The command uses the stable CLI exit codes (0, 1, 2, 3, 4, 5, 6, 7, 130). See the linked table for the meaning and automation behavior of each code.
teamgrid file-upload-intents finalize
Finalize a file upload intent.
Syntax
teamgrid file-upload-intents finalize [options] <id>API operation and scope
| Operation | HTTP | Scope | API reference |
|---|---|---|---|
finalizeFileUploadIntent |
POST /file-upload-intents/{id}/finalize |
files:write |
Finalize a file upload intent |
Arguments
| Argument | Required | Variadic | Choices | Default | Description |
|---|---|---|---|---|---|
id |
Yes | No | — | — | Identifier or value named by the command syntax. |
Command options
This command defines no additional options.
The global options and implicit -h, --help option also apply.
Output
The command uses the global output mode: human-readable table by default, or machine-readable json/jsonl.
Example
teamgrid file-upload-intents finalize IDExit codes
The command uses the stable CLI exit codes (0, 1, 2, 3, 4, 5, 6, 7, 130). See the linked table for the meaning and automation behavior of each code.
teamgrid file-upload-intents cancel
Cancel a file upload intent.
Syntax
teamgrid file-upload-intents cancel [options] <id>API operation and scope
| Operation | HTTP | Scope | API reference |
|---|---|---|---|
cancelFileUploadIntent |
DELETE /file-upload-intents/{id} |
files:write |
Cancel a file upload intent |
Arguments
| Argument | Required | Variadic | Choices | Default | Description |
|---|---|---|---|---|---|
id |
Yes | No | — | — | Identifier or value named by the command syntax. |
Command options
| Option | Description | Required | Choices | Default |
|---|---|---|---|---|
-y, --yes |
skip the destructive-operation confirmation | No | — | — |
The global options and implicit -h, --help option also apply.
Output
The command uses the global output mode: human-readable table by default, or machine-readable json/jsonl.
Confirmation and automation
This command can change or remove data and asks for confirmation by default. In a reviewed non-interactive job, pass --yes or set TEAMGRID_CLI_ASSUME_YES=1; otherwise the command exits with code 2. Cancelling an interactive confirmation exits with code 0.
Example
teamgrid file-upload-intents cancel IDExit codes
The command uses the stable CLI exit codes (0, 1, 2, 3, 4, 5, 6, 7, 130). See the linked table for the meaning and automation behavior of each code.