Sign in
TestCaseManagement

Re-validate a saved Zephyr integration

Changed on

Validates the token stored in the given Zephyr integration, with its saved settings or the settings supplied in the body, against Zephyr Cloud. The token is write-only and never returned by the API, so this is how a saved integration is re-checked, or an edit is checked before saving, without the caller possessing the token. The response never includes the token.

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

Request

  • Base URL: https://api.mabl.com
  • URL: https://api.mabl.com/tcm/external/zephyr/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 Zephyr workspace integration to validate

Request body

region'us' | 'eu' | 'au' | 'de'

The Zephyr Cloud region hosting the instance; selects the API host.

project_keysstring[]
cycle_mode'per_plan_run' | 'fixed'

per_plan_run: each plan run's results go to a test cycle mabl creates for it. fixed: results go to the configured cycle of each project.

fixed_cycle_keysobject

Response

Validation result

validboolean required

True if the token can read every project and the settings fit them

error_messagestring

Why validation failed

token_expires_atinteger

UTC epoch milliseconds at which the token expires, when it says

Changes