Sign in
TestCaseManagement

Validate Zephyr credentials and settings

Changed on

Validates the supplied Zephyr API token and settings against Zephyr Cloud and returns, for each project the token can read, the test execution statuses available to map outcomes to. Credentials are taken from the request body rather than a saved integration, so a workspace can check them before creating an integration.

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

Request

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

Path parameters

workspace_idstring required

The workspace ID

Request body

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

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

api_keystring required

Zephyr API token

project_keysstring[] required

Jira project keys to check the token can read

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

For cycle_mode fixed, the test cycle key by project key

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