TestRail Projects API
Top-level containers owning suites, cases, runs, plans, and milestones.
TestRail Projects API is one of 11 APIs that TestRail publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Projects. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.
This API exposes 5 operations across 5 paths, and defines 1 schema. 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.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
TestRail Projects 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 5
Across 5 paths, the API surfaces 5 operations — 2 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.
Top-level containers owning suites, cases, runs, plans, and milestones.
Schemas 1
The contract defines 1 schema that model the data the API accepts and returns. The most detailed is Error (1 property). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from TestRail 10
Other APIs TestRail publishes across the network.