Code_roots

Get Code Root Finding

get

Authorizations

Path parameters

finding_idintegerRequired

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

get

HTTPcURLJavaScriptPython

GET /api/code_roots/findings/{finding_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": 1,
  "package_name": "text",
  "package_versions": [
    "text"
  ],
  "vulnerability": {
    "vuln_id": "text",
    "title": "text",
    "description": "text",
    "severity": "CRITICAL",
    "severity_source": "text",
    "found": "2025-06-27T13:23:05.117Z",
    "status": "text",
    "fix_versions": [
      "text"
    ],
    "package_version": "text",
    "references": [
      "text"
    ],
    "cwe_ids": [
      "text"
    ],
    "cvss_source": "text",
    "cvss_v3": {
      "attack_vector": "N",
      "attack_complexity": "L",
      "privileges_required": "N",
      "user_interaction": "N",
      "scope": "U",
      "confidentiality_impact": "N",
      "integrity_impact": "N",
      "availability_impact": "N",
      "exploit_code_maturity": "X",
      "remediation_level": "X",
      "report_confidence": "X",
      "base_score": 1,
      "base_severity": "CRITICAL",
      "base_vector": "text"
    },
    "cvss_v2": {
      "access_vector": "L",
      "access_complexity": "H",
      "authentication": "M",
      "confidentiality_impact": "N",
      "integrity_impact": "N",
      "availability_impact": "N",
      "base_score": 1,
      "base_vector": "text",
      "base_severity": "CRITICAL"
    },
    "published_date": "text",
    "last_modified_date": "text",
    "vulnerable_versions": [
      "text"
    ],
    "patched_versions": [
      "text"
    ],
    "unaffected_versions": [
      "text"
    ],
    "exploitation": {
      "epss_score": 1,
      "epss_percentile": 1,
      "exploited": true,
      "ransomware": true,
      "level": "LIKELY_NOT_EXPLOITED"
    }
  },
  "created": "2025-06-27T13:23:05.117Z",
  "updated": "2025-06-27T13:23:05.117Z",
  "assignee": {
    "id": 1,
    "name": "text",
    "email": "text",
    "alternate_emails": [
      "text"
    ],
    "is_hidden": true
  },
  "issues": [
    {
      "issue_id": 1,
      "name": "text",
      "status": "text",
      "status_category": "text",
      "issue_type": "text",
      "issue_type_icon_url": "text",
      "url": "text",
      "summary": "text",
      "remediation_id": 1
    }
  ],
  "code_root_id": 1,
  "remediation": {
    "id": 1,
    "package_name": "text",
    "package_manager": "default",
    "title": "text",
    "created": "2025-06-27T13:23:05.117Z",
    "solutions": [
      {
        "action": "text",
        "details": "text",
        "fixed_vulnerabilities": [
          "text"
        ],
        "fix_version_range": "text",
        "fix_version": "text",
        "complexity": "easy",
        "type": "specific_version"
      }
    ],
    "assignee": {
      "id": 1,
      "name": "text",
      "email": "text",
      "alternate_emails": [
        "text"
      ],
      "is_hidden": true
    },
    "suggested_assignees": [
      {
        "identity": {
          "id": 1,
          "name": "text",
          "email": "text",
          "alternate_emails": [
            "text"
          ],
          "is_hidden": true
        },
        "lines_of_code": 1,
        "last_commit_time": "2025-06-27T13:23:05.117Z"
      }
    ],
    "severity": "CRITICAL",
    "affected_versions": [
      "text"
    ],
    "ticket": {
      "issue_id": 1,
      "name": "text",
      "status": "text",
      "status_category": "text",
      "issue_type": "text",
      "issue_type_icon_url": "text",
      "url": "text",
      "summary": "text",
      "remediation_id": 1
    },
    "findings": [
      {
        "id": 1,
        "package_name": "text",
        "package_versions": [
          "text"
        ],
        "vulnerability": {
          "vuln_id": "text",
          "title": "text",
          "description": "text",
          "severity": "CRITICAL",
          "severity_source": "text",
          "found": "2025-06-27T13:23:05.117Z",
          "status": "text",
          "fix_versions": [
            "text"
          ],
          "package_version": "text",
          "references": [
            "text"
          ],
          "cwe_ids": [
            "text"
          ],
          "cvss_source": "text",
          "cvss_v3": {
            "attack_vector": "N",
            "attack_complexity": "L",
            "privileges_required": "N",
            "user_interaction": "N",
            "scope": "U",
            "confidentiality_impact": "N",
            "integrity_impact": "N",
            "availability_impact": "N",
            "exploit_code_maturity": "X",
            "remediation_level": "X",
            "report_confidence": "X",
            "base_score": 1,
            "base_severity": "CRITICAL",
            "base_vector": "text"
          },
          "cvss_v2": {
            "access_vector": "L",
            "access_complexity": "H",
            "authentication": "M",
            "confidentiality_impact": "N",
            "integrity_impact": "N",
            "availability_impact": "N",
            "base_score": 1,
            "base_vector": "text",
            "base_severity": "CRITICAL"
          },
          "published_date": "text",
          "last_modified_date": "text",
          "vulnerable_versions": [
            "text"
          ],
          "patched_versions": [
            "text"
          ],
          "unaffected_versions": [
            "text"
          ],
          "exploitation": {
            "epss_score": 1,
            "epss_percentile": 1,
            "exploited": true,
            "ransomware": true,
            "level": "LIKELY_NOT_EXPLOITED"
          }
        },
        "created": "2025-06-27T13:23:05.117Z",
        "updated": "2025-06-27T13:23:05.117Z",
        "assignee": {
          "id": 1,
          "name": "text",
          "email": "text",
          "alternate_emails": [
            "text"
          ],
          "is_hidden": true
        },
        "issues": [
          {
            "issue_id": 1,
            "name": "text",
            "status": "text",
            "status_category": "text",
            "issue_type": "text",
            "issue_type_icon_url": "text",
            "url": "text",
            "summary": "text",
            "remediation_id": 1
          }
        ],
        "code_root_id": 1,
        "remediation": "[Circular Reference]"
      }
    ],
    "num_findings": 1,
    "complexity": "easy"
  }
}

