As of December 31st, 2023 ThreadFix 2.X has reached End of Life and is no longer supported. For any further information please contact the Success and Implementation team.

Create CI/CD Defect Reporter - API

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


Descriptor

Value

HTTP Method

POST

Description

Creates a new CI/CD Defect Reporter.

Required Permission

Manage CI/CD

Version Introduced2.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

severityStringYesName 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"
        }
    ]
}

www.threadfix.it | www.coalfire.com
Copyright © 2024 Coalfire. All rights reserved.

This Information Security Policy is CoalFire - Public: Distribution of this material is not limited.