Update a project

PATCH

https://tester.army/api/v1/projects/:projectId

PATCH

/api/v1/projects/:projectId

$ curl -X PATCH https://tester.army/api/v1/projects/projectId \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{}'

1 {
2   "project": {
3     "id": "string",
4     "shortId": "string",
5     "name": "string",
6     "url": "string",
7     "projectType": "web",
8     "description": "string",
9     "environments": [
10       {
11         "id": "string",
12         "name": "string",
13         "slug": "string",
14         "kind": "production",
15         "url": "string"
16       }
17     ],
18     "browserRegion": "eu",
19     "prTestingEnabled": true,
20     "prTestingInstructions": "string",
21     "prTestingDebounceMinutes": 1,
22     "prTestingBlockMerge": true,
23     "includeExampleMobileApp": true,
24     "autoDeleteOldestMobileApp": true,
25     "accessibilityAuditEnabled": true,
26     "createdAt": "2024-01-15T09:30:00Z",
27     "updatedAt": "2024-01-15T09:30:00Z"
28   }
29 }

Update project name, URL, description, or settings.

Authentication

AuthorizationBearer

API key authentication using Bearer token format

Path parameters

projectIdstringRequired

Project ID

Request

This endpoint expects an object.

browserRegionenum or nullOptional

Default proxy exit region for web runs. null keeps the provider's default networking. Web projects only.

Allowed values:

prTestingEnabledbooleanOptional

Test PR deployments automatically.

prTestingInstructionsstring or nullOptional<=2000 characters

Free-form instructions for the PR exploration agent.

prTestingDebounceMinutesintegerOptional0-60

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

prTestingBlockMergebooleanOptional

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

includeExampleMobileAppbooleanOptional

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

autoDeleteOldestMobileAppbooleanOptional

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

accessibilityAuditEnabledbooleanOptional

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

namestringOptional1-255 characters

urlstringOptional1-500 characters

descriptionstring or nullOptional<=2000 characters

Response

Project updated

projectobject

Errors

400

Bad Request Error

401

Unauthorized Error

429

Too Many Requests Error

500

Internal Server Error

504

Gateway Timeout Error