Get Code Root

get

Authorizations

Path parameters

idintegerRequired

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

get

HTTPcURLJavaScriptPython

GET /api/code_roots/{id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": 1,
  "repository_type": "GITHUB",
  "repository_id": "text",
  "path": "text",
  "created_at": "2025-06-27T13:23:05.117Z",
  "updated_at": "2025-06-27T13:23:05.117Z",
  "language": "text",
  "package_manager": "text",
  "technologies": [
    "text"
  ],
  "repository_name": "text"
}

Get Code Root Terms

get

Authorizations

Query parameters

categorystringOptionalDefault: code_roots

code_root_idany ofOptional

integerOptional

or

nullOptional

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

get

HTTPcURLJavaScriptPython

GET /api/code_roots/_terms HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "terms": [
    {
      "name": "text",
      "type": "Int",
      "terms": [
        {
          "lowerBound": 1,
          "upperBound": 1,
          "count": 1
        }
      ]
    }
  ]
}

Get Code Root License Terms

get

Authorizations

Path parameters

code_root_idintegerRequired

Query parameters

categorystringOptionalDefault: code_roots

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

get

HTTPcURLJavaScriptPython

GET /api/code_roots/{code_root_id}/license/_terms HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "terms": [
    {
      "name": "text",
      "type": "Int",
      "terms": [
        {
          "lowerBound": 1,
          "upperBound": 1,
          "count": 1
        }
      ]
    }
  ]
}

Get Code Root Dependencies

post

Authorizations

Path parameters

idintegerRequired

Query parameters

pageintegerOptionalDefault: 0

limitintegerOptionalDefault: 100

orderany ofOptional

stringOptional

or

nullOptional

directionany ofOptional

stringOptional

or

nullOptional

searchany ofOptional

stringOptional

or

nullOptional

Body

itemsany ofOptional

or

or

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

post

HTTPcURLJavaScriptPython

POST /api/code_roots/{id}/dependencies HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 58

[
  {
    "name": "text",
    "lt": 1,
    "lte": 1,
    "gt": 1,
    "gte": 1,
    "equals": 1
  }
]

{
  "items": [
    {
      "name": "text",
      "language": "PYTHON",
      "hygiene_score": {
        "overall": 1,
        "code": {
          "pinned_dependencies": 1,
          "code_review": 1,
          "branch_protection": 1,
          "binary_artifacts": 1
        },
        "build": {
          "packaging": 1,
          "token_permissions": 1,
          "signed_releases": 1,
          "dangerous_workflows": 1
        },
        "maintenance": {
          "maintained": 1,
          "cii_best_practices": 1,
          "license": 1,
          "security_policy": 1
        },
        "testing": {
          "fuzzing": 1,
          "sast": 1
        },
        "vulnerabilities": {
          "vulnerabilities": 1
        }
      },
      "first_introduced": "2025-06-27T13:23:05.117Z",
      "version": "text",
      "release_date": "2025-06-27T13:23:05.117Z",
      "finding_counts": {
        "total": 1,
        "critical": 1,
        "high": 1,
        "medium": 1,
        "low": 1
      },
      "license": "text"
    }
  ],
  "total": 1,
  "pages": 1,
  "page_size": 1,
  "page_number": 1
}

Get Code Root Dependency Graph

get

Get the dependency graph for a code root.

Authorizations

Path parameters

id_integerRequired

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

get

HTTPcURLJavaScriptPython

GET /api/code_roots/{id_}/dependencies/graph HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "nodes": [
    {
      "name": "text",
      "version": "text"
    }
  ],
  "edges": [
    {
      "source": 1,
      "target": 1,
      "requirement": "text"
    }
  ]
}

Get Dependency Versions By Code Root

get

Authorizations

Path parameters

code_root_idintegerRequired

dependency_namestringRequired

Query parameters

pageintegerOptionalDefault: 0

limitintegerOptionalDefault: 100

orderany ofOptional

stringOptional

or

nullOptional

directionany ofOptional

stringOptional

or

nullOptional

searchany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

get

HTTPcURLJavaScriptPython

