Skip to content
TriedDocs
Testing

Delete test case definition

Delete a test case definition.

DELETEhttps://api.tried.com.au/delete-test-case-definition/{id}

Deletes a test case definition. Finished test runs keep their results and test_case_name. A run of this test case that has not started yet ends with status error and the message The test case was deleted before it ran.

Request#

Field Type Required Description
id string Yes Path parameter. The test_case_definition_id.

Example request#

curl -X DELETE https://api.tried.com.au/delete-test-case-definition/test_case_8f7e6d5c4b3a29180f1e2d3c \
  -H "Authorization: Bearer $TRIED_API_KEY"
const id = "test_case_8f7e6d5c4b3a29180f1e2d3c";
await fetch(`https://api.tried.com.au/delete-test-case-definition/${id}`, {
  method: "DELETE",
  headers: { Authorization: `Bearer ${process.env.TRIED_API_KEY}` },
});
import os, requests

test_case_id = "test_case_8f7e6d5c4b3a29180f1e2d3c"
requests.delete(
    f"https://api.tried.com.au/delete-test-case-definition/{test_case_id}",
    headers={"Authorization": f"Bearer {os.environ['TRIED_API_KEY']}"},
)

Response#

204 No Content with an empty body.

Errors#

Status When
401 Missing or invalid API key.
403 The key's IP allowlist or scopes reject the request, or the caller has the read-only member role. This route needs the agents scope.
404 Test case <id> not found.
429 Rate limit exceeded. See Rate limits.

See Errors for the body format.