Create a new SBOM export job

POST /api/v1/deployments/{deploymentId}/sbom/export

Create a new SBOM export job

cURL

curl --request POST \
  --url https://api.example.com/api/v1/deployments/{deploymentId}/sbom/export \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "deploymentId": 123,
  "formatVersion": {
    "cyclonedxVersion": "SBOM_CYCLONE_DX_VERSION_V1_7",
    "format": "SBOM_FORMAT_CYCLONEDX"
  },
  "metadataComponentType": "SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_APPLICATION",
  "metadataSupplier": {
    "contact": {
      "email": "<string>",
      "name": "<string>",
      "phone": "<string>"
    },
    "name": "<string>",
    "url": "<string>"
  },
  "ref": "refs/pull/1234/merge",
  "repositoryId": 123,
  "sbomOutputFormat": "SBOM_OUTPUT_FORMAT_JSON"
}
'

import requests

url = "https://api.example.com/api/v1/deployments/{deploymentId}/sbom/export"

payload = {
    "deploymentId": 123,
    "formatVersion": {
        "cyclonedxVersion": "SBOM_CYCLONE_DX_VERSION_V1_7",
        "format": "SBOM_FORMAT_CYCLONEDX"
    },
    "metadataComponentType": "SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_APPLICATION",
    "metadataSupplier": {
        "contact": {
            "email": "<string>",
            "name": "<string>",
            "phone": "<string>"
        },
        "name": "<string>",
        "url": "<string>"
    },
    "ref": "refs/pull/1234/merge",
    "repositoryId": 123,
    "sbomOutputFormat": "SBOM_OUTPUT_FORMAT_JSON"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    deploymentId: 123,
    formatVersion: {
      cyclonedxVersion: 'SBOM_CYCLONE_DX_VERSION_V1_7',
      format: 'SBOM_FORMAT_CYCLONEDX'
    },
    metadataComponentType: 'SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_APPLICATION',
    metadataSupplier: {
      contact: {email: '<string>', name: '<string>', phone: '<string>'},
      name: '<string>',
      url: '<string>'
    },
    ref: 'refs/pull/1234/merge',
    repositoryId: 123,
    sbomOutputFormat: 'SBOM_OUTPUT_FORMAT_JSON'
  })
};

fetch('https://api.example.com/api/v1/deployments/{deploymentId}/sbom/export', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/v1/deployments/{deploymentId}/sbom/export",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'deploymentId' => 123,
    'formatVersion' => [
        'cyclonedxVersion' => 'SBOM_CYCLONE_DX_VERSION_V1_7',
        'format' => 'SBOM_FORMAT_CYCLONEDX'
    ],
    'metadataComponentType' => 'SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_APPLICATION',
    'metadataSupplier' => [
        'contact' => [
                'email' => '<string>',
                'name' => '<string>',
                'phone' => '<string>'
        ],
        'name' => '<string>',
        'url' => '<string>'
    ],
    'ref' => 'refs/pull/1234/merge',
    'repositoryId' => 123,
    'sbomOutputFormat' => 'SBOM_OUTPUT_FORMAT_JSON'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/v1/deployments/{deploymentId}/sbom/export"

	payload := strings.NewReader("{\n  \"deploymentId\": 123,\n  \"formatVersion\": {\n    \"cyclonedxVersion\": \"SBOM_CYCLONE_DX_VERSION_V1_7\",\n    \"format\": \"SBOM_FORMAT_CYCLONEDX\"\n  },\n  \"metadataComponentType\": \"SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_APPLICATION\",\n  \"metadataSupplier\": {\n    \"contact\": {\n      \"email\": \"<string>\",\n      \"name\": \"<string>\",\n      \"phone\": \"<string>\"\n    },\n    \"name\": \"<string>\",\n    \"url\": \"<string>\"\n  },\n  \"ref\": \"refs/pull/1234/merge\",\n  \"repositoryId\": 123,\n  \"sbomOutputFormat\": \"SBOM_OUTPUT_FORMAT_JSON\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/deployments/{deploymentId}/sbom/export")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"deploymentId\": 123,\n  \"formatVersion\": {\n    \"cyclonedxVersion\": \"SBOM_CYCLONE_DX_VERSION_V1_7\",\n    \"format\": \"SBOM_FORMAT_CYCLONEDX\"\n  },\n  \"metadataComponentType\": \"SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_APPLICATION\",\n  \"metadataSupplier\": {\n    \"contact\": {\n      \"email\": \"<string>\",\n      \"name\": \"<string>\",\n      \"phone\": \"<string>\"\n    },\n    \"name\": \"<string>\",\n    \"url\": \"<string>\"\n  },\n  \"ref\": \"refs/pull/1234/merge\",\n  \"repositoryId\": 123,\n  \"sbomOutputFormat\": \"SBOM_OUTPUT_FORMAT_JSON\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/deployments/{deploymentId}/sbom/export")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"deploymentId\": 123,\n  \"formatVersion\": {\n    \"cyclonedxVersion\": \"SBOM_CYCLONE_DX_VERSION_V1_7\",\n    \"format\": \"SBOM_FORMAT_CYCLONEDX\"\n  },\n  \"metadataComponentType\": \"SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_APPLICATION\",\n  \"metadataSupplier\": {\n    \"contact\": {\n      \"email\": \"<string>\",\n      \"name\": \"<string>\",\n      \"phone\": \"<string>\"\n    },\n    \"name\": \"<string>\",\n    \"url\": \"<string>\"\n  },\n  \"ref\": \"refs/pull/1234/merge\",\n  \"repositoryId\": 123,\n  \"sbomOutputFormat\": \"SBOM_OUTPUT_FORMAT_JSON\"\n}"

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