GET /api/code_roots/{code_root_id}/dependencies/{dependency_name}/versions HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "name": "text",
      "language": "PYTHON",
      "hygiene_score": {
        "overall": 1,
        "code": {
          "pinned_dependencies": 1,
          "code_review": 1,
          "branch_protection": 1,
          "binary_artifacts": 1
        },
        "build": {
          "packaging": 1,
          "token_permissions": 1,
          "signed_releases": 1,
          "dangerous_workflows": 1
        },
        "maintenance": {
          "maintained": 1,
          "cii_best_practices": 1,
          "license": 1,
          "security_policy": 1
        },
        "testing": {
          "fuzzing": 1,
          "sast": 1
        },
        "vulnerabilities": {
          "vulnerabilities": 1
        }
      },
      "first_introduced": "2025-06-27T13:23:05.117Z",
      "version": "text",
      "release_date": "2025-06-27T13:23:05.117Z",
      "finding_counts": {
        "total": 1,
        "critical": 1,
        "high": 1,
        "medium": 1,
        "low": 1
      },
      "license": "text"
    }
  ],
  "total": 1,
  "pages": 1,
  "page_size": 1,
  "page_number": 1
}

Get Code Root Dependency Version

get

Authorizations

Path parameters

code_root_idintegerRequired

dependency_namestringRequired

versionstringRequired

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

get

HTTPcURLJavaScriptPython

GET /api/code_roots/{code_root_id}/dependencies/{dependency_name}/versions/{version} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "name": "text",
  "language": "PYTHON",
  "hygiene_score": {
    "overall": 1,
    "code": {
      "pinned_dependencies": 1,
      "code_review": 1,
      "branch_protection": 1,
      "binary_artifacts": 1
    },
    "build": {
      "packaging": 1,
      "token_permissions": 1,
      "signed_releases": 1,
      "dangerous_workflows": 1
    },
    "maintenance": {
      "maintained": 1,
      "cii_best_practices": 1,
      "license": 1,
      "security_policy": 1
    },
    "testing": {
      "fuzzing": 1,
      "sast": 1
    },
    "vulnerabilities": {
      "vulnerabilities": 1
    }
  },
  "first_introduced": "2025-06-27T13:23:05.117Z",
  "version": "text",
  "release_date": "2025-06-27T13:23:05.117Z",
  "dependency_commit_id": 1,
  "code_root_id": 1,
  "code_root_name": "text",
  "changeset_url": "text"
}

Get Code Root Findings

post

Authorizations

Path parameters

code_root_idintegerRequired

Query parameters

pageintegerOptionalDefault: 0

limitintegerOptionalDefault: 100

orderany ofOptional

stringOptional

or

nullOptional

directionany ofOptional

stringOptional

or

nullOptional

searchany ofOptional

stringOptional

or

nullOptional

Body

itemsany ofOptional

or

or

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

post

HTTPcURLJavaScriptPython

POST /api/code_roots/{code_root_id}/findings HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 58

[
  {
    "name": "text",
    "lt": 1,
    "lte": 1,
    "gt": 1,
    "gte": 1,
    "equals": 1
  }
]

{
  "items": [
    {
      "id": 1,
      "package_name": "text",
      "package_versions": [
        "text"
      ],
      "vulnerability": {
        "vuln_id": "text",
        "title": "text",
        "description": "text",
        "severity": "CRITICAL",
        "severity_source": "text",
        "found": "2025-06-27T13:23:05.117Z",
        "status": "text",
        "fix_versions": [
          "text"
        ],
        "package_version": "text",
        "references": [
          "text"
        ],
        "cwe_ids": [
          "text"
        ],
        "cvss_source": "text",
        "cvss_v3": {
          "attack_vector": "N",
          "attack_complexity": "L",
          "privileges_required": "N",
          "user_interaction": "N",
          "scope": "U",
          "confidentiality_impact": "N",
          "integrity_impact": "N",
          "availability_impact": "N",
          "exploit_code_maturity": "X",
          "remediation_level": "X",
          "report_confidence": "X",
          "base_score": 1,
          "base_severity": "CRITICAL",
          "base_vector": "text"
        },
        "cvss_v2": {
          "access_vector": "L",
          "access_complexity": "H",
          "authentication": "M",
          "confidentiality_impact": "N",
          "integrity_impact": "N",
          "availability_impact": "N",
          "base_score": 1,
          "base_vector": "text",
          "base_severity": "CRITICAL"
        },
        "published_date": "text",
        "last_modified_date": "text",
        "vulnerable_versions": [
          "text"
        ],
        "patched_versions": [
          "text"
        ],
        "unaffected_versions": [
          "text"
        ],
        "exploitation": {
          "epss_score": 1,
          "epss_percentile": 1,
          "exploited": true,
          "ransomware": true,
          "level": "LIKELY_NOT_EXPLOITED"
        }
      },
      "created": "2025-06-27T13:23:05.117Z",
      "updated": "2025-06-27T13:23:05.117Z",
      "assignee": {
        "id": 1,
        "name": "text",
        "email": "text",
        "alternate_emails": [
          "text"
        ],
        "is_hidden": true
      },
      "issues": [
        {
          "issue_id": 1,
          "name": "text",
          "status": "text",
          "status_category": "text",
          "issue_type": "text",
          "issue_type_icon_url": "text",
          "url": "text",
          "summary": "text",
          "remediation_id": 1
        }
      ],
      "code_root_id": 1,
      "remediation": {
        "id": 1,
        "package_name": "text",
        "package_manager": "default",
        "title": "text",
        "created": "2025-06-27T13:23:05.117Z",
        "solutions": [
          {
            "action": "text",
            "details": "text",
            "fixed_vulnerabilities": [
              "text"
            ],
            "fix_version_range": "text",
            "fix_version": "text",
            "complexity": "easy",
            "type": "specific_version"
          }
        ],
        "assignee": {
          "id": 1,
          "name": "text",
          "email": "text",
          "alternate_emails": [
            "text"
          ],
          "is_hidden": true
        },
        "suggested_assignees": [
          {
            "identity": {
              "id": 1,
              "name": "text",
              "email": "text",
              "alternate_emails": [
                "text"
              ],
              "is_hidden": true
            },
            "lines_of_code": 1,
            "last_commit_time": "2025-06-27T13:23:05.117Z"
          }
        ],
        "severity": "CRITICAL",
        "affected_versions": [
          "text"
        ],
        "ticket": {
          "issue_id": 1,
          "name": "text",
          "status": "text",
          "status_category": "text",
          "issue_type": "text",
          "issue_type_icon_url": "text",
          "url": "text",
          "summary": "text",
          "remediation_id": 1
        },
        "findings": [
          "[Circular Reference]"
        ],
        "num_findings": 1,
        "complexity": "easy"
      }
    }
  ],
  "total": 1,
  "pages": 1,
  "page_size": 1,
  "page_number": 1
}

