Endtest

https://endtest.io/docs
Admin
Endtest is a low-code test automation platform that enables teams to create, execute, and maintain...
Tokens:129,420
Snippets:1,043
Trust Score:8.9
Update:3 days ago
Show doc for...
Tokens:
Raw
### Apply blue-green rollout example

Source: https://endtest.io/docs/integrations/argo

Apply the complete blue-green rollout example from the repository.

```bash
kubectl apply \
  -f https://raw.githubusercontent.com/endtest-technologies/endtest-argo/v0.2.1/examples/blue-green-rollout.yaml
```

--------------------------------

### Apply complete canary example

Source: https://endtest.io/docs/integrations/argo

Applies a full canary rollout configuration example from the repository.

```bash
kubectl apply \
  -f https://raw.githubusercontent.com/endtest-technologies/endtest-argo/v0.2.1/examples/canary-rollout.yaml
```

--------------------------------

### run_web_test example response

Source: https://endtest.io/docs/advanced/endtest-mcp

Example JSON response from run_web_test showing started status, test suite ID, hashes, and result URLs.

```json
{
  "started": true,
  "test_suite_id": 58127403916,
  "hashes": [
    "Df4hiJHj5SD5wr9MK63OmeVHAODklEx0An"
  ],
  "results": [
    {
      "hash": "Df4hiJHj5SD5wr9MK63OmeVHAODklEx0An",
      "result_url": "https://app.endtest.io/results?hash=Df4hiJHj5SD5wr9MK63OmeVHAODklEx0An"
    }
  ]
}
```

--------------------------------

### Start Test Suite with Vercel Deployment URL

Source: https://endtest.io/docs/integrations/vercel

Example of using the {{VERCEL_DEPLOYMENT_URL}} placeholder in a curl request to trigger an Endtest test suite against a Vercel deployment.

```bash
curl -X POST "https://app.endtest.io/api.php" \
  -d "appId=YOUR_APP_ID" \
  -d "appCode=YOUR_APP_CODE" \
  -d "action=startTestSuite" \
  -d "testSuite=YOUR_TEST_SUITE_ID" \
  -d "baseUrl={{VERCEL_DEPLOYMENT_URL}}"
```

--------------------------------

### GET Start Web Test Execution

Source: https://endtest.io/docs/advanced/how-to-use-the-endtest-api

Starts a web test execution using the Endtest API. The request is a GET call with parameters including action, appId, appCode, suite, platform, os, browser, browserVersion, resolution, geolocation, cases, and notes.

```APIDOC
## GET Start Web Test Execution

### Description
Starts a web test execution using the Endtest API. The request is a GET call with parameters including action, appId, appCode, suite, platform, os, browser, browserVersion, resolution, geolocation, cases, and notes.

### Method
GET

### Endpoint
(Endpoint not explicitly provided in source)

### Parameters
#### Query Parameters
- **action** (string) - Required - The type of action (runWeb)
- **appId** (string) - Required - The App ID of the user
- **appCode** (string) - Required - The App Code of the user
- **suite** (string) - Required - The ID of the test suite
- **platform** (string) - Required - The platform to run the test on
- **os** (string) - Required - The operating system for the execution
- **browser** (string) - Required - The browser for the execution
- **browserVersion** (string) - Optional - The browser version for the execution (latest or beta)
- **resolution** (string) - Optional - The screen resolution for the execution
- **geolocation** (string) - Optional - The Geolocation for the execution
- **cases** (string) - Optional - The test cases to be executed
- **notes** (string) - Optional - Notes that will appear in the execution

### Request Example
(No explicit example provided in source)

### Response
#### Success Response (200)
- **hash** (string) - A hash that uniquely identifies the test execution

#### Response Example
(No explicit example provided in source)
```

--------------------------------

### GET runWeb (Start Multiple Web Test Executions)

Source: https://endtest.io/docs/advanced/how-to-use-the-endtest-api

Starts multiple web test executions by providing a label instead of a suite ID. The request must be made with an HTTP GET method.

