Skip to main content
PATCH
Update test invocation

Headers

x-api-key
string | null

Your API key for programmatic access. Send it in the x-api-key header; you can create and manage keys from the Developers page.

Path Parameters

test_invocation_id
string
required

The id of a test invocation. This is returned when tests are run.

Body

application/json
name
string | null
required

New name for the test invocation. Set to null to restore the generated title.

Required string length: 1 - 256

Response

Successful Response

id
string
required
test_runs
UnitTestRunResponseModel · object[]
required
name
string | null

The user-provided name of the test invocation, if one was set.

agent_id
string | null
branch_id
string | null
version_id
string | null
ran_against_draft
boolean
default:false
created_at
integer
folder_id
string | null
repeat_count
integer
default:1
cancelled
boolean
default:false
bucketing_status
enum<string> | null

None when repeat_count==1 (no bucketing). Otherwise tracks bucketing lifecycle.

Available options:
pending,
completed,
failed
result_groups
TestRunResultSummary · object[]