Get Code Root Dependency Version Findings

post

Authorizations

Path parameters

code_root_idintegerRequired

dependency_namestringRequired

versionstringRequired

Query parameters

pageintegerOptionalDefault: 0

limitintegerOptionalDefault: 100

orderany ofOptional

stringOptional

or

nullOptional

directionany ofOptional

stringOptional

or

nullOptional

searchany ofOptional

stringOptional

or

nullOptional

Body

itemsany ofOptional

or

or

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

post

HTTPcURLJavaScriptPython

POST /api/code_roots/{code_root_id}/dependencies/{dependency_name}/versions/{version}/findings HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 58

[
  {
    "name": "text",
    "lt": 1,
    "lte": 1,
    "gt": 1,
    "gte": 1,
    "equals": 1
  }
]

{
  "items": [
    {
      "id": 1,
      "package_name": "text",
      "package_versions": [
        "text"
      ],
      "vulnerability": {
        "vuln_id": "text",
        "title": "text",
        "description": "text",
        "severity": "CRITICAL",
        "severity_source": "text",
        "found": "2025-06-27T13:23:05.117Z",
        "status": "text",
        "fix_versions": [
          "text"
        ],
        "package_version": "text",
        "references": [
          "text"
        ],
        "cwe_ids": [
          "text"
        ],
        "cvss_source": "text",
        "cvss_v3": {
          "attack_vector": "N",
          "attack_complexity": "L",
          "privileges_required": "N",
          "user_interaction": "N",
          "scope": "U",
          "confidentiality_impact": "N",
          "integrity_impact": "N",
          "availability_impact": "N",
          "exploit_code_maturity": "X",
          "remediation_level": "X",
          "report_confidence": "X",
          "base_score": 1,
          "base_severity": "CRITICAL",
          "base_vector": "text"
        },
        "cvss_v2": {
          "access_vector": "L",
          "access_complexity": "H",
          "authentication": "M",
          "confidentiality_impact": "N",
          "integrity_impact": "N",
          "availability_impact": "N",
          "base_score": 1,
          "base_vector": "text",
          "base_severity": "CRITICAL"
        },
        "published_date": "text",
        "last_modified_date": "text",
        "vulnerable_versions": [
          "text"
        ],
        "patched_versions": [
          "text"
        ],
        "unaffected_versions": [
          "text"
        ],
        "exploitation": {
          "epss_score": 1,
          "epss_percentile": 1,
          "exploited": true,
          "ransomware": true,
          "level": "LIKELY_NOT_EXPLOITED"
        }
      },
      "created": "2025-06-27T13:23:05.117Z",
      "updated": "2025-06-27T13:23:05.117Z",
      "assignee": {
        "id": 1,
        "name": "text",
        "email": "text",
        "alternate_emails": [
          "text"
        ],
        "is_hidden": true
      },
      "issues": [
        {
          "issue_id": 1,
          "name": "text",
          "status": "text",
          "status_category": "text",
          "issue_type": "text",
          "issue_type_icon_url": "text",
          "url": "text",
          "summary": "text",
          "remediation_id": 1
        }
      ],
      "code_root_id": 1,
      "remediation": {
        "id": 1,
        "package_name": "text",
        "package_manager": "default",
        "title": "text",
        "created": "2025-06-27T13:23:05.117Z",
        "solutions": [
          {
            "action": "text",
            "details": "text",
            "fixed_vulnerabilities": [
              "text"
            ],
            "fix_version_range": "text",
            "fix_version": "text",
            "complexity": "easy",
            "type": "specific_version"
          }
        ],
        "assignee": {
          "id": 1,
          "name": "text",
          "email": "text",
          "alternate_emails": [
            "text"
          ],
          "is_hidden": true
        },
        "suggested_assignees": [
          {
            "identity": {
              "id": 1,
              "name": "text",
              "email": "text",
              "alternate_emails": [
                "text"
              ],
              "is_hidden": true
            },
            "lines_of_code": 1,
            "last_commit_time": "2025-06-27T13:23:05.117Z"
          }
        ],
        "severity": "CRITICAL",
        "affected_versions": [
          "text"
        ],
        "ticket": {
          "issue_id": 1,
          "name": "text",
          "status": "text",
          "status_category": "text",
          "issue_type": "text",
          "issue_type_icon_url": "text",
          "url": "text",
          "summary": "text",
          "remediation_id": 1
        },
        "findings": [
          "[Circular Reference]"
        ],
        "num_findings": 1,
        "complexity": "easy"
      }
    }
  ],
  "total": 1,
  "pages": 1,
  "page_size": 1,
  "page_number": 1
}

