Update Policy State
Change policy state to control execution behavior (enable, disable, pause)
Endpoint
PATCH /api/private/lifecycle_management/policies/{policy_id}Description
Change the state of a policy to control its execution behavior. Policy states determine whether the policy actively processes events and executes actions. This endpoint provides a quick way to enable, disable, or pause policy execution without modifying the policy configuration.
Use this endpoint to:
Activate draft policies for production use
Temporarily disable policies during maintenance
Pause problematic policies for troubleshooting
Archive obsolete policies without deletion
API Reference
Bearer token authentication using a Veza Personal API key.
Header Format: Authorization: Bearer <your-api-key>
Creating an API Key:
- Log into your Veza tenant
- Navigate to Administration โ API Keys
- Generate a new API key and save the value securely
The main object for controlling the policy it includes descriptions Has multiple versions of it if, one of which is live and up to one of which is in draft mode, all others are historical
The version that is currently live and running
The version that is being edited and in draft form (0 if there is none)
The entity type to use for this policy (derived from the data sources passed in)
The source of identity data source(s) for this policy (must have one and must be of the same type)
List of the access profiles that are
List of the providers used by this policy (derived from the data sources passed in)
If true will only sync if the source of identity changes
If sync_only_when_source_changes is true, how quickly (in minutes) to run a check when no changes are detected (default is 1 day 1440)
if true will not retry failed workflows
how many times we will retry a failed workflow (default is 10)
OK
Default error response
Request Examples
Path Parameters
policy_id
string
Yes
Unique identifier of the policy to update
Request Body
state
string
Yes
New state for the policy: active, inactive, draft
reason
string
No
Optional reason for the state change (for audit trail)
Example Request
Response Examples
Policy States
draft
Policy is being developed or tested
Does not execute, can be freely modified
active
Policy is running in production
Actively processes events and executes actions
inactive
Policy is temporarily disabled
Does not execute, but configuration is preserved
Last updated
Was this helpful?
