PEpermit
Policy Decision Points

Refresh data for all PDPs in the environment

Changed on

Triggers an out-of-band data refresh for all PDPs in the environment.

Publishes an OPAL data update instructing each PDP to immediately re-pull its full authorization data, instead of waiting for the next periodic poll. Use this to propagate external-data-source-backed changes in realtime.

shard_id is not accepted here: sharding is a per-PDP topology, so a single shard target is meaningless across a heterogeneous environment. Target a shard via the single-PDP endpoint (POST .../configs/{pdp_id}/refresh) instead.

post/v2/pdps/{proj_id}/{env_id}/configs/refresh

Request

  • Base URL
    https://api.permit.io (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Path parameters

proj_idstring required

Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").

env_idstring required

Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").

Request body

reasonstring

Optional human-readable reason for the refresh, propagated to the OPAL DataUpdate and visible in PDP/OPAL logs.

shard_idinteger

For sharded PDPs, target only this shard. When omitted, the refresh targets the PDP's main topic (all shards).

Response

Successful Response

update_idstring uuid required

The id of the generated OPAL DataUpdate. It is injected as the X-Permit-Update-Id header on every entry for correlation. When a refresh targets several PDPs, the OPAL relay may deliver it as one update per PDP, each with its own update id (in OPAL logs and the relay's tracked messages); the relay's 'multi-topic message detected' log line maps this id to the split count. Because the refresh is a full-data reload (dst_path=""), the PDP confirms it by advancing PDPInstance.current_data_date once the new bundle is fetched and saved (most_recent_data_fetch_id is only set for scoped/delta updates).

pdp_idsstring[] required

The ids of the PDP configurations that were targeted by this refresh.

Changes