How can I upload a CycloneDX Artifact through Build API? – Ketryx

Frequently Asked Questions

How can I upload a CycloneDX Artifact through Build API?

Logan Bolding

In order to upload a CycloneDx Artifact to the Ketryx Build API you will need to make two HTTP requests. In order to complete these HTTP requests, we recommend using an API Client like POSTMAN or Bruno.

The first request you will make contains the following information:

  1. Type: POST
  2. Endpoint Url format: https://[base_url].ketryx.net/api/v1/build-artifacts?project=&version=
  3. In your request, head to the ‘Auth’ tab and click on the authorization. Add ‘Bearer Token’ and your API access token in the field.
  4. Next head to the ‘Body’ and Select the CycloneDX file you wish to upload.

The second request you will make contains the following information:

  1. Type: POST

  2. Endpoint url format: https://[base_url].ketryx.net/api/v1/builds

  3. In your request, head to the ‘Auth’ tab and click on the authorization. Add ‘Bearer Token’ and your API access token in the field.

  4. Next head to the ‘Body’ and fill in the body with the following JSON format:

    {
   "project": "<PROJECTID>",
   "version": "<PROJECTVERSION>",
   "buildName": "<BUILDNAME>",
   "artifacts": [
       {
           "id": "<ARTIFACTID>",
           "type": "cyclonedx-json"
       }
   ]
}

Your CycloneDX artifact should now be populated within Ketryx.

Variable Information: