Post run

cURL

curl --request POST \
  --url https://api.qa.tech/v1/run \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "actor": "<string>",
  "branch": "<string>",
  "commitHash": "<string>",
  "commitMessage": "<string>",
  "repository": "<string>",
  "testPlanShortId": "<string>",
  "applications": [
    {
      "applicationShortId": "<string>",
      "environment": {
        "url": "<string>",
        "name": "<string>"
      },
      "devicePresetShortId": "<string>"
    }
  ],
  "notifications": [
    {
      "type": "slack",
      "channel": "<string>"
    }
  ]
}
'

import requests

url = "https://api.qa.tech/v1/run"

payload = {
    "actor": "<string>",
    "branch": "<string>",
    "commitHash": "<string>",
    "commitMessage": "<string>",
    "repository": "<string>",
    "testPlanShortId": "<string>",
    "applications": [
        {
            "applicationShortId": "<string>",
            "environment": {
                "url": "<string>",
                "name": "<string>"
            },
            "devicePresetShortId": "<string>"
        }
    ],
    "notifications": [
        {
            "type": "slack",
            "channel": "<string>"
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    actor: '<string>',
    branch: '<string>',
    commitHash: '<string>',
    commitMessage: '<string>',
    repository: '<string>',
    testPlanShortId: '<string>',
    applications: [
      {
        applicationShortId: '<string>',
        environment: {url: '<string>', name: '<string>'},
        devicePresetShortId: '<string>'
      }
    ],
    notifications: [{type: 'slack', channel: '<string>'}]
  })
};

fetch('https://api.qa.tech/v1/run', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.qa.tech/v1/run",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'actor' => '<string>',
    'branch' => '<string>',
    'commitHash' => '<string>',
    'commitMessage' => '<string>',
    'repository' => '<string>',
    'testPlanShortId' => '<string>',
    'applications' => [
        [
                'applicationShortId' => '<string>',
                'environment' => [
                                'url' => '<string>',
                                'name' => '<string>'
                ],
                'devicePresetShortId' => '<string>'
        ]
    ],
    'notifications' => [
        [
                'type' => 'slack',
                'channel' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.qa.tech/v1/run"

	payload := strings.NewReader("{\n  \"actor\": \"<string>\",\n  \"branch\": \"<string>\",\n  \"commitHash\": \"<string>\",\n  \"commitMessage\": \"<string>\",\n  \"repository\": \"<string>\",\n  \"testPlanShortId\": \"<string>\",\n  \"applications\": [\n    {\n      \"applicationShortId\": \"<string>\",\n      \"environment\": {\n        \"url\": \"<string>\",\n        \"name\": \"<string>\"\n      },\n      \"devicePresetShortId\": \"<string>\"\n    }\n  ],\n  \"notifications\": [\n    {\n      \"type\": \"slack\",\n      \"channel\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.qa.tech/v1/run")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"actor\": \"<string>\",\n  \"branch\": \"<string>\",\n  \"commitHash\": \"<string>\",\n  \"commitMessage\": \"<string>\",\n  \"repository\": \"<string>\",\n  \"testPlanShortId\": \"<string>\",\n  \"applications\": [\n    {\n      \"applicationShortId\": \"<string>\",\n      \"environment\": {\n        \"url\": \"<string>\",\n        \"name\": \"<string>\"\n      },\n      \"devicePresetShortId\": \"<string>\"\n    }\n  ],\n  \"notifications\": [\n    {\n      \"type\": \"slack\",\n      \"channel\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.qa.tech/v1/run")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"actor\": \"<string>\",\n  \"branch\": \"<string>\",\n  \"commitHash\": \"<string>\",\n  \"commitMessage\": \"<string>\",\n  \"repository\": \"<string>\",\n  \"testPlanShortId\": \"<string>\",\n  \"applications\": [\n    {\n      \"applicationShortId\": \"<string>\",\n      \"environment\": {\n        \"url\": \"<string>\",\n        \"name\": \"<string>\"\n      },\n      \"devicePresetShortId\": \"<string>\"\n    }\n  ],\n  \"notifications\": [\n    {\n      \"type\": \"slack\",\n      \"channel\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "run": {
    "id": "<string>",
    "shortId": "<string>",
    "url": "<string>",
    "testCount": 123,
    "testPlan": {
      "name": "<string>",
      "shortId": "<string>"
    }
  }
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

POST

run

cURL

curl --request POST \
  --url https://api.qa.tech/v1/run \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "actor": "<string>",
  "branch": "<string>",
  "commitHash": "<string>",
  "commitMessage": "<string>",
  "repository": "<string>",
  "testPlanShortId": "<string>",
  "applications": [
    {
      "applicationShortId": "<string>",
      "environment": {
        "url": "<string>",
        "name": "<string>"
      },
      "devicePresetShortId": "<string>"
    }
  ],
  "notifications": [
    {
      "type": "slack",
      "channel": "<string>"
    }
  ]
}
'

