Versions Compared

Key

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

/rest/{version}/cicd/passCriteriaGroup/create

Descriptor

Value

HTTP Method

POST

Description

Creates a new CI/CD 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

Name of pass criteria

.

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.

notAllowed

Boolean

No*

If no vulnerabilities allowed for the Pass Criteria (analogous to setting maxAllowed=0)

notIntroduced

Boolean

No*

If no new vulnerabilities allowed in a scan for the Pass Criteria (analogous to setting maxIntroduced=0)

* Either maxAllowed, maxIntroduced, notAllowed, or notIntroduced must be specified

Sample Call (setting max values):

Code Block
curl --insecure -H 'accept: application/json' -H "Authorization: APIKEY {apiKey}" -X POST --data 'name=Test&severity=HIGH&maxAllowed=5&maxIntroduced=5' http://localhost:8080/threadfix/rest/latest/cicd/passCriteriaGroup/create

Sample Call (setting boolean values):

Code Blockcurl --insecure -H 'accept: application/json' -H "Authorization: APIKEY {apiKey}" -X POST --data 'name=Test&severity=HIGH&notAllowed=true&notIntroduced=true' http://localhost:8080/threadfix/rest/latest/cicd/passCriteriaGroup/create

group.

Sample Output:

Code Block
{
    "message": "",
    "success": true,
    "responseCode": -1,
    "object": {
        "id": 3,
        "name": "example",
        "applications": [],
        "passCriteria": []
    },
    "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/3/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/3/update",
            "method": "PUT"
        },
        {
            "name": "delete",
            "href": "http://localhost:8080/threadfix/rest/latest/cicd/passCriteriaGroup/3/delete",
            "method": "DELETE"
        }
    ]
}

Page Tree
rootCI/CD 3.0 API