Checks if SBOM exists

KSOC SBOM plugin checks if SBOM should be calculated or this image digest is already known.

curl -X GET "https://api.prd.rad.security/sboms/example_string" \
  -H "Content-Type: application/json" \
  -H "Authorization: YOUR_API_KEY"

import requests
import json

url = "https://api.prd.rad.security/sboms/example_string"
headers = {
  "Content-Type": "application/json",
  "Authorization": "YOUR_API_KEY"
}

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

const response = await fetch("https://api.prd.rad.security/sboms/example_string", {
  method: "GET",
  headers: {
  "Content-Type": "application/json",
  "Authorization": "YOUR_API_KEY"
}
});

const data = await response.json();
console.log(data);

package main

import (
    "fmt"
    "net/http"
)

func main() {

    req, err := http.NewRequest("GET", "https://api.prd.rad.security/sboms/example_string", nil)
    if err != nil {
        panic(err)
    }

    req.Header.Set("Content-Type", "application/json")
    req.Header.Set("Authorization", "YOUR_API_KEY")

    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://api.prd.rad.security/sboms/example_string')
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'] = 'YOUR_API_KEY'

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

{
  "decision": "example_string",
  "sbom": {
    "created_at": "example_string",
    "deleted_at": "example_string",
    "digest": "example_string",
    "name": "John Doe",
    "s3_bucket": "example_string",
    "s3_key": "example_string",
    "s3_status": "example_string",
    "updated_at": "example_string"
  }
}

{
  "code": "example_string",
  "request_id": "example_string",
  "status": 42,
  "validation_details": [
    {
      "code": "example_string",
      "field": "example_string",
      "message": "example_string",
      "param": "example_string"
    }
  ]
}

GET

/sboms/{digest}

GET

Base URLstring

Target server for requests. Edit to use your own host.

API Key (header: Authorization)

Authorizationstring

Required

API key (sent in header)

path

digeststring

Required

Image digest to check

Request Preview

Response

Response will appear here after sending the request

Authentication

header

Authorizationstring

Required

API Key for authentication. Provide your API key in the header.

Path Parameters

digeststring

Required

Image digest to check

Responses

decisionstring

sbomobject

Was this page helpful?

{ "decision": "example_string", "sbom": { "created_at": "example_string", "deleted_at": "example_string", "digest": "example_string", "name": "John Doe", "s3_bucket": "example_string", "s3_key": "example_string", "s3_status": "example_string", "updated_at": "example_string" } }