Noun routes: retire, trace · StartupBuilder

Reference for Noun, one group of Noun routes.

Noun.retire

Retire removes a published Noun from new Versions; its records, its history and every pinned Version keep serving. Verb page.

Text

POST /{namespace}/nouns/{noun}/retire

Path: noun. Emits Noun.retired.

Inputs

Input	Type	Required	Description
`noun`	Noun	required	The Noun to retire.

Returns

Output	Type	Required	Description
`version`	Version	required	The new Version, without the Noun.
`noun`	Noun	required	The Noun, now retired from new Versions.

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 POST https://api.sb/leaseline.app/nouns/noun_v0akLUrXCN/retire \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

JSON

{
  "api": "https://api.sb/leaseline.app",
  "version": {
    "$id": "https://api.sb/leaseline.app/versions/version_4HTEMs14G4",
    "$type": "Version",
    "fingerprint": "sha256:9f2c4e1a7b3d"
  },
  "noun": {
    "$id": "https://api.sb/leaseline.app/nouns/noun_v0akLUrXCN",
    "$type": "Noun",
    "name": "Leaseline",
    "status": "retired"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Noun.retire",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Noun.trace

Trace lists every Verb, Process, Offer, Dashboard and Version that references a Noun, so an edit or a retire shows its reach first. Verb page.