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.

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 7 Next »

/rest/{version}/cicd/passCriteriaGroup/{criteriaGroupId}/update

Descriptor

Value

HTTP Method

PUT

Description

Updates the specified CI/CD Pass Criteria Group.

Edits the Pass Criteria Group.

Required Permission

Manage CI/CD

Version Introduced

2.8.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

name

String

Yes

New name for the Pass Criteria Group.

severity

String

Yes

Name of severity.

maxAllowed

Integer

No*

The maximum number of vulnerabilities allowed for the Pass Criteria.  If no value is specified there is no limit.

maxIntroduced

Integer

No*

The maximum number of new vulnerabilities in a scan for the Pass Criteria.  If no value is specified there is no limit.

* Either maxAllowed or maxIntroduced must be specified

Sample Call:

the following call will be deleted

curl --insecure -H 'accept: application/json' -H "Authorization: APIKEY {apiKey}" -X PUT --data 'severity=CRITICAL&maxAllowed=10&maxIntroduced=10' http://localhost:8080/threadfix/rest/latest/cicd/passCriteriaGroup/1/update

Sample Output:

the following call will be deleted

{
    "message": "",
    "success": true,
    "responseCode": -1,
    "object": "Pass Criteria Group updated successfully",
    "links": [
        {
            "name": "list",
            "href": "http://localhost:8080/threadfix/rest/latest/cicd/passCriteriaGroup/",
            "method": "GET"
        },
        {
            "name": "detail",
            "href": "http://localhost:8080/threadfix/rest/latest/cicd/passCriteriaGroup/1/detail",
            "method": "GET"
        },
        {
            "name": "create",
            "href": "http://localhost:8080/threadfix/rest/latest/cicd/passCriteriaGroup/create",
            "method": "POST"
        },
        {
            "name": "update",
            "href": "http://localhost:8080/threadfix/rest/latest/cicd/passCriteriaGroup/1/update",
            "method": "PUT"
        },
        {
            "name": "delete",
            "href": "http://localhost:8080/threadfix/rest/latest/cicd/passCriteriaGroup/1/delete",
            "method": "DELETE"
        }
    ]
}

the above sample call and output replaced with below:

Sample Call:

curl --insecure -H 'accept: application/json' -H "Authorization: APIKEY {apiKey}" -X POST --data 'name=Edited' http://localhost:8080/threadfix/rest/latest/cicd/passCriteriaGroup/6/update

Sample Output:

{
    "message": "",
    "success": true,
    "responseCode": -1,
    "object": "Pass Criteria Group updated successfully",
    "links": [
        {
            "name": "list",
            "href": "http://localhost:8080/threadfix/rest/latest/cicd/passCriteriaGroup/",
            "method": "GET"
        },
        {
            "name": "detail",
            "href": "http://localhost:8080/threadfix/rest/latest/cicd/passCriteriaGroup/6/detail",
            "method": "GET"
        },
        {
            "name": "create",
            "href": "http://localhost:8080/threadfix/rest/latest/cicd/passCriteriaGroup/create",
            "method": "POST"
        },
        {
            "name": "update",
            "href": "http://localhost:8080/threadfix/rest/latest/cicd/passCriteriaGroup/6/update",
            "method": "PUT"
        },
        {
            "name": "delete",
            "href": "http://localhost:8080/threadfix/rest/latest/cicd/passCriteriaGroup/6/delete",
            "method": "DELETE"
        }
    ]
}

  • No labels