Run tests - clickproof

curl -X POST \
  -H "Authorization: Bearer $CLICKPROOF_API_KEY" \
  -H "Content-Type: application/json" \
  https://clickproof.app/api/v1/projects/YOUR_PROJECT_ID/runs

curl -X POST \
  -H "Authorization: Bearer $CLICKPROOF_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"testId":"YOUR_TEST_ID"}' \
  https://clickproof.app/api/v1/projects/YOUR_PROJECT_ID/runs

{
  "projectId": "7f3a9c21-4e8b-45d2-9a1c-2b6e0f8d1a44",
  "runIds": [
    "b1c2d3e4-1111-2222-3333-444455556666",
    "f7a8b9c0-7777-8888-9999-000011112222"
  ]
}

POST /api/v1/projects//runs

Run a project’s tests against its current build. Omit the body to run every test in the project (a suite); pass a testId to run just one. Returns the run ids to poll.

Upload a build first — this returns 400 no build uploaded if the project has none.

Request

string

required

The project id, in the URL path.

string

required

Bearer <your API key>.

string

Run a single test. Omit to run all tests in the project.

Response

string

The project the runs belong to.

string[]

Ids of the created runs — one per test. Poll each with Get a run.

curl -X POST \
  -H "Authorization: Bearer $CLICKPROOF_API_KEY" \
  -H "Content-Type: application/json" \
  https://clickproof.app/api/v1/projects/YOUR_PROJECT_ID/runs

curl -X POST \
  -H "Authorization: Bearer $CLICKPROOF_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"testId":"YOUR_TEST_ID"}' \
  https://clickproof.app/api/v1/projects/YOUR_PROJECT_ID/runs

{
  "projectId": "7f3a9c21-4e8b-45d2-9a1c-2b6e0f8d1a44",
  "runIds": [
    "b1c2d3e4-1111-2222-3333-444455556666",
    "f7a8b9c0-7777-8888-9999-000011112222"
  ]
}

Errors

Status	Body	When
`400`	`no build uploaded — POST the build first`	The project has no build.
`400`	`project has no tests to run`	No tests exist for the project.
`402`	quota message	The team’s run quota is exhausted. `runIds` lists any runs already started.
`404`	`project not found`	No such project for your team.

⌘I

​Request

​Response

​Errors

Request

Response

Errors