Trigger Probe — POST /api/v1/integration-health/probe
Trigger Probe
Trigger an on-demand health probe for all or a specific provider (QA_LEAD+).
Endpoint: POST /api/v1/integration-health/probe
Authentication: Send a signed-in user’s access token in Authorization: Bearer <access token>, or an API key in X-API-Key: <API key>.
- Your role must be QA lead or higher.
Parameters
Section titled “Parameters”| Name | In | Required | Type | Default | Description |
|---|---|---|---|---|---|
provider | query | no | string or null | ||
project_id | query | no | string (uuid) or null | ||
X-API-Key | header | no | string or null | API key, as an alternative to the access token (see Authentication). |
Request body
Section titled “Request body”No request body.
Responses
Section titled “Responses”| Status | Meaning | Body |
|---|---|---|
200 | Successful Response | Not documented (application/json) |
422 | Validation Error | HTTPValidationError (application/json) |
Response fields not documented. The API specification does not describe the body of every response this endpoint returns, so this page cannot list those fields. The body is not empty. To see it, call the endpoint on your own installation. All endpoints with undocumented responses.
Errors this endpoint returns, read from its source code:
404422, with messages such as “A per-project probe needs provider=github or provider=gitlab”, “GitLab is probed per project: pass project_id”
It can also return 401 if your credential is missing or expired, 403 if your credential does not allow this request, and 404 if the item does not exist or you cannot see it. Your role, your project membership and the key’s scope decide what a credential allows. See Errors and retries.
More details
Section titled “More details”- Group: Integration Health
- Operation ID:
trigger_probe_api_v1_integration_health_probe_post - Source code:
backend/app/routers/integration_health.py, line 236 - Specification: OpenAPI JSON