The TestRail the project imports from

GET

/v1/projects/{id}/integrations/testrail

const url = 'https://beta-api.plune.ai/v1/projects/example/integrations/testrail';
const options = {method: 'GET', headers: {cookie: 'plune_session=<plune_session>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://beta-api.plune.ai/v1/projects/example/integrations/testrail \
  --cookie plune_session=<plune_session>

Every member of the project reads it, a reader too: { "configured": false } when none is connected, otherwise the address, when the key was saved and by whom, and what the last check or step found out about it. The owner reads the e-mail as well. Nobody reads the key — not in full, not in part. A project you are not in answers 404, the same as one that does not exist. Session cookie only: a CLI token is refused with 401.

Authorizations

cookieAuth

Parameters

Path Parameters

required

string

An id from GET /v1/projects

Responses

200

The connection, or { "configured": false }

application/json

The TestRail connection of a project, as a member of it reads it. With none it is { "configured": false }. The key is not in it, nor any part of it.

object

configured

required

boolean

baseUrl

Present exactly when configured is true, as every field below.

string

email

Owner only.

string

keySet

Always true when configured — the answer to “is there a key”, and all it says of it.

boolean

keySavedAt

string format: date-time

keySavedBy

userId of the owner who saved the key.

string

status

untested after a save; ok after a check or a step that went through; credentials_rejected when TestRail refused the key; unreachable when the check could not talk to the instance.

string

Allowed values: untested ok credentials_rejected unreachable

verifiedAt

string format: date-time

nullable

Example

{
  "configured": true,
  "baseUrl": "https://tr.example.com",
  "email": "[email protected]",
  "keySet": true,
  "keySavedAt": "2026-09-16T09:12:04.151Z",
  "keySavedBy": "u-shop",
  "status": "ok",
  "verifiedAt": "2026-09-16T09:12:04.151Z"
}

401

No / invalid session — a CLI token is refused here

404

No such project among yours

application/json

object

error

required

string

Example

{
  "error": "project 'u-shop::default' not found"
}

503

The server has no key to keep TestRail keys under — the operator has not set TESTRAIL_ENCRYPTION_KEY

application/json

object

error

required

string

Example

{
  "error": "the TestRail bridge is not configured on this server - contact your operator"
}