Match Firewall Change with Change Request

Match a firewall change with a change request.

Resource Name: /firewall-changes/{firewallChangeId}/match/{changeRequestId}

Request Method: PUT

Request parameters

Element

Type

Description

changeRequestId

mandatory

integer

The ID of the change request to match

firewallChangeId

mandatory

integer

The ID of the firewall change to match

matchFirewallChangeRequest

mandatory

object

The object containing details of the firewall change request

userNotes

mandatory

string Optional provide additional details about the matching.

Request example

{
    "userNotes": "This firewall change matches the change request"
}

Request cURL example

curl -X PUT "https://example.com/firewall-changes/123/match/456" -H "accept: application/json" -H "Content-Type: application/json" -d "{\"userNotes\":\"This firewall change matches the change request\"}"

Response parameters

Element

Type

Description
data string The data returned by the API
messages array of objects An array of messages objects
status string The status of the response (Success/Failure)
code string A code indicating the type of message
message string A human-readable message

 

Status codes:

Code

Description
200

Success

400

Input validation failure

Message Code Message text Parameters
FIREWALL_CHANGE_NOT_FOUND Firewall Change ID {0} not found 0 – firewall change id
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
CHANGE_REQUEST_NOT_FOUND Change request {0} not found 0 – change request id
MATCH_ALREADY_EXISTS Firewall Change ID {0} and change request {1} are already matched 0 – Firewall Change ID, 1 – change request 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 

"status": "Success",
  "messages": [],
  "data": "Firewall change 15 in device 10_20_124_2_Rihanna_1_vsys1_default for rule 20 is now matched to change request 11"
}

Response example for failure 400 

{
  "data": null,
  "messages": [
    {
      "code": "INVALID_INPUT",
      "message": "The provided input is invalid."
    }
  ],
  "status": "Failure"
}