TestCaseManagement

Re-validate the credentials stored in a TestRail integration

Validates the credentials stored in the given TestRail workspace integration against the live TestRail instance and returns the projects and required result fields visible to the credentialed user. The TestRail API key is write-only and never returned by the API, so this is how an existing integration is re-checked without the caller possessing the key. The response never includes the key.

post/tcm/external/testrail/integrations/{workspace_integration_id}/validateCredentials

Request

  • Base URL: https://api.mabl.com
  • URL: https://api.mabl.com/tcm/external/testrail/integrations/{workspace_integration_id}/validateCredentials
  • Auth: one of:
    • HTTP basic
    • API key in header Authorization

Path parameters

workspace_integration_idstring required

Unique identifier for the TestRail workspace integration to validate

Response

Validation result

validboolean required

True if the supplied TestRail credentials are valid

error_messagestring

Error description when validation fails

required_result_fieldsstring[]

System names of TestRail result fields marked as required

Changes