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.

get

/projects

Authorizations

Query parameters

namestring

Project name to filter for

startAtinteger

Start listing projects at the given index. Defaults to 0.

maxResultsinteger

Maximum number of projects to return. Defaults to no limit.

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app.ketryx.com/api/v1/projects' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

401

403

404

200

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

OK

Create a new project

post

/projects

Authorizations

Body

namestringrequired

Name of the new project

Example: My project

repositoriesobject[]

Git repositories to connect to the new project

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://app.ketryx.com/api/v1/projects' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"name":"My project","repositories":[{}]}'

200

400

401

403

404

200

{
  "id": "text"
}

OK

Project

Get the project settings

get

/projects/{projectId}

Authorizations

Path parameters

projectIdstringrequired

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app.ketryx.com/api/v1/projects/{projectId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

401

403

404

200

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

OK

Change the project settings

post

/projects/{projectId}

Authorizations

Body

settingsobject

Object with advanced setting names as keys and a JSON value for each setting

Example: { "statusMapping": { "Backlog": "OPEN", "Done": "RESOLVED" } }

repositoriesobject[]

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://app.ketryx.com/api/v1/projects/{projectId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"settings":"{ \"statusMapping\": { \"Backlog\": \"OPEN\", \"Done\": \"RESOLVED\" } }","repositories":[{}]}'

200

400

401

403

404

200

{
  "id": "text"
}

OK

Delete a project

delete

/projects/{projectId}

Authorizations

Path parameters

projectIdstringrequired

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://app.ketryx.com/api/v1/projects/{projectId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

204

400

401

403

404

204

No body

Deletion successful, no content returned

Versions

Get a list of versions

Gets a list of versions in the given project.

get

/projects/{projectId}/versions

Authorizations

Path parameters

projectIdstringrequired

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app.ketryx.com/api/v1/projects/{projectId}/versions' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

401

403

404

200

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

OK

Create a new version

post

/projects/{projectId}/versions

Authorizations

Body

namestring

Example: My project

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://app.ketryx.com/api/v1/projects/{projectId}/versions' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"name":"My project"}'

200

400

401

403

404

200

{
  "id": "text"
}

OK

Version

Change the version settings

post

/projects/{projectId}/versions/{versionId}

Authorizations

Body

namestring

referencedVersionsobject[]

repositorySettingsobject[]

Version-specific repository settings to update

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://app.ketryx.com/api/v1/projects/{projectId}/versions/{versionId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"referencedVersions":[{"project":{"id":"KXPRJ49GQYFQ5RR9KRTPWTRTC39YZ9W"},"version":{"id":"KXPRJ49GQYFQ5RR9KRTPWTRTC39YZ9W"}}],"repositorySettings":[{"releaseRefPattern":"refs/tags/version-1.0"}]}'

Delete a version

delete

/projects/{projectId}/versions/{versionId}

Authorizations

Path parameters

projectIdstring

versionIdstring

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://app.ketryx.com/api/v1/projects/{projectId}/versions/{versionId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

204

400

401

403

404

204

No body

Deletion successful, no content returned

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

get

/projects/{projectId}/generated-documents/sbom

Authorizations

Path parameters

projectIdstring

Query parameters

versionIdstring

Ketryx version ID. If not specified, defaults to using the "current draft" state.

formatstring · enum

SBOM format to return. Defaults to "xslx".

Example: cyclonedx

Options: xslx, cyclonedx

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app.ketryx.com/api/v1/projects/{projectId}/generated-documents/sbom' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'