Code_roots

Get Code Root Finding

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
finding_idintegerRequired
Responses
200

Successful Response

application/json
get
/api/code_roots/findings/{finding_id}

Get Code Root Finding Summary

get

Get a summary of a code root finding.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
finding_idintegerRequired
Responses
200

Successful Response

application/json
get
/api/code_roots/findings/{finding_id}/summary

Get Code Root

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idintegerRequired
Responses
200

Successful Response

application/json
get
/api/code_roots/{id}

Get Code Root Sbom

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idintegerRequired
Responses
200

Successful Response

application/json
Responseany
get
/api/code_roots/{id}/sbom

No content

Get Code Root Terms

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
categorystringOptionalDefault: code_roots
code_root_idany ofOptional
integerOptional
or
nullOptional
Responses
200

Successful Response

application/json
get
/api/code_roots/_terms

Get Code Root License Terms

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
code_root_idintegerRequired
Query parameters
categorystringOptionalDefault: code_roots
Responses
200

Successful Response

application/json
get
/api/code_roots/{code_root_id}/license/_terms

Get Code Root Dependencies Terms

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
code_root_idintegerRequired
Responses
200

Successful Response

application/json
get
/api/code_roots/{code_root_id}/dependencies/_terms

Get Code Root Dependencies

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idintegerRequired
Query parameters
pageintegerOptionalDefault: 0
limitinteger · min: 1OptionalDefault: 100
orderany ofOptional
stringOptional
or
nullOptional
ordersany ofOptional
string[]Optional
or
nullOptional
directionany ofOptional
stringOptional
or
nullOptional
searchany ofOptional
stringOptional
or
nullOptional
Bodyany of[]
or
or
Responses
200

Successful Response

application/json
post
/api/code_roots/{id}/dependencies

Get Sca Json

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
code_root_idintegerRequired
Responses
200

Successful Response

application/json
get
/api/code_roots/{code_root_id}/sca

Get Code Root Dependency Graph

get

Get the dependency graph for a code root.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
id_integerRequired
Responses
200

Successful Response

application/json
get
/api/code_roots/{id_}/dependencies/graph

Get Code Root Dependency Graph To Package

get

Get the dependency graph for a code root going to a specific package.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
id_integerRequired
target_packagestringRequired
Query parameters
limitintegerOptionalDefault: 25
Responses
200

Successful Response

application/json
get
/api/code_roots/{id_}/dependencies/graph/{target_package}

Get Code Root Dependency Paths To Target

get

Get the dependency paths to a target package.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
id_integerRequired
target_packagestringRequired
Query parameters
limitintegerOptionalDefault: 25
Responses
200

Successful Response

application/json
get
/api/code_roots/{id_}/dependencies/paths/{target_package}

Get Dependency Versions By Code Root

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
code_root_idintegerRequired
dependency_namestringRequired
Query parameters
pageintegerOptionalDefault: 0
limitinteger · min: 1OptionalDefault: 100
orderany ofOptional
stringOptional
or
nullOptional
ordersany ofOptional
string[]Optional
or
nullOptional
directionany ofOptional
stringOptional
or
nullOptional
searchany ofOptional
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
get
/api/code_roots/{code_root_id}/dependencies/{dependency_name}/versions

Get Code Root Dependency Version

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
code_root_idintegerRequired
dependency_namestringRequired
versionstringRequired
Responses
200

Successful Response

application/json
get
/api/code_roots/{code_root_id}/dependencies/{dependency_name}/versions/{version}

Get Code Root Findings

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
code_root_idintegerRequired
Query parameters
pageintegerOptionalDefault: 0
limitinteger · min: 1OptionalDefault: 100
orderany ofOptional
stringOptional
or
nullOptional
ordersany ofOptional
string[]Optional
or
nullOptional
directionany ofOptional
stringOptional
or
nullOptional
searchany ofOptional
stringOptional
or
nullOptional
Bodyany of[]
or
or
Responses
200

Successful Response

application/json
post
/api/code_roots/{code_root_id}/findings

Get Code Root Dependency Version Findings

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
code_root_idintegerRequired
dependency_namestringRequired
versionstringRequired
Query parameters
pageintegerOptionalDefault: 0
limitinteger · min: 1OptionalDefault: 100
orderany ofOptional
stringOptional
or
nullOptional
ordersany ofOptional
string[]Optional
or
nullOptional
directionany ofOptional
stringOptional
or
nullOptional
searchany ofOptional
stringOptional
or
nullOptional
Bodyany of[]
or
or
Responses
200

Successful Response

application/json
post
/api/code_roots/{code_root_id}/dependencies/{dependency_name}/versions/{version}/findings

Get Code Root Contributors

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
code_root_idintegerRequired
Query parameters
pageintegerOptionalDefault: 0
limitinteger · min: 1OptionalDefault: 100
orderany ofOptional
stringOptional
or
nullOptional
ordersany ofOptional
string[]Optional
or
nullOptional
directionany ofOptional
stringOptional
or
nullOptional
searchany ofOptional
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
get
/api/code_roots/{code_root_id}/contributors

Get Code Root Apis

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
code_root_idintegerRequired
Query parameters
pageintegerOptionalDefault: 0
limitinteger · min: 1OptionalDefault: 100
orderany ofOptional
stringOptional
or
nullOptional
ordersany ofOptional
string[]Optional
or
nullOptional
directionany ofOptional
stringOptional
or
nullOptional
searchany ofOptional
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
get
/api/code_roots/{code_root_id}/apis

