Qyrus Connection

The Qyrus connection type enables automations to trigger Qyrus test suites and retrieve their pass/fail results. It lets a workflow kick off an automated test run — for example, after a deployment step — wait for the run to finish, and branch on the outcome. Qyrus supports two authentication modes, so make sure you follow the path that matches how your Qyrus account is set up.

Connection Type

Property	Value
Type enum	`QYRUS`
Type ID	`qyrus`
Category	Test Automation
Testable	Yes

When to Use It

Use a Qyrus connection when an automation needs to run tests and act on the result, such as:

Running a regression suite after a deployment step and blocking promotion if it fails.
Kicking off smoke tests on a schedule and raising a ticket when a suite fails.
Gating a release workflow on the pass/fail status of a Qyrus test run.

Friendly Example

What you enter	Example
Connection name	Qyrus - Regression Suite (QA)
Used for	Running the QA regression suite after each deployment and failing the workflow if any test fails
Main details to collect	Qyrus API key (or username and passcode) and the environment
Best person to provide it	Qyrus workspace administrator or the QA automation owner

After it is saved, workflow builders select Qyrus - Regression Suite (QA) in a node and never handle credentials directly.

Authentication Modes

The authMode field is a radio selector that determines which credential fields appear. Pick one mode:

Mode	When to Use	Fields Required
`API_KEY`	You have a Qyrus API key. The gateway URL is derived automatically.	`apiKey`
`USERNAME_PASSCODE`	You authenticate with a username and passcode against a specific gateway endpoint.	`endpoint`, `username`, `passcode`

API_KEY is the default and the recommended mode.

Mandatory Fields

Field	Type	Required	Default	Description
`authMode`	Radio	Yes	`API_KEY`	Authentication mode. One of `API_KEY` or `USERNAME_PASSCODE`. Controls which fields below apply.
`apiKey`	Password	Conditional	--	Qyrus API key. Required when `authMode` is `API_KEY`. Format `sk_<env>_<uuid>`. Encrypted at rest.
`endpoint`	String	Conditional	--	Qyrus service endpoint (gateway) URL. Required when `authMode` is `USERNAME_PASSCODE`. Example: `https://<env>-gateway.qyrus.com`.
`username`	String	Conditional	--	Qyrus username. Required when `authMode` is `USERNAME_PASSCODE`.
`passcode`	Password	Conditional	--	Qyrus passcode. Required when `authMode` is `USERNAME_PASSCODE`. Encoded server-side. Encrypted at rest.

Advanced Fields

Field	Type	Required	Default	Description
`gatewayUrlOverride`	String	No	--	Overrides the gateway URL derived from the API key. Use only when the default per-environment gateway does not apply (API Key mode).
`maxWaitMinutes`	Number	No	`60`	Maximum minutes to poll a test run for completion before timing out.

How the API key derives the gateway

A Qyrus API key follows the format sk_<env>_<uuid> — for example, sk_qa_3f9c1e88-.... The <env> segment identifies your environment and is used to build the gateway URL the platform calls, in the form https://<env>-gateway.qyrus.com. Because the gateway is derived from the key, you do not enter an endpoint in API_KEY mode. If your deployment uses a non-standard gateway host, set gatewayUrlOverride to point at it directly.

How to Create the Connection

Open Global Configurator and go to Connections. Click Create Connection and choose Qyrus from the Test Automation category.
Name the connection. Use a clear name that includes the environment, such as Qyrus - Regression Suite (QA).
Choose an authentication mode.
- API Key — In Qyrus, open Settings → API Keys and generate a key. Copy it (format sk_<env>_<uuid>) and paste it into the API Key field. The gateway is derived automatically from the key's environment segment.
- Username / Passcode — Enter the Qyrus Service Endpoint URL (e.g., https://qa-gateway.qyrus.com), your Username, and your Passcode.
(Optional) Set advanced fields. Adjust maxWaitMinutes if your suites run longer than the 60-minute default, or set gatewayUrlOverride for a non-standard gateway host.
Test and save. Click Test Connection to verify Qinfinite can reach Qyrus with the supplied credentials, then save.

Testing the Connection

Qyrus connections are testable. When you click Test Connection, Qinfinite authenticates against the derived (or overridden) gateway and returns Success, Failure, or Never Tested. The result, timestamp, and any error message are stored on the connection record so the team can see its health at a glance.

Troubleshooting

Symptom	Likely Cause	Fix
`401 Unauthorized`	API key is wrong or revoked, or the username/passcode is incorrect	Regenerate the API key in Qyrus (or re-check the passcode) and update the connection
Connection reaches the wrong environment	The API key's `<env>` segment does not match the intended environment	Use a key for the correct environment, or set `gatewayUrlOverride` to the intended gateway
Test times out or a run never completes	The suite runs longer than `maxWaitMinutes`	Raise `maxWaitMinutes` to cover the suite's expected duration
`Unknown host` / connection refused	The derived gateway host is not reachable from Qinfinite, or a custom gateway is required	Set `gatewayUrlOverride` to the correct gateway URL and verify network access

Connection Type​

When to Use It​

Friendly Example​

Authentication Modes​

Mandatory Fields​

Advanced Fields​

How to Create the Connection​

Testing the Connection​

Troubleshooting​