```APIDOC
## GET runWeb

### Description
Starts multiple web test executions by providing a label instead of a suite ID. The request must be made with an HTTP GET method.

### Method
GET

### Endpoint
Not specified in the source.

### Parameters
#### Query Parameters
- **action** (string) - Required - The type of action (runWeb)
- **appId** (string) - Required - The App ID of the user
- **appCode** (string) - Required - The App Code of the user
- **label** (string) - Required - The label assigned to the test suites (case-sensitive, only one label per request)
- **platform** (string) - Required - The platform to run the test on
- **os** (string) - Required - The operating system for the execution
- **browser** (string) - Required - The browser for the execution
- **browserVersion** (string) - Required - The browser version for the execution (latest or beta)
- **resolution** (string) - Required - The screen resolution for the execution
- **geolocation** (string) - Required - The Geolocation for the execution
- **cases** (string) - Required - The test cases to be executed
- **notes** (string) - Optional - Notes that will appear in the execution

### Response
#### Success Response
- **execution hashes** (string) - The unique hashes for each test execution, separated by commas.

#### Response Example
Not provided in the source.

```

--------------------------------

### get_test_case_steps response example

Source: https://endtest.io/docs/advanced/endtest-mcp

Example JSON response for get_test_case_steps, containing test case metadata and a list of execution steps.

```json
{
  "test_case": {
    "id": 76483920155,
    "name": "Checkout Flow",
    "test_suite_id": 58127403916,
    "test_suite_name": "Checkout Regression - Demo Store"
  },
  "steps": [
    {
      "id": 59832471602,
      "step_name": "Go to URL",
      "step_number": 1,
      "type": "GoToUrl",
      "locator": "",
      "parameter1": "https://endtest-demo.io",
      "parameter2": "",
      "parameter3": ""
    }
  ],
  "step_count": 1
}
```

--------------------------------

### runWeb - Start multiple test suites by label

Source: https://endtest.io/docs/integrations/argo

Starts all test suites with a given label. Returns a comma-separated list of execution hashes.

```APIDOC
## [GET] https://app.endtest.io/api.php?action=runWeb

### Description
Starts multiple Endtest test suites that share the same label.

### Method
GET

### Endpoint
https://app.endtest.io/api.php?action=runWeb

### Parameters
#### Query Parameters
- **action** (string) - Required - Must be `runWeb`.
- **appId** (string) - Required - The application ID.
- **appCode** (string) - Required - The application code.
- **label** (string) - Required - The label assigned to the test suites to run.
- **platform** (string) - Optional - The platform to run on (e.g., `windows`).
- **os** (string) - Optional - The operating system (e.g., `windows11`).
- **browser** (string) - Optional - The browser to use (e.g., `chrome`).
- **browserVersion** (string) - Optional - The browser version (e.g., `latest`).
- **resolution** (string) - Optional - The screen resolution (e.g., `1280x1024`).
- **geolocation** (string) - Optional - The geolocation (e.g., `sanfrancisco`).
- **cases** (string) - Optional - Which cases to run (e.g., `all`).
- **notes** (string) - Optional - Any notes.

### Request Example
https://app.endtest.io/api.php?action=runWeb&appId=APP_ID&appCode=APP_CODE&label=Critical&platform=windows&os=windows11&browser=chrome&browserVersion=latest&resolution=1280x1024&geolocation=sanfrancisco&cases=all&notes=

### Response
#### Success Response (200)
- **hashes** (string) - Comma-separated list of execution hashes for the started suites.

#### Response Example
HASH_ONE,HASH_TWO
```

--------------------------------

### run_mobile_test example request

Source: https://endtest.io/docs/advanced/endtest-mcp

Example JSON request for run_mobile_test with test_suite_id, platform, device, and app parameters.

```json
{
  "test_suite_id": 48012973542,
  "platform": "android",
  "device": "DEVICE_NAME",
  "app": "APP_URL_OR_IDENTIFIER"
}
```

--------------------------------

### add_team_member example request

Source: https://endtest.io/docs/advanced/endtest-mcp

Example JSON request for add_team_member with the required email parameter.

```json
{
  "email": "qa@example.com"
}
```

--------------------------------

### create_group example request

Source: https://endtest.io/docs/advanced/endtest-mcp

Example JSON request for create_group with the required name parameter.

```json
{
  "name": "Regression Team"
}
```

--------------------------------

### get_test_suite_structure request and response example

Source: https://endtest.io/docs/advanced/endtest-mcp

