Exportar l’SBOM d’un actiu

Exportació de les dades d’un actiu

Aquest pas permet exportar les dades d’un actiu existent a Cyberwatch en format CycloneDX o SPDX.

L’exportació només funciona amb actius que ja existeixen a Cyberwatch.

Ruta de l’API

Mètode: GET URL: https://Votre url/api/v3/servers/{id}/export

Paràmetres de camí

Nom	Tipus	Obligatori	Descripció
id	string	sí	Identificador de l’actiu

Paràmetres de consulta

Nom	Tipus	Valors possibles	Descripció
format	enum	`CycloneDX` \| `SPDX`	Format d’exportació desitjat

Autenticació: Basic (clau d’accés / clau secreta) Capçalera Accept: application/json; charset=utf-8

1. Exemples de sol·licituds

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. Resposta

Codi	Descripció
200	Retorna el contingut CycloneDX o SPDX de l’actiu

El fitxer retornat està en format JSON (CycloneDX) o text pla (SPDX). Si l’assetId és desconegut, l’API retornarà un 404. Si el paràmetre format no és vàlid, retornarà un 400.