Get Code Root Remediations

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
code_root_idintegerRequired
Query parameters
pageintegerOptionalDefault: 0
limitinteger · min: 1OptionalDefault: 100
orderany ofOptional
stringOptional
or
nullOptional
ordersany ofOptional
string[]Optional
or
nullOptional
directionany ofOptional
stringOptional
or
nullOptional
searchany ofOptional
stringOptional
or
nullOptional
Bodyany of[]
or
or
Responses
200

Successful Response

application/json
post
/api/code_roots/{code_root_id}/remediations

Get Code Root Remediation Finding Counts

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
code_root_idany ofOptional
integerOptional
or
nullOptional
pageintegerOptionalDefault: 0
limitinteger · min: 1OptionalDefault: 100
orderany ofOptional
stringOptional
or
nullOptional
ordersany ofOptional
string[]Optional
or
nullOptional
directionany ofOptional
stringOptional
or
nullOptional
searchany ofOptional
stringOptional
or
nullOptional
Bodyany of[]
or
or
Responses
200

Successful Response

application/json
post
/api/code_roots/remediations/counts

Get All Code Root Remediations

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
pageintegerOptionalDefault: 0
limitinteger · min: 1OptionalDefault: 100
orderany ofOptional
stringOptional
or
nullOptional
ordersany ofOptional
string[]Optional
or
nullOptional
directionany ofOptional
stringOptional
or
nullOptional
searchany ofOptional
stringOptional
or
nullOptional
Bodyany of[]
or
or
Responses
200

Successful Response

application/json
post
/api/code_roots/remediations

Get Code Root Remediation Route

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
remediation_idintegerRequired
Responses
200

Successful Response

application/json
get
/api/code_roots/remediations/{remediation_id}

Create Ticket For Remediation

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
code_root_idintegerRequired
remediation_idintegerRequired
Body
or
Responses
200

Successful Response

application/json
post
/api/code_roots/{code_root_id}/remediations/{remediation_id}/tickets

Link Ticket To Remediation

put
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
code_root_idintegerRequired
remediation_idintegerRequired
Body
connection_typestringRequired
issue_idintegerRequired
finding_idany ofOptional
integerOptional
or
nullOptional
Responses
200

Successful Response

application/json
Responseany
put
/api/code_roots/{code_root_id}/remediations/{remediation_id}/tickets

No content

Delete Ticket From Remediation

delete
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
code_root_idintegerRequired
remediation_idintegerRequired
Responses
200

Successful Response

application/json
Responseany
delete
/api/code_roots/{code_root_id}/remediations/{remediation_id}/tickets

No content

Bulk Create Remediation Tickets

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
code_root_idintegerRequired
Body
remediation_idsinteger[]Required
Responses
200

Successful Response

application/json
post
/api/code_roots/{code_root_id}/remediations/create/bulk

Get Suggested Ticket Fields

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
code_root_idintegerRequired
remediation_idintegerRequired
Query parameters
connection_typeany ofOptional
stringOptional
or
nullOptional
bulk_suggestionsbooleanOptionalDefault: false
Responses
200

Successful Response

application/json
Responseany of
or
get
/api/code_roots/{code_root_id}/remediations/{remediation_id}/suggested_ticket_fields

Assign Remediation

put
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
code_root_idintegerRequired
remediation_idintegerRequired
Body
identity_idintegerRequired
Responses
200

Successful Response

application/json
Responseany
put
/api/code_roots/{code_root_id}/remediations/{remediation_id}/assignee

No content

Delete Remediation Assigne

delete
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
code_root_idintegerRequired
remediation_idintegerRequired
Responses
200

Successful Response

application/json
Responseany
delete
/api/code_roots/{code_root_id}/remediations/{remediation_id}/assignee

No content

Set Code Root Owners

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
code_root_idintegerRequired
owner_typestring · enumRequiredPossible values:
Body
Responses
200

Successful Response

application/json
post
/api/code_roots/{code_root_id}/owners/{owner_type}

Set Code Root Project

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
code_root_idintegerRequired
Body
project_idstringRequired
connection_idintegerRequired
Responses
200

Successful Response

application/json
Responseany
post
/api/code_roots/{code_root_id}/project

No content

Remove Code Root Project

delete
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
code_root_idintegerRequired
Responses
200

Successful Response

application/json
Responseany
delete
/api/code_roots/{code_root_id}/project

No content

Set Code Root Project Ticket Type

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
code_root_idintegerRequired
ticket_type_idstringRequired
Responses
200

Successful Response

application/json
Responseany
post
/api/code_roots/{code_root_id}/project/ticket_type/{ticket_type_id}

No content

Remove Code Root Project Ticket Type

delete
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
code_root_idintegerRequired
Responses
200

Successful Response

application/json
Responseany
delete
/api/code_roots/{code_root_id}/project/ticket_type

No content

Set Code Root Team

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
code_root_idintegerRequired
team_idstringRequired
Responses
200

Successful Response

application/json
Responseany
post
/api/code_roots/{code_root_id}/team/{team_id}

No content

Remove Code Root Team

delete
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
code_root_idintegerRequired
Responses
200

Successful Response

application/json
Responseany
delete
/api/code_roots/{code_root_id}/team

No content

Last updated

Was this helpful?