/policy
Methods
Gets the list of Policies.
Fields Parameter
Request Parameters
Example Request Query Parameters
Filter Parameters
usable - The response will be an object containing an array of usable Policies. By default, both usable and manageable objects are returned.
manageable - The response will be an object containing all manageable Policies. By default, both usable and manageable objects are returned.
Example Response
Paginated response
Adds a Policy at the Admin or Organizational level.
NOTE #1: To specify a mixed Plugin Family, the plugins field must be present; otherwise, the family type defaults to enabled.
NOTE #2: When a policy is not context "" (empty), a new name will be generated. The 'name' parameter, if passed, will be overwritten.
Request Parameters
Example Response
/policy/{id}
/policy/{uuid}
Methods
Gets the Policy associated with {id} or {uuid}.
Fields Parameter
Request Parameters
None
Example Response
Edits the Policy associated with {id} or {uuid}, changing only the passed in fields.
NOTE #1: A policy's context may not be modified. When a policy is not context "" (empty), a new name will be generated. If the 'name' parameter is passed, it will be overwritten.
NOTE #2: In addition to the root object level (as usual), preferences and auth preference levels are defaulted. To maintain passwords on policy preferences, the policy preference object must contain the 'id' associated with that preference.
Request Parameters
All fields are optional
See /policy::POST for parameters.
Example Response
See /policy/{id}::GETDeletes the Policy associated with {id} or {uuid}, depending on access and permissions.
Request Parameters
Example Response
/policy/{id}/copy
/policy/{uuid}/copy
Copies the Policy associated with {id} or {uuid}, depending on access and permissions.
NOTE: The policy that is associated with {id} or {uuid} must contain context "" (empty).
Request Parameters
Example Response
/policy/{id}/export
/policy/{uuid}/export
Methods
Exports the Policy associated with {id} or {uuid}, depending on access and permissions.
Request Parameters
None
Example Response
None given. The response will be an xml file containing the Scan Policy.
/policy/{id}/share
/policy/{uuid}/share
Methods
Shares the Policy associated with {id} or {uuid}, depending on access and permissions
Request Parameters
Example Response
/policy/import
Methods
Request Parameters
Example Response
/policy/tag
Methods
Gets the full list of unique Policy tags
Note: Organization user responses will contain both organization and admin policy tags. Admin user responses will contain only admin policy tags.
Request Parameters
none