Skip to main content
PATCH
Update a project

Authorizations

Authorization
string
header
required

API key authentication using Bearer token format. The CLI's ta auth access tokens are also accepted; because they name a user rather than a workspace, a user in several workspaces selects one with the x-testerarmy-team header (workspace id or slug).

Path Parameters

projectId
string
required

Project ID

Body

application/json
browserRegion
enum<string> | null

Default exit region for web runs. null uses the default, us (static IPs). us-dynamic exits from a US IP that usually changes between runs. Web projects only.

Available options:
us,
us-dynamic,
eu,
pl,
null
prTestingEnabled
boolean

Test PR deployments automatically.

prTestingInstructions
string | null

Free-form instructions for the PR exploration agent.

Maximum string length: 2000
agentInstructions
string | null

Free-form instructions injected into the QA agent's system prompt on every run of this project.

Maximum string length: 4000
prTestingDebounceMinutes
integer

Quiet period before a PR deployment is tested. 0 disables debouncing.

Required range: 0 <= x <= 60
prTestingBlockMerge
boolean

Conclude the GitHub check run as failed when tests fail, so a required TesterArmy check blocks the merge. Off by default.

includeExampleMobileApp
boolean

Offer the example app as a run target. Mobile projects only.

autoDeleteOldestMobileApp
boolean

Delete the oldest unused app builds when an upload exceeds the storage quota. Mobile projects only.

accessibilityAuditEnabled
boolean

Scan visited pages with axe-core during web runs and report critical accessibility violations as non-blocking warnings. On by default. Web projects only.

name
string
Required string length: 1 - 255
url
string
Required string length: 1 - 500
description
string | null
Maximum string length: 2000

Response

Project updated

project
object
required