Get Code Root Contributors

get

Authorizations

Path parameters

code_root_idintegerRequired

Query parameters

pageintegerOptionalDefault: 0

limitintegerOptionalDefault: 100

orderany ofOptional

stringOptional

or

nullOptional

directionany ofOptional

stringOptional

or

nullOptional

searchany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

get

HTTPcURLJavaScriptPython

GET /api/code_roots/{code_root_id}/contributors HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "name": "text",
      "email": "text",
      "lines_of_code": 1,
      "last_commit_time": "2025-06-27T13:23:05.117Z",
      "code_root_id": 1,
      "code_root_name": "text",
      "identity_id": 1
    }
  ],
  "total": 1,
  "pages": 1,
  "page_size": 1,
  "page_number": 1
}

Get Code Root Apis

get

Authorizations

Path parameters

code_root_idintegerRequired

Query parameters

pageintegerOptionalDefault: 0

limitintegerOptionalDefault: 100

orderany ofOptional

stringOptional

or

nullOptional

directionany ofOptional

stringOptional

or

nullOptional

searchany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

get

HTTPcURLJavaScriptPython

GET /api/code_roots/{code_root_id}/apis HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "code_root_id": 1,
      "method": "text",
      "path": "text",
      "file_path": "text",
      "line_number": 1,
      "line_number_url": "text",
      "created_at": "2025-06-27T13:23:05.117Z",
      "updated_at": "2025-06-27T13:23:05.117Z"
    }
  ],
  "total": 1,
  "pages": 1,
  "page_size": 1,
  "page_number": 1
}

Get Code Root Remediations

post

Authorizations

Path parameters

code_root_idintegerRequired

Query parameters

pageintegerOptionalDefault: 0

limitintegerOptionalDefault: 100

orderany ofOptional

stringOptional

or

nullOptional

directionany ofOptional

stringOptional

or

nullOptional

searchany ofOptional

stringOptional

or

nullOptional

Body

itemsany ofOptional

or

or

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

post

HTTPcURLJavaScriptPython

POST /api/code_roots/{code_root_id}/remediations HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 58

[
  {
    "name": "text",
    "lt": 1,
    "lte": 1,
    "gt": 1,
    "gte": 1,
    "equals": 1
  }
]

{
  "items": [
    {
      "id": 1,
      "package_name": "text",
      "package_manager": "default",
      "title": "text",
      "created": "2025-06-27T13:23:05.117Z",
      "solutions": [
        {
          "action": "text",
          "details": "text",
          "fixed_vulnerabilities": [
            "text"
          ],
          "fix_version_range": "text",
          "fix_version": "text",
          "complexity": "easy",
          "type": "specific_version"
        }
      ],
      "assignee": {
        "id": 1,
        "name": "text",
        "email": "text",
        "alternate_emails": [
          "text"
        ],
        "is_hidden": true
      },
      "suggested_assignees": [
        {
          "identity": {
            "id": 1,
            "name": "text",
            "email": "text",
            "alternate_emails": [
              "text"
            ],
            "is_hidden": true
          },
          "lines_of_code": 1,
          "last_commit_time": "2025-06-27T13:23:05.117Z"
        }
      ],
      "severity": "CRITICAL",
      "affected_versions": [
        "text"
      ],
      "ticket": {
        "issue_id": 1,
        "name": "text",
        "status": "text",
        "status_category": "text",
        "issue_type": "text",
        "issue_type_icon_url": "text",
        "url": "text",
        "summary": "text",
        "remediation_id": 1
      },
      "findings": [
        {
          "id": 1,
          "package_name": "text",
          "package_versions": [
            "text"
          ],
          "vulnerability": {
            "vuln_id": "text",
            "title": "text",
            "description": "text",
            "severity": "CRITICAL",
            "severity_source": "text",
            "found": "2025-06-27T13:23:05.117Z",
            "status": "text",
            "fix_versions": [
              "text"
            ],
            "package_version": "text",
            "references": [
              "text"
            ],
            "cwe_ids": [
              "text"
            ],
            "cvss_source": "text",
            "cvss_v3": {
              "attack_vector": "N",
              "attack_complexity": "L",
              "privileges_required": "N",
              "user_interaction": "N",
              "scope": "U",
              "confidentiality_impact": "N",
              "integrity_impact": "N",
              "availability_impact": "N",
              "exploit_code_maturity": "X",
              "remediation_level": "X",
              "report_confidence": "X",
              "base_score": 1,
              "base_severity": "CRITICAL",
              "base_vector": "text"
            },
            "cvss_v2": {
              "access_vector": "L",
              "access_complexity": "H",
              "authentication": "M",
              "confidentiality_impact": "N",
              "integrity_impact": "N",
              "availability_impact": "N",
              "base_score": 1,
              "base_vector": "text",
              "base_severity": "CRITICAL"
            },
            "published_date": "text",
            "last_modified_date": "text",
            "vulnerable_versions": [
              "text"
            ],
            "patched_versions": [
              "text"
            ],
            "unaffected_versions": [
              "text"
            ],
            "exploitation": {
              "epss_score": 1,
              "epss_percentile": 1,
              "exploited": true,
              "ransomware": true,
              "level": "LIKELY_NOT_EXPLOITED"
            }
          },
          "created": "2025-06-27T13:23:05.117Z",
          "updated": "2025-06-27T13:23:05.117Z",
          "assignee": {
            "id": 1,
            "name": "text",
            "email": "text",
            "alternate_emails": [
              "text"
            ],
            "is_hidden": true
          },
          "issues": [
            {
              "issue_id": 1,
              "name": "text",
              "status": "text",
              "status_category": "text",
              "issue_type": "text",
              "issue_type_icon_url": "text",
              "url": "text",
              "summary": "text",
              "remediation_id": 1
            }
          ],
          "code_root_id": 1,
          "remediation": "[Circular Reference]"
        }
      ],
      "num_findings": 1,
      "complexity": "easy"
    }
  ],
  "total": 1,
  "pages": 1,
  "page_size": 1,
  "page_number": 1
}

