Get run status
Read the current state and available case results for a run in the CI token's project.
curl -X GET "https://app.aegisrunner.com/api/v1/ci/runs/123e4567-e89b-12d3-a456-426614174000" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN"
import requests
import json
url = "https://app.aegisrunner.com/api/v1/ci/runs/123e4567-e89b-12d3-a456-426614174000"
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())
const response = await fetch("https://app.aegisrunner.com/api/v1/ci/runs/123e4567-e89b-12d3-a456-426614174000", {
method: "GET",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
}
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
)
func main() {
req, err := http.NewRequest("GET", "https://app.aegisrunner.com/api/v1/ci/runs/123e4567-e89b-12d3-a456-426614174000", nil)
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('https://app.aegisrunner.com/api/v1/ci/runs/123e4567-e89b-12d3-a456-426614174000')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'
response = http.request(request)
puts response.body
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"status": "example_string",
"isFinished": true,
"exitCode": 42,
"totalCases": 42,
"passedCases": 42,
"failedCases": 42,
"skippedCases": 42,
"duration_ms": 42,
"createdAt": "2024-12-25T10:00:00Z",
"completed_at": "2024-12-25T10:00:00Z",
"cases": [
{
"name": "John Doe",
"suiteName": "John Doe",
"status": "example_string",
"durationMs": 42,
"errorMessage": "example_string",
"failureType": "example_string"
}
]
}
{
"error": "Unauthorized",
"message": "Authentication required. Please provide a valid API token",
"code": 401
}
{
"error": "Not Found",
"message": "The requested resource was not found",
"code": 404
}
/ci/runs/{runId}Target server for requests. Edit to use your own host.
Create a project token under Project setup → CI/CD.
Request Preview
Response
Response will appear here after sending the request
Authentication
Bearer token. Create a project token under Project setup → CI/CD.
Path Parameters
Responses
Terminal values include completed, failed, cancelled, and needs_review.
Returns 1 for failed and 0 otherwise. Also inspect failedCases and handle cancelled.
01Per-case details when the run is terminal and results are available.
Read the current state and available case results for a run in the CI token's project. Continue polling until isFinished is true, then inspect status and failedCases.
See API authentication for tokens and API errors for completion and failure handling.