Add a reference to another project

Adds a cross-project reference from this project (the referencing project, e.g. a product) to another project in the organization (the referenced project, e.g. a service it uses), the same way "Add referenced project" on the References page does. By default the referencing project can link to the referenced items but does not incorporate them. Safe to repeat: if the reference already exists, nothing is changed and the response has status already_exists with the current settings.

post/projects/{projectId}/references

Request

Base URL
https://app.ketryx.com/api/v1
Auth
HTTP bearer
TypeScript
https://skmtc.dev/ketryx/apis/ketryx-api/docs/projects/:projectId/references/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

projectIdstring required

Ketryx ID of the referencing project, e.g. the product that uses a service

Request body

referencedProjectIdstring required

Ketryx ID of the referenced project, e.g. the service or library the referencing project uses

incorporateItemsboolean

Whether all items of the referenced project are also shown in the referencing project (incorporated items filter "*"). Defaults to false: reference only (filter "none").

incorporateDependenciesAndVulnerabilitiesboolean

Whether the referenced project's dependencies and vulnerabilities are included in the referencing project. Defaults to false.

rationalestring

Reason recorded in the audit log

Response

Successful response

status'created' | 'already_exists' required

already_exists: the reference was there before this call and was left unchanged

Changes

No recorded changes to this operation across all 1 revision of this API.