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 Configurations API

Configuration groups (e.g. browsers, OSes) plan entries expand across.

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

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

This API exposes 3 operations across 3 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.

3 operations 3 paths 0 schemas 1 GET2 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 Configurations 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 3

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

Configurations 3

Configuration groups (e.g. browsers, OSes) plan entries expand across.

GET
/get_configs/{project_id}
Get configurations
getConfigs 1 param → 200
POST
/add_config_group/{project_id}
Add configuration group
addConfigGroup 1 param body → 200
POST
/add_config/{config_group_id}
Add configuration
addConfig 1 param body → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

testrail-configurations-api-openapi.yml Raw ↑

Other APIs TestRail publishes across the network.

TestRail Cases 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