# BugBug Suite runs API

**Canonical:** https://apis.io/apis/bugbug-io/bugbug-io-suite-runs-api/  
**Provider:** BugBug — https://apis.io/providers/bugbug-io/  
**Base URL:** https://api.bugbug.io  
**Documentation:** https://api.bugbug.io/docs/swagger/

BugBug Suite runs API is one of 18 APIs that [BugBug](https://apis.io/providers/bugbug-io/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. Tagged areas include Suite runs. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

Executing and getting result

## Operations (10)

| Method | Path | Summary |
|---|---|---|
| GET | `/v2/suiteruns/` | Retrieving suite run list |
| POST | `/v2/suiteruns/` | Execute desired suite |
| GET | `/v2/suiteruns/{id}/` | Retrieve suite run result |
| PATCH | `/v2/suiteruns/{id}/` | Update suite run |
| GET | `/v2/suiteruns/{id}/debug-artifacts/` | List suite run debug artifacts |
| GET | `/v2/suiteruns/{id}/report/junit/` | Download report |
| GET | `/v2/suiteruns/{id}/screenshots/` | Get suite run steps screenshots |
| GET | `/v2/suiteruns/{id}/status/` | Get suite run status |
| POST | `/v2/suiteruns/{id}/stop/` | Stop running suite run |
| PUT | `/v2/suiteruns/{id}/tags/` | Replace suite run tags |

## Machine-readable artifacts (7)

- **OpenAPI** — https://artifacts.apis.io/bugbug-io/openapi/bugbug-io-suite-runs-api-openapi.yml
- **JSONSchema** — https://artifacts.apis.io/bugbug-io/json-schema/bugbug-io-v2-project-settings-schema.json
- **JSONSchema** — https://artifacts.apis.io/bugbug-io/json-schema/bugbug-io-v2-test-run-schema.json
- **JSONSchema** — https://artifacts.apis.io/bugbug-io/json-schema/bugbug-io-v2-step-run-detail-schema.json
- **JSONSchema** — https://artifacts.apis.io/bugbug-io/json-schema/bugbug-io-patched-step-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/bugbug-io/json-schema/bugbug-io-step-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/bugbug-io/json-schema/bugbug-io-v2-suite-run-schema.json

## Other BugBug APIs (12)

- [BugBug Components API](https://apis.io/apis/bugbug-io/bugbug-io-components-api/)
- [BugBug Config API](https://apis.io/apis/bugbug-io/bugbug-io-config-api/)
- [BugBug Folders API](https://apis.io/apis/bugbug-io/bugbug-io-folders-api/)
- [BugBug Groups API](https://apis.io/apis/bugbug-io/bugbug-io-groups-api/)
- [BugBug Import / Export API](https://apis.io/apis/bugbug-io/bugbug-io-import-export-api/)
- [BugBug Organizations API](https://apis.io/apis/bugbug-io/bugbug-io-organizations-api/)
- [BugBug Profiles API](https://apis.io/apis/bugbug-io/bugbug-io-profiles-api/)
- [BugBug Projects API](https://apis.io/apis/bugbug-io/bugbug-io-projects-api/)
- [BugBug Settings API](https://apis.io/apis/bugbug-io/bugbug-io-settings-api/)
- [BugBug Step runs API](https://apis.io/apis/bugbug-io/bugbug-io-step-runs-api/)
- [BugBug Steps API](https://apis.io/apis/bugbug-io/bugbug-io-steps-api/)
- [BugBug Suites API](https://apis.io/apis/bugbug-io/bugbug-io-suites-api/)

## Tags

Suite runs

---

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