200

{
  "taskToken": "<string>"
}

Authorizations

Authorization · string · header · required

Get access to data with your API token. Example header:

Authorization: Bearer 2991e2fb4b540fe75b8f90677b0b892b6314e4961cb001fe6eb452eee248a628

The token can be provisioned from the Tokens section in your Settings, and requires explicitly enabling Web API access.

Path Parameters

deploymentId · string<int64> · required

Deployment ID (numeric). Example: 123. Can be found at /deployments, or in your Settings in the web UI.

Example:

123

Body

application/json

deploymentId · string<int64>

Deployment ID (numeric). Example: 123. Can be found at /deployments, or in your Settings in the web UI.

Example:

123

formatVersion · object

Show child attributes

metadataComponentType · enum<string> · default: SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_APPLICATION

Metadata component type for the SBOM export.

value	description
SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_APPLICATION
SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_FRAMEWORK
SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_LIBRARY
SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_CONTAINER
SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_PLATFORM
SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_OPERATING_SYSTEM
SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_DEVICE
SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_DEVICE_DRIVER
SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_FIRMWARE
SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_FILE
SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_MACHINE_LEARNING_MODEL
SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_DATA

Available options: SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_APPLICATION, SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_FRAMEWORK, SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_LIBRARY, SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_CONTAINER, SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_PLATFORM, SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_OPERATING_SYSTEM, SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_DEVICE, SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_DEVICE_DRIVER, SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_FIRMWARE, SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_FILE, SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_MACHINE_LEARNING_MODEL, SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_DATA

Example:

"SBOM_METADATA_COMPONENT_TYPE_CYCLONE_DX_V15_APPLICATION"

metadataSupplier · object

Show child attributes

ref · string

Branch to export SBOM for (Ex. ref=refs/pull/1234/merge).

Example:

"refs/pull/1234/merge"

repositoryId · string<int64>

Repository ID to export SBOM for.

Example:

123

sbomOutputFormat · enum<string>

SBOM output format for the SBOM export.

value	description
SBOM_OUTPUT_FORMAT_JSON

Available options: SBOM_OUTPUT_FORMAT_JSON, SBOM_OUTPUT_FORMAT_CYCLONEDX

Example:

"SBOM_OUTPUT_FORMAT_JSON"

Response

200 - application/json

OK

taskToken · string

Task token for the SBOM export job.