Skip to content

Interface commands: update, delete

The Interface Verbs update, delete as CLI commands, with inputs, result, refusals and an example.

Reference for Interface, one group of Interface commands.

Interface.update

Changes the given properties of an Interface. Verb page.

Text
npx startup-builder do Interface.update --json '<input>' [--try | --send | --do]

Emits Interface.updated.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Interface.
kindstringOne of api, mcp, cli, sdk, site, app, docs, or webhooks.
pathstringWhere it is mounted on its Domain, such as /api.
conformsTojsonThe Standards it also speaks, each mapping the Standard’s operations onto the Product’s Verbs.

Returns

OutputTypeRequiredDescription
interfaceInterfacerequiredThe Interface.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
npx startup-builder do Interface.update --json '{"id":"interface_TMyQ3kh9uX","kind":"api"}'

Interface.delete

Deletes an Interface: a soft delete that keeps its history, undone by Thing.restore. Verb page.

Text
npx startup-builder do Interface.delete --json '<input>' [--try | --send | --do]

Emits Interface.deleted.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Interface.

Returns

OutputTypeRequiredDescription
interfaceInterfacerequiredThe Interface.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
npx startup-builder do Interface.delete --json '{"id":"interface_TMyQ3kh9uX"}'