Skip to main content
TroopyDocs
Open Troopy
Troopy

API reference / Tests and incidents

Read the settings of Tests

Whether the QA tester comments on pull requests, whether a place whose scheduled checks begin to fail gets a bug ticket, and whether the checks of a released ticket become a proposed test.

get/api/v1/test-settings

Authorization

HeaderAuthorization: Bearer <API key>
Or the headerX-API-Key: <API key>
API keyMake one in Troopy under Settings > API keys. It acts as you, in its workspace.

Other ways to call it

CLItroopy tests settings
MCP tooltroopy_get_test_settings
Rate limit120 calls in 60 seconds, for each key

Response

200 · application/json
data*object
4 properties
prComments*boolean

Whether the QA tester and Troopy's code review comment their reports of a ticket on the pull request: private repos only

autoTickets*boolean

Whether a place whose scheduled checks begin to fail gets a bug ticket in the backlog. While that ticket is open, new failures go on it as comments

keepChecks*boolean

Whether the checks of a released ticket become a proposed test of the library

releaseChecks*boolean

Whether Troopy checks Production after each release, once the release reaches Production on GitHub: the main path, and the released tickets' tests

Errors

401 unauthorizedSend an API key as `Authorization: Bearer tr_live_...`. Create one in Troopy under Settings.
403 forbiddenThe key lacks a scope this operation needs, or its owner lacks the role. detail says which; create a key with the scope, or ask an organization owner or admin.
429 rate_limitedWait the number of seconds in Retry-After, then retry.