Portal commands: update, delete
The Portal Verbs update, delete as CLI commands, with inputs, result, refusals and an example.
Reference for Portal, one group of Portal commands.
Portal.update
Changes the given properties of a Portal. Verb page.
npx startup-builder do Portal.update --json '<input>' [--try | --send | --do]Emits Portal.updated.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Portal. |
path | string | Where it is mounted on the Site, / by default. | |
tools | string[] | Developer tools a keyed Offer adds: keys, usage, requests, watches, version and testMode. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
portal | Portal | required | The Portal. |
Refuses when
| Check | Error | Fix | Then call |
|---|---|---|---|
| The key is valid, but its scopes do not allow this operation. | forbidden | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |
Example
npx startup-builder do Portal.update --json '{"id":Portal.delete
Deletes a Portal: a soft delete that keeps its history, undone by Thing.restore. Verb page.
npx startup-builder do Portal.delete --json '<input>' [--try | --send | --do]Emits Portal.deleted.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Portal. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
portal | Portal | required | The Portal. |
Refuses when
| Check | Error | Fix | Then call |
|---|---|---|---|
| The key is valid, but its scopes do not allow this operation. | forbidden | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |
Example
npx startup-builder do Portal.delete --json '{"id":