Create a traffic change request

The FireFlow REST API creates a Traffic Change Request.

FireFlow validates the API to ensure that mandatory elements are in place, such as permissions, template, date formats, that any specified device exists in AFA, and so on.

Note: For IPv6 addresses, you must use IPv6 format for both source and destination. For example: 2001:cdba::3257:9652 - 2001:cdba::3257:9657. See IPv6 traffic change workflow.

Notes: For IPv6 templates, only Cisco ASA devices are supported.

Resource Name: /FireFlow/api/change-requests/traffic

Request Method: POST

Header requirements:

Key Value
Cookie FireFlow_Session=[sessionID]. The sessionId is retrieved from the authentication request.

Request Body:

Element

Type

Description
trafficChangeRequestDetails

TrafficChangeRequest type

Object body containing details for creation of traffic change request.

Status codes:

Code

Description
200

Traffic Change Request was created

400

Input validation failure
403

Authentication failure
50x

Internal Server Error

Request example 

{
 "template": "Basic Change Traffic Request",
  "fields": [
  {
   "key": "subject",
   "values": [
    "Traffic_Ticket_Via_REST_API"
    ]
   },
   {
    "key": "Change Request Description",
    "values": [
     "add here the change request description"
    ]
   },
   {
    "name": "devices",
    "values": [
     "CKP1",
     "Cisco2"
    ]
   }
  ],
  "traffic": [{
   "source": {
    "items": [{
     "name": "1.1.1.0/24"
    },
    {
     "name": "host_object"
    }
   ]
  },
  "destination": {
   "items": [{
    "name": "2.2.2.2-2.2.2.150",
     "fields": [{
      "key": "CFPTI",
       "values": [
        "destination1"
       ]
     }]
   }]
  },
  "service": {
   "items": [{
    "name": "https"
    },
    {
     "name": "service_object"
     }
    ]
   },
   "user": {
    "items": [{
    "name": "user1"
   }]
  },
  "application": {
   "items": [{
   "name": "any"
   }]
  },
  "action": "Allow",
  "natDetails": {
   "source": ["9.9.9.9"],
   "destination": ["8.8.8.8"],
   "port": ["tcp/8080"],
   "type": "Static"
  },
  "fields": [{
   "key": "Requested Source Group Name",
   "values": [
   "sourceGroup100"
   ]
 }]
}]
}

IPv6 request example

Copy 
{
  "template":"170: Traffic Change Request (IPv6)",
  "fields":[
    {
      "name":"subject",
      "values":[
        "IPv6_demo_3"
      ]
    },
    {
      "name":"devices",
      "values":[
        "10_132_16_2"
      ]
    }
  ],
  "traffic":[
    {
      "source":{
        "items":[
          {
            "address":"fe80:2222::3333"
          }
        ]
      },
      "destination":{
        "items":[
          {
            "address":"2001:cdba::3257:9652 - 2001:cdba::3257:9657"
          }
        ]
      },
      "service":{
        "items":[
          {
            "name":"tcp/80-90"
 
          }
        ]
      },
      "action":"Allow"
    }
  ]
}

Response: Response type