Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

TestRail Cases API

Reusable test cases in the repository.

TestRail Cases API is one of 11 APIs that TestRail publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Cases. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 7 operations across 7 paths. It is described by OpenAPI 3.0.3, at version 2.0.

Requests are made against 2 base URLs: https://{instance}.testrail.io/index.php?/api/v2, https://{host}/index.php?/api/v2.

7 operations 7 paths 0 schemas 4 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2.0
Base URL
https://{instance}.testrail.io/index.php?/api/v2
Authentication
HTTP Basic
Resource Areas
1

Authentication & Security 1

TestRail Cases API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • basicAuth — HTTP Basic authentication. Username is your TestRail email; password is your account password or an API key generated under My Settings. The API must be enable…

Paths & Operations 7

Across 7 paths, the API surfaces 7 operations — 4 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Cases 7

Reusable test cases in the repository.

GET
/get_cases/{project_id}
Get cases
getCases 5 params → 200
GET
/get_case/{case_id}
Get case
getCase 1 param → 200
POST
/add_case/{section_id}
Add case
addCase 1 param body → 200
POST
/update_case/{case_id}
Update case
updateCase 1 param body → 200
POST
/delete_case/{case_id}
Delete case
deleteCase 1 param → 200
GET
/get_case_fields
Get case fields
getCaseFields → 200
GET
/get_case_types
Get case types
getCaseTypes → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

testrail-cases-api-openapi.yml Raw ↑

Other APIs TestRail publishes across the network.

TestRail Configurations API
TestRail Milestones API
TestRail Plans API
TestRail Projects API
TestRail Results API
TestRail Runs API
TestRail Sections API
TestRail Suites API
TestRail Tests API
TestRail Users API