Skip to content
StartupBuilder
by startups.studio
by Startups.Studio
Code
Changelog
APICore grammarVerb

Verb routes: retire

The Verb Verbs retire as api.sb routes, with inputs, result, refusals and an example.

Reference for Verb, one group of Verb routes.

Verb.retire

Retire removes a published Verb from new Versions; callers pinned to earlier Versions keep calling it. Verb page.

Text
POST /{namespace}/verbs/{verb}/retire

Path: verb. Emits Verb.retired.

Inputs

InputTypeRequiredDescription
verbVerbrequiredThe Verb to retire.

Returns

OutputTypeRequiredDescription
versionVersionrequiredThe new Version, without the Verb.
verbVerbrequiredThe Verb, now retired from new Versions.

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
curl -X POST https://api.sb/leaseline.app/verbs/verb_hlkWBvrAyZ/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"
  },
  "verb": {
    "$id": "https://api.sb/leaseline.app/verbs/verb_hlkWBvrAyZ",
    "$type": "Verb",
    "name": "Leaseline",
    "event": "Example event",
    "status": "retired"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Verb.retire",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

update, delete

Previous

Version

Next