Get All Code Root Remediations

post

Authorizations

Query parameters

pageintegerOptionalDefault: 0

limitintegerOptionalDefault: 100

orderany ofOptional

stringOptional

or

nullOptional

directionany ofOptional

stringOptional

or

nullOptional

searchany ofOptional

stringOptional

or

nullOptional

Body

itemsany ofOptional

or

or

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

post

HTTPcURLJavaScriptPython

POST /api/code_roots/remediations HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 58

[
  {
    "name": "text",
    "lt": 1,
    "lte": 1,
    "gt": 1,
    "gte": 1,
    "equals": 1
  }
]

{
  "items": [
    {
      "id": 1,
      "package_name": "text",
      "package_manager": "default",
      "title": "text",
      "created": "2025-06-27T13:23:05.117Z",
      "solutions": [
        {
          "action": "text",
          "details": "text",
          "fixed_vulnerabilities": [
            "text"
          ],
          "fix_version_range": "text",
          "fix_version": "text",
          "complexity": "easy",
          "type": "specific_version"
        }
      ],
      "assignee": {
        "id": 1,
        "name": "text",
        "email": "text",
        "alternate_emails": [
          "text"
        ],
        "is_hidden": true
      },
      "suggested_assignees": [
        {
          "identity": {
            "id": 1,
            "name": "text",
            "email": "text",
            "alternate_emails": [
              "text"
            ],
            "is_hidden": true
          },
          "lines_of_code": 1,
          "last_commit_time": "2025-06-27T13:23:05.117Z"
        }
      ],
      "severity": "CRITICAL",
      "affected_versions": [
        "text"
      ],
      "ticket": {
        "issue_id": 1,
        "name": "text",
        "status": "text",
        "status_category": "text",
        "issue_type": "text",
        "issue_type_icon_url": "text",
        "url": "text",
        "summary": "text",
        "remediation_id": 1
      },
      "findings": [
        {
          "id": 1,
          "package_name": "text",
          "package_versions": [
            "text"
          ],
          "vulnerability": {
            "vuln_id": "text",
            "title": "text",
            "description": "text",
            "severity": "CRITICAL",
            "severity_source": "text",
            "found": "2025-06-27T13:23:05.117Z",
            "status": "text",
            "fix_versions": [
              "text"
            ],
            "package_version": "text",
            "references": [
              "text"
            ],
            "cwe_ids": [
              "text"
            ],
            "cvss_source": "text",
            "cvss_v3": {
              "attack_vector": "N",
              "attack_complexity": "L",
              "privileges_required": "N",
              "user_interaction": "N",
              "scope": "U",
              "confidentiality_impact": "N",
              "integrity_impact": "N",
              "availability_impact": "N",
              "exploit_code_maturity": "X",
              "remediation_level": "X",
              "report_confidence": "X",
              "base_score": 1,
              "base_severity": "CRITICAL",
              "base_vector": "text"
            },
            "cvss_v2": {
              "access_vector": "L",
              "access_complexity": "H",
              "authentication": "M",
              "confidentiality_impact": "N",
              "integrity_impact": "N",
              "availability_impact": "N",
              "base_score": 1,
              "base_vector": "text",
              "base_severity": "CRITICAL"
            },
            "published_date": "text",
            "last_modified_date": "text",
            "vulnerable_versions": [
              "text"
            ],
            "patched_versions": [
              "text"
            ],
            "unaffected_versions": [
              "text"
            ],
            "exploitation": {
              "epss_score": 1,
              "epss_percentile": 1,
              "exploited": true,
              "ransomware": true,
              "level": "LIKELY_NOT_EXPLOITED"
            }
          },
          "created": "2025-06-27T13:23:05.117Z",
          "updated": "2025-06-27T13:23:05.117Z",
          "assignee": {
            "id": 1,
            "name": "text",
            "email": "text",
            "alternate_emails": [
              "text"
            ],
            "is_hidden": true
          },
          "issues": [
            {
              "issue_id": 1,
              "name": "text",
              "status": "text",
              "status_category": "text",
              "issue_type": "text",
              "issue_type_icon_url": "text",
              "url": "text",
              "summary": "text",
              "remediation_id": 1
            }
          ],
          "code_root_id": 1,
          "remediation": "[Circular Reference]"
        }
      ],
      "num_findings": 1,
      "complexity": "easy",
      "repository_id": "text",
      "repository_name": "text",
      "code_root_id": 1,
      "code_root_path": "text",
      "code_root_file": "text"
    }
  ],
  "total": 1,
  "pages": 1,
  "page_size": 1,
  "page_number": 1
}