Example request and corresponding response structure for retrieving the complete hierarchy of a test suite.

```json
{
  "test_suite_id": 58127403916
}
```

```json
{
  "test_suite": {
    "id": 58127403916,
    "name": "Checkout Regression - Demo Store",
    "type": "web",
    "project": "All Projects",
    "labels": [
      "Regression"
    ]
  },
  "test_cases": [
    {
      "id": 76483920147,
      "name": "Initialize Test Data",
      "position": 1,
      "step_count": 4,
      "steps": []
    },
    {
      "id": 76483920155,
      "name": "Checkout Flow",
      "position": 2,
      "step_count": 15,
      "steps": []
    }
  ],
  "test_case_count": 2,
  "step_count": 19
}
```

--------------------------------

### Install jq package

Source: https://endtest.io/docs/advanced/how-to-use-the-endtest-api

Command to install the jq package required for processing JSON output in the script.

```sh
sudo apt-get install jq
```

--------------------------------

### get_test_result example request

Source: https://endtest.io/docs/advanced/endtest-mcp

Example JSON request for get_test_result with hash and detail set to 'light'.

```json
{
  "hash": "Df4hiJHj5SD5wr9MK63OmeVHAODklEx0An",
  "detail": "light"
}
```

--------------------------------

### runWeb - Start a single test suite

Source: https://endtest.io/docs/integrations/argo

Starts one Endtest test suite by specifying the suite ID. Returns an execution hash.

```APIDOC
## [GET] https://app.endtest.io/api.php?action=runWeb

### Description
Starts a single Endtest test suite.

### Method
GET

### Endpoint
https://app.endtest.io/api.php?action=runWeb

### Parameters
#### Query Parameters
- **action** (string) - Required - Must be `runWeb`.
- **appId** (string) - Required - The application ID.
- **appCode** (string) - Required - The application code.
- **suite** (string) - Required - The ID of the test suite to run.
- **platform** (string) - Optional - The platform to run on (e.g., `windows`).
- **os** (string) - Optional - The operating system (e.g., `windows11`).
- **browser** (string) - Optional - The browser to use (e.g., `chrome`).
- **browserVersion** (string) - Optional - The browser version (e.g., `latest`).
- **resolution** (string) - Optional - The screen resolution (e.g., `1280x1024`).
- **geolocation** (string) - Optional - The geolocation (e.g., `sanfrancisco`).
- **cases** (string) - Optional - Which cases to run (e.g., `all`).
- **notes** (string) - Optional - Any notes.

### Request Example
https://app.endtest.io/api.php?action=runWeb&appId=APP_ID&appCode=APP_CODE&suite=SUITE_ID&platform=windows&os=windows11&browser=chrome&browserVersion=latest&resolution=1280x1024&geolocation=sanfrancisco&cases=all&notes=

### Response
#### Success Response (200)
- **hash** (string) - The execution hash for the started suite.

#### Response Example
HASH
```

--------------------------------

### list_web_tests response example

Source: https://endtest.io/docs/advanced/endtest-mcp

Example JSON response showing the structure of web test suites returned by the list_web_tests tool.

```json
{
  "tests": [
    {
      "id": 58127403916,
      "name": "Checkout Regression - Demo Store",
      "type": "web",
      "project": "All Projects",
      "labels": [
        "Regression"
      ]
    }
  ],
  "count": 1
}
```

--------------------------------

### GET runMobile (Start Multiple Mobile Test Executions)

Source: https://endtest.io/docs/advanced/how-to-use-the-endtest-api

Starts multiple mobile test executions by providing a label instead of a suite ID. The request must be made with an HTTP GET method.

```APIDOC
## GET runMobile

### Description
Starts multiple mobile test executions by providing a label instead of a suite ID. The request must be made with an HTTP GET method.

### Method
GET

### Endpoint
Not specified in the source.

### Parameters
#### Query Parameters
- **action** (string) - Required - The type of action (runMobile)
- **appId** (string) - Required - The App ID of the user
- **appCode** (string) - Required - The App Code of the user
- **label** (string) - Required - The label assigned to the test suites (case-sensitive, only one label per request)
- **platform** (string) - Required - The platform to run the test on
- **device** (string) - Required - The mobile device to run the test on
- **app** (string) - Required - The download link for the APK or IPA file
- **grid** (string) - Required - The mobile device grid provider
- **cases** (string) - Required - The test cases to be executed
- **notes** (string) - Optional - Notes that will appear in the execution

### Response
#### Success Response
- **execution hashes** (string) - The unique hashes for each test execution, separated by commas.

#### Response Example
Not provided in the source.

```

