Project API

API to manage projects, versions, and documents in Ketryx

Ketryx exposes an API to manage projects programmatically. There is also a formal OpenAPI specification defining this API, and a separate page about authentication and API keys.

Projects

Get a list of projects

Gets a list of Ketryx projects in the current organization.

GEThttps://app.ketryx.com/api/v1/projects

Authorization

bearerAuth

Query parameters

Response

200400401403404

OK

Body

application/json

projectsarray of object

Request

JavaScriptCurlPython

const response = await fetch('https://app.ketryx.com/api/v1/projects', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

200400401403404

{
  "projects": [
    {
      "id": "text",
      "name": "text"
    }
  ]
}

Create a new project

POSThttps://app.ketryx.com/api/v1/projects

Authorization

bearerAuth

Body

application/json

namestring

Name of the new project

Example: "My project"

repositoriesarray of object

Git repositories to connect to the new project

Response

200400401403404

OK

Body

application/json

idstring

ID of the created project

Request

JavaScriptCurlPython

const response = await fetch('https://app.ketryx.com/api/v1/projects', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400401403404

{
  "id": "text"
}

Project

Get the project settings

GEThttps://app.ketryx.com/api/v1/projects/[projectId]

Authorization

bearerAuth

Path parameters

projectIdstring

Response

200400401403404

OK

Body

application/json

idstring

namestring

repositoriesarray of object

Request

JavaScriptCurlPython

const response = await fetch('https://app.ketryx.com/api/v1/projects/[projectId]', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

200400401403404

{
  "id": "text",
  "name": "text",
  "repositories": [
    {
      "url": "text",
      "mainRef": "text",
      "releaseRef": "text",
      "hasAuth": false
    }
  ]
}

Change the project settings

POSThttps://app.ketryx.com/api/v1/projects/[projectId]

Authorization

bearerAuth

Body

application/json

repositoriesarray of object

Response

200400401403404

OK

Body

application/json

idstring

Request

JavaScriptCurlPython

const response = await fetch('https://app.ketryx.com/api/v1/projects/[projectId]', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400401403404

{
  "id": "text"
}

Delete a project

DELETEhttps://app.ketryx.com/api/v1/projects/[projectId]

Authorization

bearerAuth

Path parameters

projectIdstring

Response

204

Deletion successful, no content returned

Request

JavaScriptCurlPython

const response = await fetch('https://app.ketryx.com/api/v1/projects/[projectId]', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Versions

Get a list of versions

Gets a list of versions in the given project.

GEThttps://app.ketryx.com/api/v1/projects/[projectId]/versions

Authorization

bearerAuth

Path parameters

projectIdstring

Response

200400401403404

OK

Body

application/json

versionsarray of object

Request

JavaScriptCurlPython

const response = await fetch('https://app.ketryx.com/api/v1/projects/[projectId]/versions', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

200400401403404

{
  "versions": [
    {
      "id": "text",
      "name": "text"
    }
  ]
}

Create a new version

POSThttps://app.ketryx.com/api/v1/projects/[projectId]/versions

Authorization

bearerAuth

Body

application/json

namestring

Example: "My project"

Response

200400401403404

OK

Body

application/json

idstring

Request

JavaScriptCurlPython

const response = await fetch('https://app.ketryx.com/api/v1/projects/[projectId]/versions', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400401403404

{
  "id": "text"
}

Version

Delete a version

DELETEhttps://app.ketryx.com/api/v1/projects/[projectId]/versions/[versionId]

Authorization

bearerAuth

Path parameters

projectIdstring

versionIdstring

Response

204400401403404

Deletion successful, no content returned

Request

JavaScriptCurlPython

const response = await fetch('https://app.ketryx.com/api/v1/projects/[projectId]/versions/[versionId]', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

400401403404

{
  "error": "text"
}

Generated documents

Use this API to generate and download the SBOM document for a given project. Optionally, a certain version ID can be specified:

• If no versionId is specified, the document for the "current draft" state (corresponding to the main analyzed branch, not specific to a certain version) is downloaded.

• If a versionId is specified, the document is generated for the given version (and its corresponding release ref).

By default, the response is an Excel file in binary form (xslx). Optionally, a format parameter with value cyclonedx can be used to generate and download the SBOM document in CycloneDX JSON format (specifically, CyclonedX version 1.5).

Generate and retrieve the SBOM document

GEThttps://app.ketryx.com/api/v1/projects/[projectId]/generated-documents/sbom

Authorization

bearerAuth

Path parameters

projectIdstring

Query parameters

Request

JavaScriptCurlPython

const response = await fetch('https://app.ketryx.com/api/v1/projects/[projectId]/generated-documents/sbom', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();