List requirement verdicts
curl --request GET \
--url https://api.example.com/api/v1/sites/{site_id}/operations/requirement-verdicts/ \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/api/v1/sites/{site_id}/operations/requirement-verdicts/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/api/v1/sites/{site_id}/operations/requirement-verdicts/', 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://api.example.com/api/v1/sites/{site_id}/operations/requirement-verdicts/",
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://api.example.com/api/v1/sites/{site_id}/operations/requirement-verdicts/"
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))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/v1/sites/{site_id}/operations/requirement-verdicts/")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/sites/{site_id}/operations/requirement-verdicts/")
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{
"count": 123,
"results": [
{
"target_id": "<string>",
"target_label": "<string>",
"parent_id": "<string>",
"parent_label": "<string>",
"resource_class_counts": {},
"rack_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"device_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"pod_ids": [
"<string>"
],
"summary": {
"verdict": "pass",
"passed_requirements": 1,
"total_requirements": 1,
"evaluated_at": "2023-11-07T05:31:56Z",
"requirements": {}
}
}
],
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2"
}{
"detail": "<string>",
"code": "error",
"field_errors": [
{
"field": "<string>",
"messages": [
"<string>"
]
}
]
}{
"detail": "<string>",
"code": "error",
"field_errors": [
{
"field": "<string>",
"messages": [
"<string>"
]
}
]
}{
"detail": "<string>",
"code": "error",
"field_errors": [
{
"field": "<string>",
"messages": [
"<string>"
]
}
]
}{
"detail": "<string>",
"code": "error",
"field_errors": [
{
"field": "<string>",
"messages": [
"<string>"
]
}
]
}Operations
List requirement verdicts
Lifecycle-agnostic requirement verdict rows for device, rack, or pod targets.
GET
/
api
/
v1
/
sites
/
{site_id}
/
operations
/
requirement-verdicts
/
List requirement verdicts
curl --request GET \
--url https://api.example.com/api/v1/sites/{site_id}/operations/requirement-verdicts/ \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/api/v1/sites/{site_id}/operations/requirement-verdicts/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/api/v1/sites/{site_id}/operations/requirement-verdicts/', 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://api.example.com/api/v1/sites/{site_id}/operations/requirement-verdicts/",
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://api.example.com/api/v1/sites/{site_id}/operations/requirement-verdicts/"
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))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/v1/sites/{site_id}/operations/requirement-verdicts/")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/sites/{site_id}/operations/requirement-verdicts/")
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{
"count": 123,
"results": [
{
"target_id": "<string>",
"target_label": "<string>",
"parent_id": "<string>",
"parent_label": "<string>",
"resource_class_counts": {},
"rack_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"device_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"pod_ids": [
"<string>"
],
"summary": {
"verdict": "pass",
"passed_requirements": 1,
"total_requirements": 1,
"evaluated_at": "2023-11-07T05:31:56Z",
"requirements": {}
}
}
],
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2"
}{
"detail": "<string>",
"code": "error",
"field_errors": [
{
"field": "<string>",
"messages": [
"<string>"
]
}
]
}{
"detail": "<string>",
"code": "error",
"field_errors": [
{
"field": "<string>",
"messages": [
"<string>"
]
}
]
}{
"detail": "<string>",
"code": "error",
"field_errors": [
{
"field": "<string>",
"messages": [
"<string>"
]
}
]
}{
"detail": "<string>",
"code": "error",
"field_errors": [
{
"field": "<string>",
"messages": [
"<string>"
]
}
]
}Authorizations
oauth2cookieAuth
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
Site identifier.
Query Parameters
Filter by related device UUID.
Number of results to return per page.
Required range:
1 <= x <= 500A page number within the paginated result set.
Filter by related pod target identifier.
Filter by related rack UUID.
Inventory target kind. Each kind maps to one acceptance gate.
Available options:
device, rack, pod Optional. Keep only targets whose headline gate verdict is one of these; repeat the param to include more than one. This is the row's rolled-up summary.verdict, not any individual requirement's.
pass- PASSmissing-evidence- MISSING_EVIDENCEstale-evidence- STALE_EVIDENCEtopology-incomplete- TOPOLOGY_INCOMPLETEexecution-error- EXECUTION_ERRORthreshold-failure- THRESHOLD_FAILUREpending- PENDING
Available options:
pass, missing-evidence, stale-evidence, topology-incomplete, execution-error, threshold-failure, pending