Mark firewall changes as "No Match"

Marks a list of firewall changes as "No Match" based on the provided firewallChangeIDs.

Note: The API allows up to 1000 firewall change IDs per request.

Resource Name: /firewall-changes/mark-as-no-match

Request Method: PUT

JSON Body Request parameters

Element

Type

Description

markAsNoMatchRequest

mandatory

object The MarkAsNoMatchRequest object containing the request parameters.
comment String A comment explaining the reason for the no match.

firewallChangeIDs

mandatory

array of integers An array of integers representing the Firewall Change IDs to mark as no match.
summary String (Optional) A summary of the reason for the no match.

Request example

{
    "comment": "This firewall change is no longer needed",
    "firewallChangeIDs": [1, 2, 3],
    "summary": "Obsolete firewall changes"
}

Request cURL example

curl -X 'PUT' \
  'https://editor.swagger.io/FireFlow/api/firewall-changes/mark-as-no-match' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "comment": "what the heck",
  "firewallChangeIDs": [
    1,2,3
  ],
  "summary": "why not?"
}'

Response parameters

Element

Type

Description
firewallChangeIDs array of integers An array of Firewall Change IDs (that were successfully marked as “No Match”). Contained in a UpdateFirewallChangeResult object (schema)
messages array of objects An array of message objects providing additional information about the response. Each message object contains a code and message property. The code property indicates the type of message (e.g. error, warning, information), and the message property provides the actual message text.
code string A code indicating the type of message (e.g. "ERROR", "WARNING", "INFO").
message string The actual message text providing additional information about the response.
status string A string indicating the status of the response. Can be "Success", indicating that the API request was successful. "PartiallySuccess", indicating that some of the responses falied. "Failed" when all responses fail.

Status codes:

Code

Description
200

Success or partial success (when only a part of the firewall was successfully marked)

400

Input validation failure

Message Code Message text Parameters
INVALID_VALUE_FOR_FIELD {0} field contains invalid value(s): {1} 0 – the field name 1 – the value(s)
MAX_FIREWALL_CHANGE_IDS_EXCEEDED Number of Firewall Change IDs exceeds max limit: {0} 0 – the max limit, in this API, 1000
UNSUPPORTED_FIREWALL_CHANGE_OPERATION Cannot perform {0} operation for Firewall Change ID {1) with status {2} 0 – the action, in this API, "Mark as No Match" 1 - Firewall Change ID , 2– firewall change status
FIREWALL_CHANGE_NOT_FOUND Firewall Change ID {0} not found 0 – Firewall Change ID
403

Authentication failure

Message Code Message text Parameters
NO_PERMISSIONS There are no permissions to process the requested operation N/A
INVALID_SESSION_KEY The session key provided is invalid N/A
EXPIRED_SESSION_KEY The session key provided has expired N/A
BAD_COOKIE_HEADER Cookie header is missing or has non-expected value N/A
500

Failed to complete operation.

Message Code Message text Parameters
UNEXPECTED_ERROR_OCCURRED Unexpected error occurred N/A

Response example for success 200

{

"firewallChangeIds": [1, 2, 3]

}

Response example for PartiallySuccess 200 

{
  "status": "PartiallySuccess",
  "messages": [
    {
      "code": "FIREWALL_CHANGE_NOT_FOUND",
      "message": "Firewall Change ID 10000 not found"
    },
    {
      "code": "FIREWALL_CHANGE_NOT_FOUND",
      "message": "Firewall Change ID 200000 not found"
    },
    {
      "code": "UNSUPPORTED_FIREWALL_CHANGE_OPERATION",
      "message": "Cannot perform Mark as No Match operation for firewall changes with status no ticket"
    },
    {
      "code": "UNSUPPORTED_FIREWALL_CHANGE_OPERATION",
      "message": "Cannot perform Mark as No Match operation for firewall changes with status no ticket"
    }
  ],
  "data": {
    "firewallChangeIds": [
      3
    ]
  }
}

Response example for failure 400

{ "status": "Failure", "messages": [ { "code": "FIREWALL_CHANGE_NOT_FOUND", "message": "Firewall Change ID 10000 not found" }, { "code": "FIREWALL_CHANGE_NOT_FOUND", "message": "Firewall Change ID 200000 not found" }, { "code": "UNSUPPORTED_FIREWALL_CHANGE_OPERATION", "message": "Cannot perform Mark as No Match operation for firewall changes with status no ticket" }, { "code": "UNSUPPORTED_FIREWALL_CHANGE_OPERATION", "message": "Cannot perform Mark as No Match operation for firewall changes with status no ticket" } ], "data": null }