Get Code Root Remediation Route

get

Authorizations

Path parameters

remediation_idintegerRequired

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

get

HTTPcURLJavaScriptPython

GET /api/code_roots/remediations/{remediation_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": 1,
  "package_name": "text",
  "package_manager": "default",
  "title": "text",
  "created": "2025-06-27T13:23:05.117Z",
  "solutions": [
    {
      "action": "text",
      "details": "text",
      "fixed_vulnerabilities": [
        "text"
      ],
      "fix_version_range": "text",
      "fix_version": "text",
      "complexity": "easy",
      "type": "specific_version"
    }
  ],
  "assignee": {
    "id": 1,
    "name": "text",
    "email": "text",
    "alternate_emails": [
      "text"
    ],
    "is_hidden": true
  },
  "suggested_assignees": [
    {
      "identity": {
        "id": 1,
        "name": "text",
        "email": "text",
        "alternate_emails": [
          "text"
        ],
        "is_hidden": true
      },
      "lines_of_code": 1,
      "last_commit_time": "2025-06-27T13:23:05.117Z"
    }
  ],
  "severity": "CRITICAL",
  "affected_versions": [
    "text"
  ],
  "ticket": {
    "issue_id": 1,
    "name": "text",
    "status": "text",
    "status_category": "text",
    "issue_type": "text",
    "issue_type_icon_url": "text",
    "url": "text",
    "summary": "text",
    "remediation_id": 1
  },
  "findings": [
    {
      "id": 1,
      "package_name": "text",
      "package_versions": [
        "text"
      ],
      "vulnerability": {
        "vuln_id": "text",
        "title": "text",
        "description": "text",
        "severity": "CRITICAL",
        "severity_source": "text",
        "found": "2025-06-27T13:23:05.117Z",
        "status": "text",
        "fix_versions": [
          "text"
        ],
        "package_version": "text",
        "references": [
          "text"
        ],
        "cwe_ids": [
          "text"
        ],
        "cvss_source": "text",
        "cvss_v3": {
          "attack_vector": "N",
          "attack_complexity": "L",
          "privileges_required": "N",
          "user_interaction": "N",
          "scope": "U",
          "confidentiality_impact": "N",
          "integrity_impact": "N",
          "availability_impact": "N",
          "exploit_code_maturity": "X",
          "remediation_level": "X",
          "report_confidence": "X",
          "base_score": 1,
          "base_severity": "CRITICAL",
          "base_vector": "text"
        },
        "cvss_v2": {
          "access_vector": "L",
          "access_complexity": "H",
          "authentication": "M",
          "confidentiality_impact": "N",
          "integrity_impact": "N",
          "availability_impact": "N",
          "base_score": 1,
          "base_vector": "text",
          "base_severity": "CRITICAL"
        },
        "published_date": "text",
        "last_modified_date": "text",
        "vulnerable_versions": [
          "text"
        ],
        "patched_versions": [
          "text"
        ],
        "unaffected_versions": [
          "text"
        ],
        "exploitation": {
          "epss_score": 1,
          "epss_percentile": 1,
          "exploited": true,
          "ransomware": true,
          "level": "LIKELY_NOT_EXPLOITED"
        }
      },
      "created": "2025-06-27T13:23:05.117Z",
      "updated": "2025-06-27T13:23:05.117Z",
      "assignee": {
        "id": 1,
        "name": "text",
        "email": "text",
        "alternate_emails": [
          "text"
        ],
        "is_hidden": true
      },
      "issues": [
        {
          "issue_id": 1,
          "name": "text",
          "status": "text",
          "status_category": "text",
          "issue_type": "text",
          "issue_type_icon_url": "text",
          "url": "text",
          "summary": "text",
          "remediation_id": 1
        }
      ],
      "code_root_id": 1,
      "remediation": {
        "id": 1,
        "package_name": "text",
        "package_manager": "default",
        "title": "text",
        "created": "2025-06-27T13:23:05.117Z",
        "solutions": [
          {
            "action": "text",
            "details": "text",
            "fixed_vulnerabilities": [
              "text"
            ],
            "fix_version_range": "text",
            "fix_version": "text",
            "complexity": "easy",
            "type": "specific_version"
          }
        ],
        "assignee": {
          "id": 1,
          "name": "text",
          "email": "text",
          "alternate_emails": [
            "text"
          ],
          "is_hidden": true
        },
        "suggested_assignees": [
          {
            "identity": {
              "id": 1,
              "name": "text",
              "email": "text",
              "alternate_emails": [
                "text"
              ],
              "is_hidden": true
            },
            "lines_of_code": 1,
            "last_commit_time": "2025-06-27T13:23:05.117Z"
          }
        ],
        "severity": "CRITICAL",
        "affected_versions": [
          "text"
        ],
        "ticket": {
          "issue_id": 1,
          "name": "text",
          "status": "text",
          "status_category": "text",
          "issue_type": "text",
          "issue_type_icon_url": "text",
          "url": "text",
          "summary": "text",
          "remediation_id": 1
        },
        "findings": [
          "[Circular Reference]"
        ],
        "num_findings": 1,
        "complexity": "easy"
      }
    }
  ],
  "num_findings": 1,
  "complexity": "easy"
}

