Skip to content

by Startups.Studio

Product Build and ship Issue Incident

Incident.get

GET /{namespace}/incidents/{id}

Returns one Incident by id.

Noun: Incident
Mode: read

You, to your agent

Show me the latest incident.

curl https://api.sb/petpantry.shop/incidents/incident_1 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

import { $ } from 'startup-builder'

const incident = await $.Incident.get({ id: 'incident_1' })

npx startup-builder do Incident.get --json '{"id":"incident_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Incident.get({ id: 'incident_1' })"
  }
}

Get returns one Incident by id. It is inherited: every Noun has get, list, create, update and delete.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Incident.
`at`	`string`		A time or Version name: the record as it stood then. Unset: as it stands now.

Outputs

Output	Type	Required	Description
`incident`	Incident	required	The Incident.

Effects

Reads only: it emits no Event and changes nothing.
Read: try, do.

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.	Incident.get

When it waits

Never: a read runs at once.

Incident.delete

Previous Page

Incident.list

Next Page