Skip to main content
POST
Permission Required: project:edit-tests
Create a new test plan for your project. A test plan is an ordered list of test items that can be executed together with Start Test Plan Run.
Cross-platform deployment slots (slots, default_slot_name) are read-only via the API and cannot be supplied here or via Update Test Plan; manage them in the test plan editor. Unknown fields are rejected with a 400 error.

Request Body

test_plan
object
required
Test plan definition

Response

Returns the newly created test plan with status 201. The shape matches Get Test Plan.

Authorizations

X-Api-Key
string
header
required

API key for authentication

Path Parameters

projectId
string
required

The project ID. You can copy it from the project settings page or the project URL in the dashboard.

Body

application/json
test_plan
object
required

Response

Test plan created

id
string<uuid>

Unique identifier for the test plan

project_id
string<uuid>

Project the test plan belongs to

name
string

Test plan name

created_at
string<date-time> | null
created_by
string | null
modified_at
string<date-time> | null
modified_by
string | null
slots
object[]

Extra deployment slots of a cross-platform test plan (read-only via the API; managed in the test plan editor). Their indices key slot_deployment_configs when starting the plan; slot 1 is the implicit default slot.

default_slot_name
string | null

Optional display name of the implicit default slot (slot 1). Read-only via the API.

test_items
object[]

Ordered list of tests in this plan