import requests

url = "https://api.qa.tech/v1/run"

payload = {
    "actor": "<string>",
    "branch": "<string>",
    "commitHash": "<string>",
    "commitMessage": "<string>",
    "repository": "<string>",
    "testPlanShortId": "<string>",
    "applications": [
        {
            "applicationShortId": "<string>",
            "environment": {
                "url": "<string>",
                "name": "<string>"
            },
            "devicePresetShortId": "<string>"
        }
    ],
    "notifications": [
        {
            "type": "slack",
            "channel": "<string>"
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    actor: '<string>',
    branch: '<string>',
    commitHash: '<string>',
    commitMessage: '<string>',
    repository: '<string>',
    testPlanShortId: '<string>',
    applications: [
      {
        applicationShortId: '<string>',
        environment: {url: '<string>', name: '<string>'},
        devicePresetShortId: '<string>'
      }
    ],
    notifications: [{type: 'slack', channel: '<string>'}]
  })
};

fetch('https://api.qa.tech/v1/run', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.qa.tech/v1/run",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'actor' => '<string>',
    'branch' => '<string>',
    'commitHash' => '<string>',
    'commitMessage' => '<string>',
    'repository' => '<string>',
    'testPlanShortId' => '<string>',
    'applications' => [
        [
                'applicationShortId' => '<string>',
                'environment' => [
                                'url' => '<string>',
                                'name' => '<string>'
                ],
                'devicePresetShortId' => '<string>'
        ]
    ],
    'notifications' => [
        [
                'type' => 'slack',
                'channel' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.qa.tech/v1/run"

	payload := strings.NewReader("{\n  \"actor\": \"<string>\",\n  \"branch\": \"<string>\",\n  \"commitHash\": \"<string>\",\n  \"commitMessage\": \"<string>\",\n  \"repository\": \"<string>\",\n  \"testPlanShortId\": \"<string>\",\n  \"applications\": [\n    {\n      \"applicationShortId\": \"<string>\",\n      \"environment\": {\n        \"url\": \"<string>\",\n        \"name\": \"<string>\"\n      },\n      \"devicePresetShortId\": \"<string>\"\n    }\n  ],\n  \"notifications\": [\n    {\n      \"type\": \"slack\",\n      \"channel\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.qa.tech/v1/run")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"actor\": \"<string>\",\n  \"branch\": \"<string>\",\n  \"commitHash\": \"<string>\",\n  \"commitMessage\": \"<string>\",\n  \"repository\": \"<string>\",\n  \"testPlanShortId\": \"<string>\",\n  \"applications\": [\n    {\n      \"applicationShortId\": \"<string>\",\n      \"environment\": {\n        \"url\": \"<string>\",\n        \"name\": \"<string>\"\n      },\n      \"devicePresetShortId\": \"<string>\"\n    }\n  ],\n  \"notifications\": [\n    {\n      \"type\": \"slack\",\n      \"channel\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.qa.tech/v1/run")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"actor\": \"<string>\",\n  \"branch\": \"<string>\",\n  \"commitHash\": \"<string>\",\n  \"commitMessage\": \"<string>\",\n  \"repository\": \"<string>\",\n  \"testPlanShortId\": \"<string>\",\n  \"applications\": [\n    {\n      \"applicationShortId\": \"<string>\",\n      \"environment\": {\n        \"url\": \"<string>\",\n        \"name\": \"<string>\"\n      },\n      \"devicePresetShortId\": \"<string>\"\n    }\n  ],\n  \"notifications\": [\n    {\n      \"type\": \"slack\",\n      \"channel\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "run": {
    "id": "<string>",
    "shortId": "<string>",
    "url": "<string>",
    "testCount": 123,
    "testPlan": {
      "name": "<string>",
      "shortId": "<string>"
    }
  }
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

Authorizations

Authorization

string

header

required

Project API token from Settings > Integrations > API. The token is scoped to a specific project.

Body

application/json

trigger

enum<string>

Available options:

API,

GITHUB

actor

string

branch

string

commitHash

string

commitMessage

string

repository

string

testPlanShortId

string

Pattern: ^pln(-.+_.+|_.+)$

applications

object[]

Show child attributes

notifications

object[]

Show child attributes

Response

The request has succeeded.

success

boolean

required

run

object

required

Show child attributes

API Reference

API Reference

Authorizations

Body

Response