Export des données d’actif

Cette étape permet d’exporter les données d’un actif existant dans Cyberwatch au format CycloneDX ou SPDX.

L’export ne fonctionne qu’avec des actifs déjà existants dans Cyberwatch.

Route API

Méthode : GET URL : https://Votre url/api/v3/servers/{id}/export

Paramètres de chemin

NomTypeObligatoireDescription
idstringouiIdentifiant de l’actif

Paramètres de requête

NomTypeValeurs possiblesDescription
formatenumCycloneDX | SPDXFormat d’export souhaité

Authentification : Basic (clé d’accès / clé secrète) En-tête Accept : application/json; charset=utf-8


1. Exemples de requêtes

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. Réponse

CodeDescription
200Renvoie le contenu CycloneDX ou SPDX de l’actif

Le fichier retourné est au format JSON (CycloneDX) ou plain text (SPDX). En cas d’assetId inconnu, l’API renverra un 404. En cas de paramètre format invalide, elle renverra un 400.


Retour en haut