# Test Observer API

**Canonical:** https://apis.io/apis/canonical/test-observer-api/  
**Provider:** Canonical — https://apis.io/providers/canonical/  
**Base URL:** https://test-observer-api.canonical.com  
**Documentation:** https://test-observer.canonical.com/

Test Observer API is one of 22 APIs that [Canonical](https://apis.io/providers/canonical/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Testing, Quality, and CI. The published artifact set on APIs.io includes an OpenAPI specification.

Test Observer is Canonical's dashboard for tracking test execution across Ubuntu artefacts — snaps, debs, charms and images — through their release stages. The backend publishes an OpenAPI 3.1.0 contract with 64 paths and 91 operations covering artefacts, builds, test executions, results, environments and reviews.

## Operations (60 of 91)

| Method | Path | Summary |
|---|---|---|
| GET | `/v1/version` | Get Version |
| PUT | `/v1/test-executions/end-test` | End Test Execution |
| GET | `/v1/test-executions/{id}/test-results` | Get Test Results |
| POST | `/v1/test-executions/{id}/test-results` | Post Results |
| POST | `/v1/test-executions/{id}/links` | Post Link |
| DELETE | `/v1/test-executions/{id}/links/{link_id}` | Delete Link |
| POST | `/v1/test-executions/reruns` | Create Rerun Requests |
| GET | `/v1/test-executions/reruns` | Get Rerun Requests |
| DELETE | `/v1/test-executions/reruns` | Delete Rerun Requests |
| GET | `/v1/test-executions/reruns/details` | Get Rerun Details |
| GET | `/v1/test-executions/{id}` | Get Test Execution |
| PATCH | `/v1/test-executions/{id}` | Patch Test Execution |
| GET | `/v1/test-executions` | Search Test Executions |
| PUT | `/v1/test-executions/start-test` | Start Test Execution |
| PUT | `/v1/test-executions/{id}/status_update` | Put Status Update |
| GET | `/v1/test-executions/{id}/status_update` | Get Status Update |
| POST | `/v1/test-executions/{id}/status_update` | Post Status Update |
| GET | `/v1/artefacts` | Get Artefacts |
| GET | `/v1/artefacts/search` | Search Artefacts |
| GET | `/v1/artefacts/history` | Get Artefact History |
| GET | `/v1/artefacts/{artefact_id}` | Get Artefact |
| PATCH | `/v1/artefacts/{artefact_id}` | Patch Artefact |
| GET | `/v1/artefacts/{artefact_id}/versions` | Get Artefact Versions |
| GET | `/v1/artefacts/{artefact_id}/environment-reviews` | Get Environment Reviews |
| PATCH | `/v1/artefacts/{artefact_id}/environment-reviews` | Bulk Update Environment Reviews |
| PATCH | `/v1/artefacts/{artefact_id}/environment-reviews/{review_id}` | Update Environment Review |
| GET | `/v1/artefacts/{artefact_id}/builds` | Get Artefact Builds |
| GET | `/v1/reports/test-results` | Get Testresults Report |
| GET | `/v1/reports/test-executions` | Get Test Execution Reports |
| GET | `/v1/test-cases/reported-issues` | Get Reported Issues |
| POST | `/v1/test-cases/reported-issues` | Create Reported Issue |
| PUT | `/v1/test-cases/reported-issues/{issue_id}` | Update Reported Issue |
| DELETE | `/v1/test-cases/reported-issues/{issue_id}` | Delete Reported Issue |
| GET | `/v1/test-cases` | Get Test Cases |
| GET | `/v1/environments/reported-issues` | Get Reported Issues |
| POST | `/v1/environments/reported-issues` | Create Reported Issue |
| PUT | `/v1/environments/reported-issues/{issue_id}` | Update Reported Issue |
| DELETE | `/v1/environments/reported-issues/{issue_id}` | Delete Reported Issue |
| GET | `/v1/environments` | Get Environments |
| GET | `/v1/test-plans` | Get Test Plans |
| POST | `/v1/issues/{issue_id}/attach` | Add Issue Attachments |
| POST | `/v1/issues/{issue_id}/detach` | Remove Issue Attachments |
| POST | `/v1/issues/{issue_id}/attachment-rules` | Post Attachment Rule |
| PATCH | `/v1/issues/{issue_id}/attachment-rules/{attachment_rule_id}` | Patch Attachment Rule |
| DELETE | `/v1/issues/{issue_id}/attachment-rules/{attachment_rule_id}` | Delete Attachment Rule |
| GET | `/v1/issues` | Get Issues |
| PUT | `/v1/issues` | Create Or Update Issue |
| GET | `/v1/issues/{issue_id}` | Get Issue |
| PATCH | `/v1/issues/{issue_id}` | Patch Issue |
| GET | `/v1/test-results` | Search Test Results |
| GET | `/v1/execution-metadata` | Get Execution Metadata |
| GET | `/v1/auth/saml/login` | Saml Login |
| GET | `/v1/auth/saml/logout` | Saml Logout |
| POST | `/v1/auth/saml/acs` | Saml Login Callback |
| GET | `/v1/auth/saml/sls` | Saml Logout Callback |
| POST | `/v1/auth/saml/sls` | Saml Logout Callback |
| GET | `/v1/users/me` | Get Authenticated User |
| GET | `/v1/users` | Get Users |
| GET | `/v1/users/{user_id}` | Get User |
| DELETE | `/v1/users/{user_id}` | Delete User |

…and 31 more operations. They are listed in full on the page.

## Machine-readable artifacts (3)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/canonical/refs/heads/main/openapi/canonical-test-observer-api-openapi.json
- **Overlay** — https://raw.githubusercontent.com/api-evangelist/canonical/refs/heads/main/overlays/canonical-test-observer-api-overlay.yaml
- **SourceCode** — https://github.com/canonical/test_observer

## Other Canonical APIs (12)

- [Snap Store API](https://apis.io/apis/canonical/snap-store-api/)
- [Charmhub API](https://apis.io/apis/canonical/charmhub-api/)
- [snapd REST API](https://apis.io/apis/canonical/snapd-rest-api/)
- [MAAS API](https://apis.io/apis/canonical/maas-api/)
- [Juju Client / Controller API](https://apis.io/apis/canonical/juju-api/)
- [Launchpad Web Services API](https://apis.io/apis/canonical/launchpad-api/)
- [Ubuntu Pro Client API](https://apis.io/apis/canonical/ubuntu-pro-api/)
- [Landscape API](https://apis.io/apis/canonical/landscape-api/)
- [Canonical Assertions API](https://apis.io/apis/canonical/canonical-assertions-api/)
- [Canonical Search API](https://apis.io/apis/canonical/canonical-search-api/)
- [Canonical Snaps API](https://apis.io/apis/canonical/canonical-snaps-api/)
- [LXD REST API](https://apis.io/apis/canonical/lxd-rest-api/)

## Tags

Testing, Quality, CI

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/canonical/test-observer-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/canonical/.