--------------------------------

### Example values for script execution

Source: https://endtest.io/docs/integrations/bamboo-server

Sample configuration values used to demonstrate how to call the test.sh script.

```text
App ID = 44233559

App Code = 22381137

Endtest API Request to start test execution = "https://app.endtest.io/api.php?action=runWeb&appId=44233559&appCode=22381137&suite=380667&platform=windows&os=windows10&browser=chrome&browserVersion=latest&resolution=1280x1024&geolocation=sanfrancisco&cases=all&notes="

Number of loops = 10
```

--------------------------------

### GET Start Mobile Test Execution

Source: https://endtest.io/docs/advanced/how-to-use-the-endtest-api

Starts a mobile test execution using the Endtest API. The request is a GET call with parameters including action, appId, appCode, suite, platform, device, app, grid, cases, and notes.

```APIDOC
## GET Start Mobile Test Execution

### Description
Starts a mobile test execution using the Endtest API. The request is a GET call with parameters including action, appId, appCode, suite, platform, device, app, grid, cases, and notes.

### Method
GET

### Endpoint
(Endpoint not explicitly provided in source)

### Parameters
#### Query Parameters
- **action** (string) - Required - The type of action (runMobile)
- **appId** (string) - Required - The App ID of the user
- **appCode** (string) - Required - The App Code of the user
- **suite** (string) - Required - The ID of the test suite
- **platform** (string) - Required - The platform to run the test on
- **device** (string) - Required - The mobile device to run the test on
- **app** (string) - Optional - The download link for the APK or IPA file
- **grid** (string) - Optional - The mobile device grid provider
- **cases** (string) - Optional - The test cases to be executed
- **notes** (string) - Optional - Notes that will appear in the execution

### Request Example
(No explicit example provided in source)

### Response
#### Success Response (200)
- **hash** (string) - A hash that uniquely identifies the test execution

#### Response Example
(No explicit example provided in source)
```

--------------------------------

### Complete Pipeline example with execution details

Source: https://endtest.io/docs/integrations/jenkins

An advanced example that configures timeout, polling, and build failure behavior, while iterating through and displaying individual execution results.

```groovy
pipeline {
    agent any

    stages {
        stage('Run Endtest') {
            steps {
                script {
                    def result = endtestRun(
                        credentialsId: 'endtest-api',
                        apiRequest: 'https://app.endtest.io/api.php?<YOUR_ENDTEST_API_PARAMETERS>',
                        timeoutMinutes: 45,
                        pollIntervalSeconds: 30,
                        failBuild: true,
                        resultsFormat: 'json-light'
                    )

                    echo "Endtest completed ${result.executionCount} execution(s)"
                    echo "Test cases: ${result.testCases}"
                    echo "Passed: ${result.passed}"
                    echo "Failed: ${result.failed}"
                    echo "Errors: ${result.errors}"

                    result.executions.eachWithIndex { execution, index ->
                        echo "Execution ${index + 1}"
                        echo "Test suite: ${execution.testSuiteName}"
                        echo "Configuration: ${execution.configuration}"
                        echo "Hash: ${execution.hash}"
                        echo "Results: ${execution.resultsUrl}"
                    }
                }
            }
        }
    }
}
```

--------------------------------

### Example script execution

Source: https://endtest.io/docs/advanced/how-to-use-the-endtest-api

An example command showing how to run the shell script with specific App ID, App Code, API request, and loop count values.

```sh
./test.sh 44233559 22381137 "https://app.endtest.io/api.php?action=runTestSuite&appId=44233559&appCode=22381137&testSuite=106877&selectedPlatform=windows&selectedOs=a&selectedBrowser=chrome&selectedResolution=d&selectedLocation=sanfrancisco&selectedCases=all&writtenAdditionalNotes=" 10
```

--------------------------------

### Example execution logs

