Versions Compared

Key

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

WAF API's have been deprecated as of ThreadFix version 2.8.

/rest/{version}/wafs

Descriptor

Value

HTTP Method

GET

Description

Retrieves all WAFs in system.

Required Permission

Manage WAFs

Version Introduced

2.3.0

Request Header Parameters

Parameter

Value

Required

Description

Accept

String

Yes

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

Sample Call:

Eclipse
Code Block
theme
curl --insecure -H 'Accept: application/json' -H "Authorization: APIKEY {apiKey}" http://localhost:8080/threadfix/rest/latest/wafs

Sample Output:

Eclipse
Code Block
theme
{
    "message": "",
    "success": true,
    "responseCode": -1,
    "object": [
        {
            "id": 2,
            "active": true,
            "name": "Example WAF",
            "wafType": {
                "id": 4,
                "name": "mod_security",
                "initialId": 100000
            },
            "currentId": 100000,
            "lastWafRuleDirective": null,
            "canDelete": true,
            "wafRules": [],
            "wafTypeName": "mod_security",
            "applications": []
        },
        {
            "id": 1,
            "active": true,
            "name": "New WAF",
            "wafType": {
                "id": 4,
                "name": "mod_security",
                "initialId": 100000
            },
            "currentId": 100001,
            "lastWafRuleDirective": {
                "id": 12
            },
            "canDelete": false,
            "wafRules": [
                {
                    "id": 1,
                    "active": true
                }
            ],
            "wafTypeName": "mod_security",
            "applications": [
                {
                    "id": 1,
                    "active": true,
                    "name": "Application",
                    "frameworkType": "DETECT",
                    "repositoryFolder": null,
                    "repositoryUrl": null,
                    "repositoryBranch": null,
                    "url": "http://www.example-url.com",
                    "uniqueId": null,
                    "applicationCriticality": {
                        "id": 2,
                        "name": "Medium"
                    },
                    "projectName": null,
                    "projectId": null,
                    "component": null,
                    "grcApplication": null,
                    "infoVulnCount": 0,
                    "lowVulnCount": 0,
                    "mediumVulnCount": 1,
                    "highVulnCount": 1,
                    "criticalVulnCount": 0,
                    "totalVulnCount": 2,
                    "skipApplicationMerge": false,
                    "team": {
                        "name": "Test Team",
                        "id": 1
                    },
                    "organization": {
                        "name": "Test Team",
                        "id": 1
                    },
                    "waf": {
                        "name": "New WAF",
                        "id": 1
                    }
                }
            ]
        }
    ]
}


Page Tree
rootWeb Application Firewalls (WAFs) API