Actions

Manage test actions (rules) that automatically modify test behavior.

Actions allow you to:

  • Skip tests that match certain conditions

  • Quarantine flaky tests so their failures don't fail the run

  • Tag tests with custom labels for organization

Each action has a matcher that defines which tests it applies to, based on conditions like test title, file path, tags, git branch, etc.

List actions

get
/actions

Get all actions for a project with optional filtering

Authorizations
AuthorizationstringRequired

API key authentication using Bearer token

Query parameters
projectIdstringRequired

The project ID

Example: proj_abc123
searchstring · max: 100Optional

Search actions by name

Example: flaky test
Responses
200

Successful response

application/json
get
/actions

Create action

post
/actions

Create a new action for a project

Authorizations
AuthorizationstringRequired

API key authentication using Bearer token

Query parameters
projectIdstringRequired

The project ID

Example: proj_abc123
Body
namestring · min: 1 · max: 255Required
descriptionstring | nullableOptional
expiresAfterstring · date-time | nullableOptional
Responses
post
/actions

Get action

get
/actions/{actionId}

Get a single action by ID. The actionId is globally unique, so projectId is not required.

Authorizations
AuthorizationstringRequired

API key authentication using Bearer token

Path parameters
actionIdstringRequired

The action ID

Example: 507f1f77bcf86cd799439011
Responses
200

Successful response

application/json
get
/actions/{actionId}

Update action

put
/actions/{actionId}

Update an existing action. The actionId is globally unique, so projectId is not required.

Authorizations
AuthorizationstringRequired

API key authentication using Bearer token

Path parameters
actionIdstringRequired

The action ID

Example: 507f1f77bcf86cd799439011
Body
namestring · min: 1 · max: 255Optional
descriptionstring | nullableOptional
expiresAfterstring · date-time | nullableOptional
Responses
200

Action updated successfully

application/json
put
/actions/{actionId}

Delete action

delete
/actions/{actionId}

Archive an action (soft delete). The actionId is globally unique, so projectId is not required.

Authorizations
AuthorizationstringRequired

API key authentication using Bearer token

Path parameters
actionIdstringRequired

The action ID

Example: 507f1f77bcf86cd799439011
Responses
200

Action archived successfully

application/json
delete
/actions/{actionId}

Enable action

put
/actions/{actionId}/enable

Enable a disabled action. The actionId is globally unique, so projectId is not required.

Authorizations
AuthorizationstringRequired

API key authentication using Bearer token

Path parameters
actionIdstringRequired

The action ID

Example: 507f1f77bcf86cd799439011
Responses
200

Action enabled successfully

application/json
put
/actions/{actionId}/enable

Disable action

put
/actions/{actionId}/disable

Disable an active action. The actionId is globally unique, so projectId is not required.

Authorizations
AuthorizationstringRequired

API key authentication using Bearer token

Path parameters
actionIdstringRequired

The action ID

Example: 507f1f77bcf86cd799439011
Responses
200

Action disabled successfully

application/json
put
/actions/{actionId}/disable

Last updated

Was this helpful?