Versions Compared

Old Version 6

changes.mady.by.user Daniel Colon

Saved on

compared with

New Version 7

changes.mady.by.user Andrew Swint

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

/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

Code Block
themeEclipse
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:

Code BlockthemeEclipse

the following call will be deleted

Code Block
{
    "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:

Code Block
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:

Code Block
{
    "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"
        }
    ]
}

Page Tree
rootCI/CD API