TestCaseManagement

Validate TestRail credentials

Changed on

Validates the supplied TestRail credentials against the live TestRail instance and returns the projects and required result fields visible to the credentialed user. Credentials are taken from the request body rather than a saved integration, so a workspace can test them before creating or updating an integration.

post/tcm/external/testrail/validateCredentials/{workspace_id}

Request

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

Path parameters

workspace_idstring required

The workspace ID

Request body

host_urlstring required

Base URL of the TestRail instance, e.g. https://example.testrail.io

usernamestring required

TestRail username to authenticate as

api_keystring required

TestRail API key for the given username

project_idinteger

Optional TestRail project the integration will be bound to. Result-field requiredness is scoped per project, so supplying it narrows required_result_fields to the configs that apply to that project.

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

  • b602223aa51fRevision changes
    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

  • 4e32d22292afRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status