Exportación de datos de activo

Esta etapa permite exportar los datos de un activo existente en Cyberwatch en formato CycloneDX o SPDX.

La exportación solo funciona con activos ya existentes en Cyberwatch.

Ruta de la API

Método : GET URL : https://Su url/api/v3/servers/{id}/export

Parámetros de ruta

NombreTipoObligatorioDescripción
idstringsiIdentificador del activo

Parámetros de consulta

NombreTipoValores posiblesDescripción
formatenumCycloneDX | SPDXFormato de exportación deseado

Autenticación : Basic (clave de acceso / clave secreta) Encabezado Accept : application/json; charset=utf-8


1. Ejemplos de solicitudes

a) cURL

curl -X GET "https://<Su 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 prealable
$API_URL     = "https://<Su URL>"
$CREDENTIALS = "access_key:secret_key"
$encodedCreds = [Convert]::ToBase64String([Text.Encoding]::ASCII.GetBytes($CREDENTIALS))

# Parametros dinamicos
$assetId = Read-Host -Prompt "ID del activo a exportar"
$format  = Read-Host -Prompt "Formato de exportacion (CycloneDX o SPDX)"

# Llamada a la 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"
                              }

# Guardado del resultado
$outputFile = "export-asset-$assetId.$($format.ToLower()).json"
$response | Out-File -FilePath $outputFile -Encoding utf8
Write-Output "Export guardado en $outputFile"

2. Respuesta

CódigoDescripción
200Devuelve el contenido CycloneDX o SPDX del activo

El archivo devuelto esta en formato JSON (CycloneDX) o texto plano (SPDX). En caso de assetId desconocido, la API devolverá un 404. En caso de parámetro format invalido, devolverá un 400.


Volver arriba

English Français Español