API reference / Tests and incidents
Add an incident app
Adds an app that sends its errors to Troopy. Give its DSN to the app's Sentry SDK. Troopy keeps errors and crashes, and drops the rest that an SDK sends. Owners and admins.
/api/v1/incident-appsOther ways to call it
troopy incidents add-appIdempotency-Key header. A retry with the same key gets the first answer back, and the operation runs one time.Body
application/jsonname*stringAt least 1 characters · At most 60 characters
platform*enum<string>What it is built with: it picks the Sentry SDK of its setup
websitenextjsnodepythonother
originsarray<string>Sites that may send its errors from a browser, like https://app.example.com. Empty: any site
At most 20 items
keepEmailsbooleanKeep the email of the person that an error names. On unless set
keepIpbooleanKeep the IP address of the person that an error names. Off unless set
Response
201 · application/jsondata*object18 properties
id*stringA 24-character id
name*stringslug*stringThe name as an identifier, like web-app: unique in the workspace
platform*enum<string>websitenextjsnodepythonother
projectId*integerThe number at the end of the DSN: a Sentry SDK needs a number
dsn*string | nullWhat the app's Sentry SDK takes, with its newest key. null when incidents are off on this server
keys*array<object>Its keys, newest first. A rotation keeps the old key for a while
3 properties
key*stringThe public key of the DSN: 32 hex. It is not a secret: it is in the app's code
createdAt*stringISO 8601 date and time
retiresAt*string | nullWhen it stops working, after a new key came. null: it works
origins*array<string>Sites that may send its errors from a browser, like https://app.example.com. Empty: any site
limits*objectErrors that it sends in a minute and in a day. Troopy drops the rest
2 properties
perMinute*integerperDay*integerkeepEmails*booleanWhether Troopy keeps the email of the person that an error names. Off: a code takes its place
keepIp*booleanWhether Troopy keeps the IP address of the person that an error names
paused*booleanA paused app's errors go nowhere: Troopy drops them
environments*array<string>The environments that its errors named, like production
releases*array<object>The releases that its errors named, newest first
2 properties
version*stringfirstSeenAt*stringISO 8601 date and time
lastEventAt*string | nullWhen its latest error came
createdBy*objectWho wrote it
3 properties
type*enum<string>personagentapi
id*stringname*stringcreatedAt*stringISO 8601 date and time
updatedAt*stringISO 8601 date and time