API Reference
Trust summary for a scoped release
GET
/
api
/
v1
/
volumes
/
@
{scope}
/
{name}
/
{version}
/
trust
/
summary
Trust summary for a scoped release
curl --request GET \
--url https://api.example.com/api/v1/volumes/@{scope}/{name}/{version}/trust/summaryimport requests
url = "https://api.example.com/api/v1/volumes/@{scope}/{name}/{version}/trust/summary"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/api/v1/volumes/@{scope}/{name}/{version}/trust/summary', 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/volumes/@{scope}/{name}/{version}/trust/summary",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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/volumes/@{scope}/{name}/{version}/trust/summary"
req, _ := http.NewRequest("GET", url, nil)
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/volumes/@{scope}/{name}/{version}/trust/summary")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/volumes/@{scope}/{name}/{version}/trust/summary")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"subject": {
"purl": "<string>",
"integrity": "<string>"
},
"artifacts": [
{
"category": "bom",
"formatsPresent": [
"<string>"
],
"present": true
}
],
"detailAvailable": true,
"revision": {
"revision": "<string>",
"updatedAt": "2023-11-07T05:31:56Z"
},
"judgments": {}
}Path Parameters
Maximum string length:
64Pattern:
^(?!.*--)[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$Maximum string length:
128Pattern:
^(?!.*--)[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$Pattern:
^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[A-Za-z-][0-9A-Za-z-]*)(?:\.(?:0|[1-9]\d*|\d*[A-Za-z-][0-9A-Za-z-]*))*))?(?:\+([0-9A-Za-z-]+(?:\.[0-9A-Za-z-]+)*))?$Response
Trust summary. If the release exists but no trust artifacts are present, returns 200 OK with an empty artifacts array. An empty success response does not by itself indicate successful verification, trusted status, or policy compliance.
Show child attributes
Show child attributes
May be empty when the release exists but no trust artifacts have been attached yet.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Optional derived judgments; not canonical trust facts.
⌘I
Trust summary for a scoped release
curl --request GET \
--url https://api.example.com/api/v1/volumes/@{scope}/{name}/{version}/trust/summaryimport requests
url = "https://api.example.com/api/v1/volumes/@{scope}/{name}/{version}/trust/summary"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/api/v1/volumes/@{scope}/{name}/{version}/trust/summary', 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/volumes/@{scope}/{name}/{version}/trust/summary",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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/volumes/@{scope}/{name}/{version}/trust/summary"
req, _ := http.NewRequest("GET", url, nil)
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/volumes/@{scope}/{name}/{version}/trust/summary")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/volumes/@{scope}/{name}/{version}/trust/summary")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"subject": {
"purl": "<string>",
"integrity": "<string>"
},
"artifacts": [
{
"category": "bom",
"formatsPresent": [
"<string>"
],
"present": true
}
],
"detailAvailable": true,
"revision": {
"revision": "<string>",
"updatedAt": "2023-11-07T05:31:56Z"
},
"judgments": {}
}