policies

Patch Policy Route

Changed on
patch/api/v1/policies/{policy_id}

Request

  • Base URL
    https://cp.xenovia.io (the document declares no server; this is the origin it was published from)
  • URL
    https://cp.xenovia.io/api/v1/policies/{policy_id}
  • Auth
    none declared

Path parameters

policy_idstring uuid required

Headers

Authorizationstring nullable
X-Request-IDstring nullable

Request body

namestring nullable
categorystring nullable
summarystring nullable
regostring nullable
owner_idstring uuid nullable
stagestring nullable
enforcement_mode'monitor' | 'enforce' nullable
response_body_mode'none' | 'streamed' nullable

Response

Successful Response

idstring uuid required
agent_idstring uuid nullable required
org_idstring uuid required
owner_idstring uuid nullable required
namestring required
categorystring required
summarystring required
regostring required
enabledboolean required
stagestring required
enforcement_modestring
response_body_modestring
template_idstring nullable
template_versioninteger nullable
framework_tagsstring[] nullable
parameter_valuesobject nullable
versioninteger
baseline_targetobject nullable
created_atstring date-time required
updated_atstring date-time required
warningsstring[] required
groupstring required
template_controls_outdatedboolean required

Changes

  • 2f4b4b338b8fRevision changes
    • info

      added the new optional request property

    • 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

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

  • b20a3bdd6219Revision changes
    • breaking

      removed the required property from the response with the status

    • info

      added the required property to the response with the status