Installing a policy from a Policy element
The
upload
verb is present on several Policy elements, such as
fw_policy
.
Example: The JSON description of a policy refers to the verb in this way:
"link":
[
{
"href": "http://localhost:8082/7.2.1/elements/fw_policy/56/upload",
"rel": "upload"
},
…
]
This verb can be found in each policy type.
Example: Here it is shown in the Engine Policy. It presents a query parameter — a filter that can be uploaded on a specific engine (?filter=TheEngineName
).
This verb starts the upload of the specific policy on the specified engine. It returns a 200 HTTP response status code and an upload status description similar to the following:
{
"follower": "http://localhost:8082/7.2.1/elements/fw_policy/56/upload/NWYyMDBiOTA4ZTY3NDM0ZTo0YzM2ZTg5MDoxM2ZlNzhhMDZlZTotN2VhZA==",
"href": "http://localhost:8082/7.2.1/elements/fw_policy/56",
"in_progress": true,
"last_message": "",
"success": true
}
The upload status has the following structure:
- follower: The API’s URI to the current upload status
- href: The source of the upload (in this example, the policy)
- in_progress: A flag that shows whether the upload is still in progress
- last_message: The last upload status message
- success: A flag that shows whether the current upload has succeeded