Interface routes: update, delete

Reference for Interface, one group of Interface routes.

Interface.update

Changes the given properties of an Interface. Verb page.

Text

PATCH /{namespace}/interfaces/{id}

Path: id. Body, as JSON: the other inputs. Emits Interface.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Interface.
`kind`	`string`		One of `api`, `mcp`, `cli`, `sdk`, `site`, `app`, `docs`, or `webhooks`.
`path`	`string`		Where it is mounted on its Domain, such as `/api`.
`conformsTo`	`json`		The Standards it also speaks, each mapping the Standard’s operations onto the Product’s Verbs.

Returns

Output	Type	Required	Description
`interface`	Interface	required	The Interface.

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

Terminal

curl -X PATCH https://api.sb/leaseline.app/interfaces/interface_TMyQ3kh9uX \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"kind":"api"}'

JSON

{
  "api": "https://api.sb/leaseline.app",
  "interface": {
    "$id": "https://api.sb/leaseline.app/interfaces/interface_TMyQ3kh9uX",
    "$type": "Interface",
    "kind": "api"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Interface.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Interface.delete

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