Introduction
API Reference
Schema
Using the REST API
Testmo's REST API is a typical HTTP-based API to access Testmo's data model and create/update objects. Before directly accessing the HTTP API from your scripts and integrations, please first review the different options below on how to consume and use the API. There are simpler ways than using the API directly for the most common use cases.
Testmo CLI
The Testmo CLI is the easiest option to use Testmo's API and implement test automation integrations, submit automated test results from your CI/CD pipeline and implement advanced workflows.
For example, it's very easy to submit your automated test results in JUnit XML format (supported by pretty much any test automation tool) from the command line or CI/CD workflow:
1
$ TESTMO_TOKEN=******** testmo automation:run:submit \\
2
--instance https://<your-name>.testmo.net \\
3
--project-id 1 \\
4
--name "New test run" \\
5
--source "backend-unit" \\
6
--results reports/*.xml
Copied!
The Testmo CLI also supports advanced workflows such as parallel testing, custom fields, submitting artifacts etc. The Testmo CLI tool can also directly launch your automation tool to measure test times, record exit statuses and capture the complete console output. Make sure to review its full documentation here:
JavaScript/NodeJS package
We also provide a ready-to-use JavaScript/NodeJS package to make it easier to consume and call the API from your custom scripts. The package is also used by the Testmo CLI tool, so it's always up-to-date. Here's a basic example on how to use the package:
1
var testmo = require('@testmo/testmo-api');
2
3
// Configure API client
4
const client = new testmo.ApiClient();
5
client.basePath = process.env.TESTMO_HOST;
6
client.authentications['bearerAuth'].accessToken = process.env.TESTMO_TOKEN;
7
8
// Request current user
9
const api = new testmo.UserApi(client);
10
const user = await api.get();
11
12
console.log(user);
Copied!
HTTP API methods
You can also directly access Testmo's API from your custom scripts or command line if you prefer. To make it easier to consume the API, we also publish its OpenAPI schema to generate additional client libraries for more programming languages. Accessing the API is easy and you can directly call the HTTP methods and passing the authentication token:
1
$ TESTMO_TOKEN=********
2
$ curl -H "Authorization: Bearer $TESTMO_TOKEN" \
3
https://<testmo-name>.testmo.net/api/v1/user
Copied!
You can learn more about authenticating against the API and generating API keys in Testmo's user interface.
Last modified 6mo ago
Copy link