Esportare lo SBOM di un asset

Esportazione dei dati dell’asset

Questo passaggio consente di esportare i dati di un asset esistente in Cyberwatch in formato CycloneDX o SPDX.

L’esportazione funziona solo con asset già esistenti in Cyberwatch.

Route API

Metodo: GET URL: https://<URL Cyberwatch>/api/v3/servers/{id}/export

Parametri di percorso

Nome	Tipo	Obbligatorio	Descrizione
id	string	sì	Identificativo dell’asset

Parametri di query

Nome	Tipo	Valori possibili	Descrizione
format	enum	`CycloneDX` \| `SPDX`	Formato di esportazione desiderato

Autenticazione: Basic (chiave di accesso / chiave segreta) Intestazione Accept: application/json; charset=utf-8

1. Esempi di richieste

a) cURL

curl -X GET "https://<Votre URL>/api/v3/servers/123/export?format=CycloneDX" \
     -u "access_key:secret_key" \
     -H "Accept: application/json; charset=utf-8" \
     --output export-asset-cyclonedx.json

b) PowerShell

# Configuration préalable
$API_URL     = "https://<Votre URL>"
$CREDENTIALS = "access_key:secret_key"
$encodedCreds = [Convert]::ToBase64String([Text.Encoding]::ASCII.GetBytes($CREDENTIALS))

# Paramètres dynamiques
$assetId = Read-Host -Prompt "ID de l'actif à exporter"
$format  = Read-Host -Prompt "Format d'export (CycloneDX ou SPDX)"

# Appel à l’API
$response = Invoke-RestMethod -Uri "$API_URL/api/v3/servers/$assetId/export?format=$format" `
                              -Method GET `
                              -Headers @{
                                "Accept"        = "application/json; charset=utf-8"
                                "Authorization" = "Basic $encodedCreds"
                              }

# Sauvegarde du résultat
$outputFile = "export-asset-$assetId.$($format.ToLower()).json"
$response | Out-File -FilePath $outputFile -Encoding utf8
Write-Output "Export enregistré dans $outputFile"

2. Risposta

Codice	Descrizione
200	Restituisce il contenuto CycloneDX o SPDX dell’asset

Il file restituito è in formato JSON (CycloneDX) o testo semplice (SPDX). In caso di assetId sconosciuto, l’API restituirà un 404. In caso di parametro format non valido, restituirà un 400.