As we reach the end of September 2024, ThreadFix version 3.x on-premises has officially reached its End-of-Life. Therefore, there is no longer support or updates for this version of the product. We have fully transitioned our product and development teams to focus ThreadFix SaaS and migrating all customers over from the on-premises versions. Our Customer Success and Support teams are here to help you in migrating to ThreadFix SaaS and maximizing the value you see from this improved offering from Coalfire. This is the next phase of ThreadFix and our team is looking forward to continuing to support you on this journey.

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

/rest/{version}/cicd/defectReporting/create

Descriptor

Value

HTTP Method

POST

Description

Creates a new CI/CD Defect Reporter.

Required Permission

Manage CI/CD

Version Introduced

2.5.0

Request Header Parameters

Parameter

Value

Required

Description

Accept

String

Yes

A value of ‘application/json’ must be provided.

Request POST Data Parameters

Parameter

Value

Required

Description

Available Values

name

String

Yes

Name of CI/CD Defect Reporter.

N/A

severity

String

Yes

Name of severity level.

Defaults are:

  • Critical

  • High

  • Medium

  • Low

  • Info

minimum

Boolean

No

If true, includes all severities greater than the specified one as well. Default value is false.  (If an invalid value is provided, this will be set to false.)

N/A

groupBy

String

No

How to group vulnerabilities for defects.

  • None

  • CWE

  • Severity

  • CWE and Severity

  • CWEandSeverity

Sample Calls:

curl --insecure -H 'accept: application/json' -H "Authorization: APIKEY {apiKey}" -X POST --data 'name=My Defect Reporter&severity=HIGH&minimum=true&groupBy=CWE and Severity' http://localhost:8080/threadfix/rest/latest/cicd/defectReporting/create

Sample Output:

{
    "message": "",
    "success": true,
    "responseCode": -1,
    "object": "Defect Reporter created successfully",
    "links": [
        {
            "name": "list",
            "href": "http://localhost:8080/threadfix/rest/cicd/defectReporting/",
            "method": "GET"
        },
        {
            "name": "detail",
            "href": "http://localhost:8080/threadfix/rest/cicd/defectReporting/1/detail",
            "method": "GET"
        },
        {
            "name": "create",
            "href": "http://localhost:8080/threadfix/rest/cicd/defectReporting/create",
            "method": "POST"
        },
        {
            "name": "update",
            "href": "http://localhost:8080/threadfix/rest/cicd/defectReporting/1/update",
            "method": "PUT"
        },
        {
            "name": "delete",
            "href": "http://localhost:8080/threadfix/rest/cicd/defectReporting/1/delete",
            "method": "DELETE"
        }
    ]
}

The selected root page could not be found.

  • No labels