Update a project's configuration

patch/api/v1/projects/{project_id}

Request

  • Base URL: https://qa.replay.io
  • URL: https://qa.replay.io/api/v1/projects/{project_id}
  • Auth: HTTP bearer

Path parameters

project_idstring required

Request body

enabled_polish_passesstring[]

Which polish passes run against the project's test runs. Replaces the enabled set entirely, so include every pass you want enabled; pass [] to disable all. Unknown pass names are rejected with a 400.

add_polish_passesstring[]

Polish passes to enable, applied to the project's CURRENT set (or to enabled_polish_passes when that is sent too). Lets you turn one pass on without reading the current set first. Unknown pass names are rejected with a 400.

remove_polish_passesstring[]

Polish passes to disable, applied to the project's CURRENT set (or to enabled_polish_passes when that is sent too). Naming a pass in both add_polish_passes and remove_polish_passes is rejected with a 400. One of enabled_polish_passes, add_polish_passes, remove_polish_passes, security_ownership_exempt, github, status, target_url, or time_limit_minutes is required.

security_ownership_exemptboolean

Waive the security pass's ownership check for this project. Active security probing normally refuses to send any request until the target origin echoes a nonce placed at /.well-known/replay-qa-security-nonce, proving you control it; set this when the target is an app you deploy and that check is not workable. RESTRICTED: a request that sets this field from an account without the entitlement is rejected with a 403 (ask an admin to grant it). The waiver skips only the nonce fetch — a cloned/emulated target is still never probed, and only origins on the target site's own registrable domain are ever contacted.

target_urlstring

Replace the project default app URL for future QA runs. Must be a nonempty HTTP(S) URL. Environment and run overrides still take precedence.

time_limit_minutesinteger nullable

Wall-clock limit in minutes for each new test run, including queueing, retries and recording analysis. Omit or send null for no limit. Each run snapshots its deadline when created; changing this setting affects future runs only. When a deadline expires, the project is paused, all remaining project work is cancelled and eligible unfinished work is refunded. Finished results are preserved. Running containers are stopped by the next deadline sweep (every minute in production; previews use the five-minute reap sweep).

status'active' | 'paused'

Pause or resume all QA work for the project. Pausing prevents queued work from starting; resuming starts processing the existing queue again.

Response

Updated project

Changes

No recorded changes to this operation across all 1 revision of this API.