Create Ticket For Remediation

post

Authorizations

Path parameters

code_root_idintegerRequired

remediation_idintegerRequired

Body

connection_idintegerRequired

project_idstringRequired

issue_typestringRequired

labelsany ofOptional

string[]Optional

or

nullOptional

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

post

HTTPcURLJavaScriptPython

POST /api/code_roots/{code_root_id}/remediations/{remediation_id}/tickets HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 125

{
  "connection_id": 1,
  "project_id": "text",
  "issue_type": "text",
  "fields": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "labels": [
    "text"
  ]
}

{
  "issue_id": 1,
  "name": "text",
  "status": "text",
  "status_category": "text",
  "issue_type": "text",
  "issue_type_icon_url": "text",
  "url": "text",
  "summary": "text",
  "remediation_id": 1
}

Link Ticket To Remediation

put

Authorizations

Path parameters

code_root_idintegerRequired

remediation_idintegerRequired

Body

issue_idintegerRequired

finding_idany ofOptional

integerOptional

or

nullOptional

Responses

200

Successful Response

application/json

Responseany

404

Not found

422

Validation Error

application/json

put

HTTPcURLJavaScriptPython

PUT /api/code_roots/{code_root_id}/remediations/{remediation_id}/tickets HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 29

{
  "issue_id": 1,
  "finding_id": 1
}

No content

Delete Ticket From Remediation

delete

Authorizations

Path parameters

code_root_idintegerRequired

remediation_idintegerRequired

Responses

200

Successful Response

application/json

Responseany

404

Not found

422

Validation Error

application/json

delete

HTTPcURLJavaScriptPython

DELETE /api/code_roots/{code_root_id}/remediations/{remediation_id}/tickets HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Bulk Create Remediation Tickets

post

Authorizations

Path parameters

code_root_idintegerRequired

Body

remediation_idsinteger[]Required

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

post

HTTPcURLJavaScriptPython

POST /api/code_roots/{code_root_id}/remediations/create/bulk HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 23

{
  "remediation_ids": [
    1
  ]
}

{
  "connection_id": 1,
  "project_id": "text",
  "source": "text",
  "issue_type": "text",
  "reporter": "text",
  "assignee": "text",
  "team_id": "text",
  "fields": [
    {
      "id": "text",
      "name": "text",
      "type": "array",
      "allowed_values": [
        {
          "id": "text",
          "value": "text"
        }
      ],
      "use_autocomplete": false,
      "required": true,
      "multiline": false,
      "default_value": null
    }
  ],
  "suggestions": [
    {
      "remediation_id": 1,
      "fields": {
        "project": {
          "project_id": "text",
          "name": "text",
          "key": "text",
          "source": "text",
          "connection_id": 1
        },
        "team": {
          "team_id": "text",
          "name": "text",
          "source": "text"
        },
        "ticket_type": {
          "ticket_type_id": "text",
          "name": "text",
          "image_url": "text"
        },
        "summary": "text",
        "reporter": "text",
        "assignee": "text",
        "description": "text",
        "labels": [
          "text"
        ]
      }
    }
  ]
}

Get Suggested Ticket Fields

get

Authorizations

Path parameters

code_root_idintegerRequired

remediation_idintegerRequired

Query parameters

bulk_suggestionsbooleanOptionalDefault: false

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

get

HTTPcURLJavaScriptPython

GET /api/code_roots/{code_root_id}/remediations/{remediation_id}/suggested_ticket_fields HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "project": {
    "project_id": "text",
    "name": "text",
    "key": "text",
    "source": "text",
    "connection_id": 1
  },
  "team": {
    "team_id": "text",
    "name": "text",
    "source": "text"
  },
  "ticket_type": {
    "ticket_type_id": "text",
    "name": "text",
    "image_url": "text"
  },
  "summary": "text",
  "reporter": "text",
  "assignee": "text",
  "description": "text",
  "labels": [
    "text"
  ]
}

Assign Remediation

put

Authorizations

Path parameters

code_root_idintegerRequired

remediation_idintegerRequired

Body

identity_idintegerRequired

Responses

200

Successful Response

application/json

Responseany

404

Not found

422

Validation Error

application/json

put

HTTPcURLJavaScriptPython

PUT /api/code_roots/{code_root_id}/remediations/{remediation_id}/assignee HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "identity_id": 1
}

No content

Delete Remediation Assigne

delete

Authorizations

Path parameters

code_root_idintegerRequired

remediation_idintegerRequired

Responses

200

Successful Response

application/json

Responseany

404

Not found

422

Validation Error

application/json

delete

HTTPcURLJavaScriptPython

DELETE /api/code_roots/{code_root_id}/remediations/{remediation_id}/assignee HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Set Code Root Owners

post

Authorizations

Path parameters

code_root_idintegerRequired

owner_typestring · enumRequiredPossible values:

Body

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

post

HTTPcURLJavaScriptPython

POST /api/code_roots/{code_root_id}/owners/{owner_type} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "owners": [
    {
      "identity_id": 1
    }
  ]
}

{
  "ok": true,
  "message": "text"
}