API reference
Tests and model changes
Manage regression suites and run them, or compare models on one; read the reference-set runs waiting for your system when a model changes, and post their results.
Route summaries and field names are written in English, here and in the file.
/api/v1/regression
GET /api/v1/regression/suites
The workspace's regression suites
Authentication
API key
Key scope
regression:readAnswers
200 · 401 api_key_missing, api_key_invalid · 403 api_key_scope_denied, api_key_role_denied, ip_not_allowed · 429 · 500 internal_errorPOST /api/v1/regression/suites
Create a regression suite
Authentication
API key
Key scope
regression:writeBody
name (required) · description · provider · model · cases (required)Answers
201 · 400 validation_failed · 401 api_key_missing, api_key_invalid · 402 regression_suite_limit_exceeded · 403 api_key_scope_denied, api_key_role_denied, ip_not_allowed, plan_required · 429 · 500 internal_error · 503 service_unavailablePATCH /api/v1/regression/suites
Change a suite's name, description, provider or model
Authentication
API key
Key scope
regression:writeParameters
suiteId (required)Body
name · description · provider · modelAnswers
200 · 400 validation_failed · 401 api_key_missing, api_key_invalid · 403 api_key_scope_denied, api_key_role_denied, ip_not_allowed · 404 not_found · 429 · 500 internal_error · 503 service_unavailableDELETE /api/v1/regression/suites
Delete a suite and its runs
Authentication
API key
Key scope
regression:writeParameters
suiteId (required)Answers
200 · 400 validation_failed · 401 api_key_missing, api_key_invalid · 403 api_key_scope_denied, api_key_role_denied, ip_not_allowed · 404 not_found · 429 · 500 internal_error · 503 service_unavailableGET /api/v1/regression/runs
The latest regression runs, newest first
Authentication
API key
Key scope
regression:readParameters
suiteIdAnswers
200 · 401 api_key_missing, api_key_invalid · 403 api_key_scope_denied, api_key_role_denied, ip_not_allowed · 429 · 500 internal_error · 503 service_unavailablePOST /api/v1/regression/runs
Run a suite, or compare 2 to 5 models on it
Authentication
API key
Key scope
regression:writeBody
suiteId (required) · provider · model · checkRunId · commitSha · pullNumber · repoFullName · models (required)Answers
202 · 400 validation_failed · 401 api_key_missing, api_key_invalid · 403 api_key_scope_denied, api_key_role_denied, ip_not_allowed, plan_required · 404 not_found · 429 · 500 internal_error · 503 service_unavailableGET /api/v1/regression/runs/{id}
One run, with each case's result
Authentication
API key
Key scope
regression:readParameters
id (required)Answers
200 · 401 api_key_missing, api_key_invalid · 403 api_key_scope_denied, api_key_role_denied, ip_not_allowed · 404 not_found · 429 · 500 internal_error · 503 service_unavailable/api/v1/reference-sets
GET /api/v1/reference-sets/pending
The reference-set runs waiting for your system (model change control)
Authentication
API key
Key scope
usecases:readModule
Served where the deployment runs
FEATURE_MODEL_CHANGE_CONTROL.Answers
200 · 401 api_key_missing, api_key_invalid · 403 api_key_scope_denied, api_key_role_denied, ip_not_allowed, plan_required · 409 capability_off · 429 · 500 internal_error · 501 feature_disabled · 503 service_unavailablePOST /api/v1/reference-sets/receipts
Post the results of a reference-set run your system ran
Authentication
API key
Key scope
usecases:writeModule
Served where the deployment runs
FEATURE_MODEL_CHANGE_CONTROL.Body
runId (required) · servedVersion · results (required)Answers
200 · 400 validation_failed, unknown_case, duplicate_case · 401 api_key_missing, api_key_invalid · 403 api_key_scope_denied, api_key_role_denied, ip_not_allowed, plan_required · 404 run_not_found · 409 run_not_awaiting_client, capability_off · 429 · 500 internal_error · 501 feature_disabled · 503 service_unavailable