Source: https://endtest.io/docs/integrations/argo

Sample output showing progress and results for multiple Endtest executions.

```text
Endtest executions are still running: 2 pending (1/20).
Endtest executions completed: 2.
Execution 1 of 2
Test Suite: Checkout
Failed: 0
Errors: 0

Execution 2 of 2
Test Suite: Login
Failed: 0
Errors: 0

Combined result
Executions: 2
Failed: 0
Errors: 0
Endtest release gate passed.
```

--------------------------------

### Endtest API request with deployment URL

Source: https://endtest.io/docs/integrations/netlify

Example of an API request using the placeholder to set the start URL for a web test execution.

```text
https://app.endtest.io/api.php?action=runWeb&suite=123456&startUrl={{NETLIFY_DEPLOY_URL}}
```

--------------------------------

### GET stopTest

Source: https://endtest.io/docs/advanced/how-to-use-the-endtest-api

Stops a test execution by providing the hash returned from starting the test execution. Requires appId, appCode, and hash parameters.

```APIDOC
## GET stopTest

### Description
Stops a test execution.

### Method
GET

### Endpoint
https://app.endtest.io/api.php

### Parameters
#### Query Parameters
- **action** (string) - Required - The type of action (stopTest)
- **appId** (string) - Required - The App ID of the user
- **appCode** (string) - Required - The App Code of the user
- **hash** (string) - Required - The hash returned by the API request for starting the test execution

### Request Example
https://app.endtest.io/api.php?action=stopTest&appId=[your app id]&appCode=[your app code]&hash=[the returned hash]

### Response
#### Success Response (200)
- **status** (string) - The status of the stop request

#### Response Example
{
  "status": "success"
}
```

--------------------------------

### GET https://app.endtest.io/api.php?action=getResults

Source: https://endtest.io/docs/advanced/how-to-use-the-endtest-api

Fetches the results of a test execution using the hash returned from the start execution request. Supports formats: html, json, or json-light.

```APIDOC
## GET https://app.endtest.io/api.php?action=getResults

### Description
Fetches the results of a test execution using the hash returned from the start execution request. Supports formats: html, json, or json-light.

### Method
GET

### Endpoint
https://app.endtest.io/api.php?action=getResults&appId=[your app id]&appCode=[your app code]&hash=[the returned hash]&format=[html or json or json-light]

### Parameters
#### Query Parameters
- **action** (string) - Required - The type of action (getResults)
- **appId** (string) - Required - The App ID of the user
- **appCode** (string) - Required - The App Code of the user
- **hash** (string) - Required - The unique hash for that test execution
- **format** (string) - Required - The format of the results (json, json-light or html)

### Request Example
GET https://app.endtest.io/api.php?action=getResults&appId=44233559&appCode=22381137&hash=abc123&format=json

### Response
#### Success Response (200)
- **results** (object) - The test execution results in the requested format

#### Response Example
{
  "status": "completed",
  "results": {}
}
```

--------------------------------

### Example command execution

Source: https://endtest.io/docs/integrations/bamboo-server

The final command using the provided sample values to trigger the test execution.

```sh
./test.sh 44233559 22381137 "https://app.endtest.io/api.php?action=runWeb&appId=44233559&appCode=22381137&suite=380667&platform=windows&os=windows10&browser=chrome&browserVersion=latest&resolution=1280x1024&geolocation=sanfrancisco&cases=all&notes=" 10
```

--------------------------------

### ChatGPT Example Requests

Source: https://endtest.io/docs/advanced/endtest-mcp

Sample natural language prompts to interact with Endtest tools after connecting to ChatGPT.

```text
List my Endtest web tests.
```

```text
Show me the test cases and steps from my Checkout Regression suite.
```

```text
How many parallel execution slots are available?
```

```text
Run my Checkout Regression test suite.
```

--------------------------------

### Stop a test execution via API

Source: https://endtest.io/docs/advanced/how-to-use-the-endtest-api

Use this HTTP GET request to stop a specific test execution. Replace the placeholders with your actual App ID, App Code, and the hash returned when the test was started.

```http
https://app.endtest.io/api.php?action=stopTest&appId=[your app id]&appCode=[your app code]&hash=[the returned hash]
```
Tokens:
Raw