Deploying Configuration Changes

Deploying Configuration Changes

Although POST, PUT, and DELETE calls directly update the threat defense device, they are not immediately active. You must deploy configuration changes before the device uses your new settings when processing traffic.

Procedure

Step 1

Use the POST /operational/deploy resource in the Deployment group to initiate a deployment.

For example, the curl command would look like the following: 


curl -X POST --header 'Content-Type: application/json' 
--header 'Accept: application/json'
'https://ftd.example.com/api/fdm/latest/operational/deploy'

Step 2

Evaluate the response to verify that the deployment job was queued.

A good response (status code 200) looks like the following. Note the state. 


{
  "id": "62bf405f-796c-11e8-8640-a9156b92ec49",
  "statusMessage": null,
  "statusMessages": null,
  "modifiedObjects": {},
  "cliErrorMessage": null,
  "queuedTime": 1530036705491,
  "startTime": -1,
  "endTime": -1,
  "state": "QUEUED",
  "name": "User (admin) Triggered Deployment",
  "links": {
    "self": "https://ftd.example.com/api/fdm/latest/operational/deploy/
62bf405f-796c-11e8-8640-a9156b92ec49"
  }
}

Note

 

The cliErrorMessage and name attributes were added in API v2; they are not included in v1 responses.

Step 3

Use the GET /operational/deploy/{objId} resource to check the status of the job.

For example, the curl command would look like the following: 


curl -X GET --header 'Accept: application/json'
'https://ftd.example.com/api/fdm/latest/operational/deploy/
a7a227fb-82ab-11e7-8186-0dc471ff0672'

The response might look like the following. Note the state, DEPLOYED, indicates the job completed successfully. The modifiedObjects parameter lists the objects that were changed in the deployment job. In this case, there is a single change, to a network object named new-network. 


{
  "id": "62bf405f-796c-11e8-8640-a9156b92ec49",
  "statusMessage": "Deployed Successfully",
  "statusMessages": [
    "Deployed Successfully"
  ],
  "modifiedObjects": {
    "NetworkObject": [
      "new-network"
    ]
  },
  "cliErrorMessage": null,
  "queuedTime": 1530036705491,
  "startTime": 1530036705924,
  "endTime": 1530036822612,
  "state": "DEPLOYED",
  "name": "User (admin) Triggered Deployment",
  "links": {
    "self": "https://ftd.example.com/api/fdm/latest/operational/deploy/
62bf405f-796c-11e8-8640-a9156b92ec49"
  }
}