PATCH
/
apiKey
/
v2
/
test-targets
/
{testTargetId}
curl --request PATCH \
  --url https://app.octomind.dev/api/apiKey/v2/test-targets/{testTargetId} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "app": "<string>",
  "discoveryUrl": "<string>",
  "skipAutomaticTestCreation": true,
  "testIdAttribute": "test-automation-id",
  "testRailIntegration": {
    "domain": "https://mycompany.testrail.io",
    "username": "user",
    "projectId": "123",
    "apiKey": "123123123"
  },
  "timeoutPerStep": 17500
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "app": "<string>",
  "tags": [
    "<string>"
  ],
  "environments": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "DEFAULT",
      "discoveryUrl": "https://example.com",
      "email": "[email protected]"
    }
  ],
  "skipAutomaticTestCreation": false
}

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
testTargetId
string
required

ID of the test target to update

Body

application/json
​
app
string | null

The app name or project name of the test target

​
discoveryUrl
string | null

The discovery URL of the test target

​
skipAutomaticTestCreation
boolean | null

Skip automatic test creation right after the test target is created

​
testIdAttribute
string | null

The attribute name of the test ID

Example:

"test-automation-id"

​
testRailIntegration
object | null
​
timeoutPerStep
number

The timeout per step in milliseconds

Required range: 5000 <= x <= 30000

Response

200
application/json
OK
​
id
string
​
app
string

The app name or project name of the test target

​
tags
(string | null)[]
​
environments
object[]

The environments of the test target

​
skipAutomaticTestCreation
boolean
default:false

Skip automatic test creation right after the test target is created