GRgrayswan

Export Policy By Id

Changed on

Export a single policy as JSON.

Returns the policy in a format suitable for import.

Docs: Guide | API Reference

Raises: ResourceNotFoundError: If the policy does not exist.

get/policies/{policy_id}/export

Request

Path parameters

policy_idstring required

Response

Successful Response

namestring required
descriptionstring nullable
categoriesobject
rule_modesobject
rule_block_messagesobject
modestring nullable
pre_violation_thresholdnumber nullable
pre_jb_thresholdnumber nullable
post_violation_thresholdnumber nullable
post_violation_jb_thresholdnumber nullable
scanners_configobject nullable
block_messagestring nullable
export_versionstring

Changes

  • ed4b27064dfaRevision changes
    • breaking

      the response's property type changed from array to string for status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      the response property became required for the status

    • info

      added the required property to the response with the status