Guard routes: update, delete

Reference for Guard, one group of Guard routes.

Guard.update

Changes the given properties of a Guard. Verb page.

Text

PATCH /{namespace}/guards/{id}

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

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Guard.
`tier`	`string`		One of `code`, `model`, `reviewer`, or `human`.
`checks`	`string`		What it refuses; a `claim` Guard checks a stated term or promise against the record that backs it. Never randomized.

Returns

Output	Type	Required	Description
`guard`	Guard	required	The Guard.

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/guards/guard_WtKo3jQi6J \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"tier":"code"}'

JSON

{
  "api": "https://api.sb/leaseline.app",
  "guard": {
    "$id": "https://api.sb/leaseline.app/guards/guard_WtKo3jQi6J",
    "$type": "Guard",
    "tier": "code"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Guard.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Guard.delete

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