List Review CI Runs

GET

reviews

{review_id}

ci-runs

List Review CI Runs

curl --request GET \
  --url https://public.api.serval.com/v2/reviews/{review_id}/ci-runs \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://public.api.serval.com/v2/reviews/{review_id}/ci-runs"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://public.api.serval.com/v2/reviews/{review_id}/ci-runs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://public.api.serval.com/v2/reviews/{review_id}/ci-runs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://public.api.serval.com/v2/reviews/{review_id}/ci-runs"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://public.api.serval.com/v2/reviews/{review_id}/ci-runs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "<string>",
      "revisionId": "<string>",
      "runNumber": 123,
      "requestedByUserId": "<string>",
      "startedAt": "2025-01-15T01:30:15.000Z",
      "checks": [
        {
          "id": "<string>",
          "name": "<string>",
          "status": "CI_CHECK_STATUS_UNSPECIFIED",
          "error": "<string>",
          "policyTeamId": "<string>",
          "workflowId": "<string>",
          "workflowRunId": "<string>",
          "simulationSuiteId": "<string>",
          "simulationSuiteRunId": "<string>",
          "enforcementDisabled": true,
          "minimumPassPercentage": 123,
          "passedEvaluationCount": 123,
          "totalEvaluationCount": 123
        }
      ],
      "status": "REVIEW_CI_ATTEMPT_STATUS_UNSPECIFIED",
      "sourceTeamId": "<string>",
      "targetTeamId": "<string>"
    }
  ],
  "nextPageToken": "<string>"
}

Authentication and permissions

Token requirements: User-based token (OAuth) or Organization-scoped API key or Workspace-scoped API key. Send a bearer access token for one of these identities. The permissions and resource restrictions below also apply.

Credential	Access requirements
Organization-scoped API key	API key: `reviews:read` User: session review, User: promotion, User: parent-to-branch pull: Unsupported
Workspace-scoped API key	API key: `reviews:read` User: session review, User: promotion, User: parent-to-branch pull: Unsupported
User-based token (OAuth)	API key: Unsupported User: session review, User: promotion, User: parent-to-branch pull: Supported, subject to permissions

Permissions joined by + are all required; or separates alternatives. Full-access keys still cannot call endpoints marked unsupported. Workspace keys must allow every workspace checked by the request. OAuth access depends on the user’s roles and resource access.

API key: The key must allow the session’s workspace, or either the source or target workspace of a promotion. The review’s target workspace must belong to your organization.
User: session review: Requires permission to view configuration sessions in the session’s workspace.
User: promotion: Requires review or apply permission on the target workspace, or both staging permission on the target workspace and author permission on the source workspace. Cross-organization access from the source workspace requires an active workspace link between organizations in the same Parent Organization.
User: parent-to-branch pull: For a recorded parent-to-branch pull, staging permission on the target branch and branch permission on the source parent also authorize access.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

review_id

string

required

Query Parameters

pageSize

integer<int32>

pageToken

string

Response

200 - application/json

Success

data

ReviewCIAttempt · object[]

Show child attributes

nextPageToken

string

List Review CI Runs

curl --request GET \
  --url https://public.api.serval.com/v2/reviews/{review_id}/ci-runs \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://public.api.serval.com/v2/reviews/{review_id}/ci-runs"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://public.api.serval.com/v2/reviews/{review_id}/ci-runs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://public.api.serval.com/v2/reviews/{review_id}/ci-runs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://public.api.serval.com/v2/reviews/{review_id}/ci-runs"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://public.api.serval.com/v2/reviews/{review_id}/ci-runs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "<string>",
      "revisionId": "<string>",
      "runNumber": 123,
      "requestedByUserId": "<string>",
      "startedAt": "2025-01-15T01:30:15.000Z",
      "checks": [
        {
          "id": "<string>",
          "name": "<string>",
          "status": "CI_CHECK_STATUS_UNSPECIFIED",
          "error": "<string>",
          "policyTeamId": "<string>",
          "workflowId": "<string>",
          "workflowRunId": "<string>",
          "simulationSuiteId": "<string>",
          "simulationSuiteRunId": "<string>",
          "enforcementDisabled": true,
          "minimumPassPercentage": 123,
          "passedEvaluationCount": 123,
          "totalEvaluationCount": 123
        }
      ],
      "status": "REVIEW_CI_ATTEMPT_STATUS_UNSPECIFIED",
      "sourceTeamId": "<string>",
      "targetTeamId": "<string>"
    }
  ],
  "nextPageToken": "<string>"
}

Get started

Authentication

Endpoints

Development

Authentication and permissions

Authorizations

Path Parameters

Query Parameters

Response

​Authentication and permissions

Authorizations

Path Parameters

Query Parameters

Response

Authentication and permissions