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

QA Wolf CI API

Continuous integration triggers and pipeline gating

QA Wolf CI API is one of 2 APIs that QA Wolf publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 5 operations across 4 paths, and defines 3 schemas. It is described by OpenAPI 3.1.0, at version v0.

Requests are made against a single base URL, https://app.qawolf.com.

5 operations 4 paths 3 schemas 2 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v0
Base URL
https://app.qawolf.com
Authentication
HTTP Bearer
Contact
Resource Areas
1

Authentication & Security 1

QA Wolf CI API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Bearer token using the workspace API key (QAWOLFAPIKEY). Find the key in the platform under Workspace Settings - Integrations - API Access.

Paths & Operations 5

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

CI 5

Continuous integration triggers and pipeline gating

POST
/api/webhooks/deploy_success
Notify QA Wolf of a successful deployment
notifyDeploySuccess body → 200401403405
POST
/api/webhooks/environment_terminated
Notify QA Wolf that an ephemeral environment has been terminated
notifyEnvironmentTerminated body → 200401403
GET
/api/v0/ci-greenlight/{rootRunId}
Poll for the outcome of a run to gate a pipeline
getCiGreenlight 1 param → 200401403
GET
/api/v0/run-inputs-executables-signed-urls
Generate a signed URL for an executable run input
getRunInputExecutableSignedUrl → 200401
PUT
/api/v0/run-inputs-executables-signed-urls
Upload an executable file via a signed URL
uploadRunInputExecutable → 200

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are DeploySuccessRequest (9 properties), EnvironmentTerminatedRequest (2 properties), DeploySuccessResponse (1 property). Each schema is shown below with its type and property counts.

DeploySuccessResponse
object
1 property
EnvironmentTerminatedRequest
object
2 properties
DeploySuccessRequest
object
Fields describing a successful deployment that should trigger runs.
9 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qa-wolf-ci-api-openapi.yml Raw ↑

Other APIs QA Wolf publishes across the network.

QA Wolf Webhooks API